From 1cf9a740256ff80964d88120cf8dc1b2b8050aae Mon Sep 17 00:00:00 2001 From: Ali Mukadam Date: Wed, 4 Dec 2024 20:09:53 +1100 Subject: [PATCH] docs: updated docs, changed all references to OKE (#966) Signed-off-by: Ali --- README.md | 6 +-- docs/clusterautoscaler.adoc | 4 +- docs/src/gs/gs.md | 2 +- docs/src/gs/intro.md | 61 ++++++++--------------- docs/src/guide/identity_policies.md | 2 +- docs/src/guide/terraform.md | 2 +- docs/src/guide/workers_node_cycle.md | 8 +-- examples/rms/oke-workers-only/schema.yaml | 2 +- 8 files changed, 34 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index a6e0942d..ae11a102 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,14 @@ Documentation for this module is available at: - [Terraform OKE Module](https://oracle-terraform-modules.github.io/terraform-oci-oke/) -This project implements a reusable Terraform module for [Oracle Cloud Infrastructure (OCI)](https://cloud.oracle.com/cloud-infrastructure) to provision an [Oracle Container Engine for Kubernetes (OKE)](https://docs.cloud.oracle.com/iaas/Content/ContEng/Concepts/contengoverview.htm) cluster with supporting infrastructure. +This project implements a reusable Terraform module for [Oracle Cloud Infrastructure (OCI)](https://cloud.oracle.com/cloud-infrastructure) to provision an [OCI Kubernetes Engine (OKE)](https://docs.cloud.oracle.com/iaas/Content/ContEng/Concepts/contengoverview.htm) cluster with supporting infrastructure. ## Further Documentation - [Terraform OCI Provider](https://www.terraform.io/docs/providers/oci/index.html) - [Oracle Cloud Infrastructure](https://docs.cloud.oracle.com/iaas/Content/home.htm) -- [Oracle Container Engine](https://docs.cloud.oracle.com/iaas/Content/ContEng/Concepts/contengoverview.htm) +- [OCI Kubernetes Engine](https://docs.cloud.oracle.com/iaas/Content/ContEng/Concepts/contengoverview.htm) ## Acknowledgement @@ -24,4 +24,4 @@ Code derived and adapted from [Terraform OKE Sample](https://github.com/terrafor Learn how to [contribute](./CONTRIBUTING.md). ## License -Copyright (c) 2017, 2023 Oracle Corporation and/or its affiliates. Licensed under the [Universal Permissive License 1.0](./LICENSE) as shown at [https://oss.oracle.com/licenses/upl](https://oss.oracle.com/licenses/upl/). +Copyright (c) 2017, 2024 Oracle Corporation and/or its affiliates. Licensed under the [Universal Permissive License 1.0](./LICENSE) as shown at [https://oss.oracle.com/licenses/upl](https://oss.oracle.com/licenses/upl/). diff --git a/docs/clusterautoscaler.adoc b/docs/clusterautoscaler.adoc index a5c69f33..2766f3fb 100644 --- a/docs/clusterautoscaler.adoc +++ b/docs/clusterautoscaler.adoc @@ -1,4 +1,4 @@ -= Using the Oracle Container Engine for Kubernetes Cluster Autoscaler += Using the OKE Cluster Autoscaler :idprefix: :idseparator: - :sectlinks: @@ -23,7 +23,7 @@ :uri-upgrade-oke: https://docs.cloud.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengupgradingk8sworkernode.htm :uri-variables: {uri-rel-file-base}/variables.tf -This section documents how to deploy the Oracle Container Engine for Kubernetes (OKE) Cluster Autoscaler when using this project. At a high level, deploying the Kubernetes Cluster Autoscaler consists of 3 steps: +This section documents how to deploy the OCI Kubernetes Engine(OKE) Cluster Autoscaler when using this project. At a high level, deploying the Kubernetes Cluster Autoscaler consists of 3 steps: 1. Deploy an _unmanaged_ node pool i.e. a node pool that is not managed by the Kubernetes Cluster Autoscaler. We'll refer to this node pool as the _autoscaler_ node pool. 2. Create a dynamic group and policy to allow worker nodes to manage node pools. The dynamic group uses defined tags to add worker nodes from the autoscaler node pool to the managed node pools. diff --git a/docs/src/gs/gs.md b/docs/src/gs/gs.md index 0b084636..3560c0f3 100644 --- a/docs/src/gs/gs.md +++ b/docs/src/gs/gs.md @@ -170,7 +170,7 @@ kubectl is installed on the operator host by default and the kubeconfig file is **** The `instance principal` of the operator must be granted `MANAGE` on target cluster for configuration of an admin user context. * [Steps to Enable Instances to Call Services](https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm#setup) -* [Writing Policies for Container Engine for Kubernetes](https://docs.oracle.com/en-us/iaas/Content/Identity/Reference/contengpolicyreference.htm) +* [Writing Policies for OCI Kubernetes Engine](https://docs.oracle.com/en-us/iaas/Content/Identity/Reference/contengpolicyreference.htm) **** An alias "*k*" will be created for kubectl on the operator host. diff --git a/docs/src/gs/intro.md b/docs/src/gs/intro.md index 98c78563..baf272a8 100644 --- a/docs/src/gs/intro.md +++ b/docs/src/gs/intro.md @@ -7,7 +7,7 @@ [uri-terraform-oci-drg]: https://github.com/oracle-terraform-modules/terraform-oci-drg [uri-terraform-oci-oke]: https://github.com/oracle-terraform-modules/terraform-oci-oke [uri-terraform-options]: ./inputs_submodule.html#cluster -# Oracle Container Engine for Kubernetes (OKE) Terraform Module +# OCI Kubernetes Engine (OKE) Terraform Module ## Introduction @@ -24,45 +24,26 @@ The documentation here is still being reorganised. ## News *** -### May 20 2024: Announcing v5.1.7 -- fix symlinks issues and cluster autoscaler defaults override - -### May 18 2024: Announcing v5.1.6 -- fix: versions file in submodules - -### April 11 2024: Announcing v5.1.5 -- Create OKE VCN DRG attachment when existing DRG is specified -- fix FSS NSGs - -### March 28 2024: Announcing v5.1.4 -- add nodepool support for max_pods_per_node -- Add service account extension -- Improve logic for kube_config datasource -- fix: Remove unknown resource counts from derived inputs -- fix issue introduced by #909 with new clusters and #873 - -### March 4 2024: Announcing v5.1.3 -- Fix in NSG rule for health check (incorrect direction, or incorrect description?) -- feat: Configurable boot volume VPUs/GB on self-managed -- docs: example of using this module in multi-cluster mode with Istio -- Fix : Wrong control_plane_is_public behavior for OKE cluster -- Update drg module version. - -### February 6 2024: Announcing v5.1.2 -- Improve operator package installation - -### January 17 2024: Announcing v5.1.1 -- feat: upgraded default Autonomous Linux to 8.8 by -- fix: operator nsg is not created when cluster is disabled -- feat: added ability to create rpc to peer vcn to other vcns - -### November 29 2023: Announcing release v5.1.0 -- added Cilium CNI -- https://github.com/oracle-terraform-modules/terraform-oci-oke/releases/tag/v5.1.0 - -*** -### October 25 2023: Announcing release v5.0.0 -- https://github.com/oracle-terraform-modules/terraform-oci-oke/releases +### December 4, 2024: Announcing v5.2.2 +- feat: add support to reference module nsgs in the nsg rules + +### November 18, 2024: Announcing v5.2.1 +- fix: operator custom cloud-init error by @mcouto-sossego in #950 +- feat: added rules to allow UDP to be used for node port ranges by @robo-cap in #961 + +### November 7, 2024: Announcing v5.2.0 +- Add support for stateless rules +- Fix KMS policy - cluster dependency +- Add cluster addon support +- Allow cloud-init update for nodepools +- Add several improvements and fixes +- Cilium extension upgrade to 1.16 +- Fix pod nsg bug + +### July 9, 2024: Announcing v5.1.8 +- allow user to add additional rules to the workers NSG +- docs: updated main page, mdbook component versions +- Add support to ignore_initial_pool_size attribute on nodepools