docs: updated docs, changed all references to OKE (#966)

hyder · web-flow · commit 1cf9a740256f · 2024-12-04T11:09:53.000+02:00
Signed-off-by: Ali &lt;ali.mukadam@oracle.com&gt;
diff --git 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
@@ -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
@@ -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
@@ -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
 
 <!-- ***
 ### August 24 2023: Announcing release v5.0.0-RC5
diff --git a/docs/src/guide/identity_policies.md b/docs/src/guide/identity_policies.md
@@ -11,5 +11,5 @@
 * [Managing Dynamic Groups](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingdynamicgroups.htm)
 * [Managing Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingpolicies.htm)
 * [Policy Configuration for Cluster Creation and Deployment](https://docs.oracle.com/en-us/iaas/Content/ContEng/Concepts/contengpolicyconfig.htm)
-* [About Access Control and Container Engine for Kubernetes](https://docs.oracle.com/en-us/iaas/Content/ContEng/Concepts/contengaboutaccesscontrol.htm)
+* [About Access Control and OCI Kubernetes Engine](https://docs.oracle.com/en-us/iaas/Content/ContEng/Concepts/contengaboutaccesscontrol.htm)
 * [KMS](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm)
diff --git a/docs/src/guide/terraform.md b/docs/src/guide/terraform.md
@@ -28,7 +28,7 @@ kubectl installed on the operator host by default and the kubeconfig file is set
 ****
 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/guide/workers_node_cycle.md b/docs/src/guide/workers_node_cycle.md
@@ -3,7 +3,7 @@
 
 Cycling nodes simplifies both the upgrading of the Kubernetes and host OS versions running on the managed worker nodes, and the updating of other worker node properties.
 
-When you set `node_cycling_enabled` to `true` for a node pool, Container Engine for Kubernetes will compare the properties of the existing nodes in the node pool with the properties of the node_pool. If any of the following attributes is not aligned, the node is marked for replacement:
+When you set `node_cycling_enabled` to `true` for a node pool, OKE will compare the properties of the existing nodes in the node pool with the properties of the node_pool. If any of the following attributes is not aligned, the node is marked for replacement:
   - `kubernetes_version`
   - `node_labels`
   - `compute_shape` (`shape`, `ocpus`, `memory`)
@@ -16,9 +16,9 @@ When you set `node_cycling_enabled` to `true` for a node pool, Container Engine
   - `volume_kms_key_id`
   - `pv_transit_encryption`
 
-The `node_cycling_max_surge` (default: `1`) and `node_cycling_max_unavailable` (default: `0`) node_pool attributes can be configured with absolute values or percentage values, calculated relative to the node_pool `size`. These attributes determine how the Container Engine for Kubernetes will replace the nodes with a stale config in the node_pool.
+The `node_cycling_max_surge` (default: `1`) and `node_cycling_max_unavailable` (default: `0`) node_pool attributes can be configured with absolute values or percentage values, calculated relative to the node_pool `size`. These attributes determine how OKE will replace the nodes with a stale config in the node_pool.
 
-When cycling nodes, the Container Engine for Kubernetes cordons, drains, and terminates nodes according to the node pool's cordon and drain options.
+When cycling nodes, the OKE cordons, drains, and terminates nodes according to the node pool's cordon and drain options.
 
 **Notes:**
 - It's strongly recommended to use [readiness probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-readiness-probes) and [PodDisruptionBudgets](https://kubernetes.io/docs/tasks/run-application/configure-pdb/) to reduce the impact of the node replacement operation.
@@ -40,4 +40,4 @@ When cycling nodes, the Container Engine for Kubernetes cordons, drains, and ter
 ## References
 * [oci_containerengine_node_pool](https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/containerengine_node_pool)
 * [Performing an In-Place Worker Node Update by Cycling Nodes in an Existing Node Pool](https://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contengupgradingimageworkernode_topic-Performing_an_InPlace_Worker_Node_Update_By_Cycling_an_Existing_Node_Pool.htm)
-* [Introducing On Demand Node Cycling for Oracle Container Engine for Kubernetes](https://blogs.oracle.com/cloud-infrastructure/post/node-cycling-container-engine-kubernetes-oke)
+* [Introducing On Demand Node Cycling for OCI Kubernetes Engine](https://blogs.oracle.com/cloud-infrastructure/post/node-cycling-container-engine-kubernetes-oke)
diff --git a/examples/rms/oke-workers-only/schema.yaml b/examples/rms/oke-workers-only/schema.yaml
@@ -113,7 +113,7 @@ variables:
   create_iam_worker_policy:
     title: Authorize instance(s) to join the target cluster
     description: |
-      Create the required Identity policy with a dynamic group to authorize self-managed worker node membership for an OKE cluster, e.g. `Allow dynamic-group ... to {CLUSTER_JOIN} in compartment id ... where { target.cluster.id = '...' }`. See <a href=https://docs.oracle.com/en-us/iaas/Content/Identity/policyreference/contengpolicyreference.htm#Details_for_Container_Engine_for_Kubernetes>Container Engine for Kubernetes Self-managed nodes</a> for more information.
+      Create the required Identity policy with a dynamic group to authorize self-managed worker node membership for an OKE cluster, e.g. `Allow dynamic-group ... to {CLUSTER_JOIN} in compartment id ... where { target.cluster.id = '...' }`. See <a href=https://docs.oracle.com/en-us/iaas/Content/Identity/policyreference/contengpolicyreference.htm#Details_for_Container_Engine_for_Kubernetes>OKE Self-managed nodes</a> for more information.
     type: boolean
     default: false
     required: true
