docs: updated main page, mdbook component versions

Signed-off-by: Ali Mukadam <ali.mukadam@oracle.com>
oracle-terraform-modules · Jul 4, 2024 · 3215d9d · 3215d9d
1 parent 1c32999
commit 3215d9d
Show file tree

Hide file tree

Showing 4 changed files with 168 additions and 9 deletions.
diff --git a/.github/workflows/mdbook.yaml b/.github/workflows/mdbook.yaml
@@ -32,7 +32,8 @@ jobs:
         name: Install mdbook
         env:
           CARGO_HOME: ./cargo
-        run: cargo install --locked --force mdbook@0.4.34 mdbook-admonish@1.10.2 mdbook-variables@0.2.2 mdbook-toc@0.14.1 mdbook-pagetoc@0.1.7
+        # run: cargo install --locked --force mdbook@0.4.34 mdbook-admonish@1.10.2 mdbook-variables@0.2.2 mdbook-toc@0.14.1 mdbook-pagetoc@0.1.7
+        run: cargo install --locked --force mdbook@0.4.34 mdbook-admonish@1.17.1 mdbook-variables@0.2.4 mdbook-toc@0.14.2 mdbook-pagetoc@0.2.0
 
   install-tfdocs:
     environment:

diff --git a/docs/book.toml b/docs/book.toml
@@ -17,7 +17,7 @@ editable = true
 
 [preprocessor.admonish]
 command = "mdbook-admonish"
-assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install`
+assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install`
 
 [preprocessor.toc]
 max-level = 3

diff --git a/docs/src/gs/gs.md b/docs/src/gs/gs.md
@@ -15,30 +15,151 @@ The documentation here is for 5.x **only**. The documentation for earlier versio
 
 ### Clone the repo
 
-Clone the git repo and checkout the 5.x branch:
+Clone the git repo:
 
 ```
 git clone https://github.com/oracle-terraform-modules/terraform-oci-oke.git tfoke
 cd tfoke
-git checkout 5.x
 ```
 
 ### Create
 
-Initialize a working directory containing Terraform configuration files, and optionally upgrade module dependencies:
+1. Create 2 OCI providers and add them to providers.tf:
+
+```
+provider "oci" {
+  fingerprint      = var.api_fingerprint
+  private_key_path = var.api_private_key_path
+  region           = var.region
+  tenancy_ocid     = var.tenancy_id
+  user_ocid        = var.user_id
+}
+
+provider "oci" {
+  fingerprint      = var.api_fingerprint
+  private_key_path = var.api_private_key_path
+  region           = var.home_region
+  tenancy_ocid     = var.tenancy_id
+  user_ocid        = var.user_id
+  alias            = "home"
+}
+```
+
+2. Initialize a working directory containing Terraform configuration files, and optionally upgrade module dependencies:
 ```
 terraform init --upgrade
 ```
 
-Run the plan and apply commands to create OKE cluster and other components:
+3. Create a terraform.tfvars and provide the necessary parameters:
+
+```
+# Identity and access parameters
+api_fingerprint      = "00:ab:12:34:56:cd:78:90:12:34:e5:fa:67:89:0b:1c"
+api_private_key_path = "~/.oci/oci_rsa.pem"
+
+home_region = "us-ashburn-1"
+region      = "ap-sydney-1"
+tenancy_id  = "ocid1.tenancy.oc1.."
+user_id     = "ocid1.user.oc1.."
+
+# general oci parameters
+compartment_id = "ocid1.compartment.oc1.."
+timezone       = "Australia/Sydney"
+
+# ssh keys
+ssh_private_key_path = "~/.ssh/id_ed25519"
+ssh_public_key_path  = "~/.ssh/id_ed25519.pub"
+
+# networking
+create_vcn               = true
+assign_dns               = true
+lockdown_default_seclist = true
+vcn_cidrs                = ["10.0.0.0/16"]
+vcn_dns_label            = "oke"
+vcn_name                 = "oke"
+
+# Subnets
+subnets = {
+  bastion  = { newbits = 13, netnum = 0, dns_label = "bastion", create="always" }
+  operator = { newbits = 13, netnum = 1, dns_label = "operator", create="always" }
+  cp       = { newbits = 13, netnum = 2, dns_label = "cp", create="always" }
+  int_lb   = { newbits = 11, netnum = 16, dns_label = "ilb", create="always" }
+  pub_lb   = { newbits = 11, netnum = 17, dns_label = "plb", create="always" }
+  workers  = { newbits = 2, netnum = 1, dns_label = "workers", create="always" }
+  pods     = { newbits = 2, netnum = 2, dns_label = "pods", create="always" }
+}
+
+# bastion
+create_bastion           = true
+bastion_allowed_cidrs    = ["0.0.0.0/0"]
+bastion_user             = "opc"
+
+# operator
+create_operator                = true
+operator_install_k9s           = true
+
+
+# iam
+create_iam_operator_policy   = "always"
+create_iam_resources         = true
+
+create_iam_tag_namespace = false // true/*false
+create_iam_defined_tags  = false // true/*false
+tag_namespace            = "oke"
+use_defined_tags         = false // true/*false
+
+# cluster
+create_cluster     = true
+cluster_name       = "oke"
+cni_type           = "flannel"
+kubernetes_version = "v1.29.1"
+pods_cidr          = "10.244.0.0/16"
+services_cidr      = "10.96.0.0/16"
+
+# Worker pool defaults
+worker_pool_size = 0
+worker_pool_mode = "node-pool"
+
+# Worker defaults
+await_node_readiness     = "none"
+
+worker_pools = {
+  np1 = {
+    shape              = "VM.Standard.E4.Flex",
+    ocpus              = 2,
+    memory             = 32,
+    size               = 1,
+    boot_volume_size   = 50,
+    kubernetes_version = "v1.29.1"
+  }
+  np2 = {
+     shape            = "VM.Standard.E4.Flex",
+     ocpus            = 2,
+     memory           = 32,
+     size             = 3,
+     boot_volume_size = 150,
+     kubernetes_version = "v1.29.1"
+  }
+}
+
+# Security
+allow_node_port_access       = false
+allow_worker_internet_access = true
+allow_worker_ssh_access      = true
+control_plane_allowed_cidrs  = ["0.0.0.0/0"]
+control_plane_is_public      = false
+load_balancers               = "both"
+preferred_load_balancer      = "public"
+
+```
+
+4. Run the plan and apply commands to create OKE cluster and other components:
 ```
 terraform plan
 terraform apply
 ```
 
-You can create a Kubernetes cluster with the latest version of Kubernetes available in OKE using this terraform script. By default the `kubernetes_version` parameter in terraform.tfvars.example is set as "LATEST". Refer to [Terraform Options][uri-terraform-options] for other available parameters for OKE.
-
-Use the parameter *cluster_name* to change the name of the cluster as needed.
+You can create a Kubernetes cluster with the latest version of Kubernetes available in OKE using this terraform script.
 
 ### Connect
 

diff --git a/docs/src/gs/intro.md b/docs/src/gs/intro.md
@@ -23,6 +23,43 @@ 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