Merge pull request #2390 from oracle-devrel/oke-packer

oke-node-packer solution implementation

Author: martatolosa

app-dev/devops-and-containers/oke/oke-node-packer/README.md

@@ -0,0 +1,58 @@
+# OKE Custom Node Image Builder
+
+This project uses Packer to create custom images for Oracle Kubernetes Engine (OKE) nodes based on Oracle-provided base images. The customizations include:
+1. Updating all packages to their latest versions.
+2. Installing `oci-fss-utils` for in-transit encryption support.
+3. Upgrading to cgroups v2.
+
+## Prerequisites
+- Packer installed (version compatible with the oracle plugin ~>1).
+- Oracle Cloud Infrastructure (OCI) CLI configured with necessary credentials.
+- Access to an OCI compartment, subnet, and a base OKE node image OCID.
+- Only Oracle Linux 8 base images are supported for this Packer build.
+- If you're not an administrator, ensure your user group (e.g., PackerGroup) has the following OCI IAM policies:
+  ```
+  Allow group PackerGroup to manage instance-family in compartment ${COMPARTMENT_NAME}
+  Allow group PackerGroup to manage instance-images in compartment ${COMPARTMENT_NAME}
+  Allow group PackerGroup to use virtual-network-family in compartment ${COMPARTMENT_NAME}
+  Allow group PackerGroup to manage compute-image-capability-schema in tenancy
+  ```
+  Replace `PackerGroup` with your actual group name and `${COMPARTMENT_NAME}` with your compartment name.
+
+## Setup
+1. Clone this repository or copy the files to your local machine.
+2. Edit `vars.pkrvars.hcl` to provide your specific OCI details (see below for placeholders).
+
+### Configuring vars.pkrvars.hcl
+Update the file with your values:
+- `availability_domain`: Your OCI availability domain (e.g., "XXXX:REGION-AD-1").
+- `base_image_ocid`: OCID of the Oracle-provided OKE base image. To find the latest base image OCID, refer to the [Oracle Linux 8 OKE Worker Node Images documentation](https://docs.oracle.com/en-us/iaas/images/oke-worker-node-oracle-linux-8x/index.htm).
+- `compartment_ocid`: OCID of your OCI compartment.
+- `image_prefix`: Prefix for the generated image name (default: "oke-custom-image").
+- `shape`: VM shape (e.g., "VM.Standard.E4.Flex").
+- `ocpus`: Number of OCPUs (default: 1).
+- `memory_in_gbs`: Memory in GB (default: 8).
+- `subnet_ocid`: OCID of the subnet for the build instance.
+- `region`: OCI region (e.g., "eu-frankfurt-1").
+- `skip_create_image`: Set to true to skip image creation (default: false).
+
+## Usage
+1. Ensure you're in the project directory.
+2. Run the build script:
+   ```
+   ./run-packer.sh
+   ```
+3. Packer will provision a temporary instance, apply customizations, and create the custom image in your compartment.
+
+## Files Overview
+- `oke-custom-image.pkr.hcl`: Main Packer configuration.
+- `variables.pkr.hcl`: Variable definitions.
+- `vars.pkrvars.hcl`: User-configurable variables.
+- `run-packer.sh`: Script to execute the Packer build.
+
+## Troubleshooting
+- If the build fails, check OCI permissions and network access.
+- Use the `-debug` flag in run-packer.sh for detailed logs.
+- Base images are constantly updated by Oracle, ensure you use the latest OCID.
+
+For more details on Packer and OCI integration, refer to the [Packer OCI Plugin documentation](https://developer.hashicorp.com/packer/integrations/hashicorp/oracle/latest/components/builder/oci).

app-dev/devops-and-containers/oke/oke-node-packer/oke-custom-image.pkr.hcl

@@ -0,0 +1,56 @@
+packer {
+  required_plugins {
+    oracle = {
+      version = "~> 1"
+      source  = "github.com/hashicorp/oracle"
+    }
+  }
+}
+
+
+# Packer configuration for building OKE custom image
+
+source "oracle-oci" "oke_builder" {
+  availability_domain = var.availability_domain
+  base_image_ocid     = var.base_image_ocid
+  compartment_ocid    = var.compartment_ocid
+  image_name          = "${var.image_prefix}${formatdate("YYYY-MM-DD-hh-mm-ss", timestamp())}"
+  shape               = var.shape
+
+  shape_config {
+    ocpus         = var.ocpus
+    memory_in_gbs = var.memory_in_gbs
+  }
+  subnet_ocid  = var.subnet_ocid
+  ssh_username = var.ssh_username
+  region       = var.region
+
+  skip_create_image = var.skip_create_image
+}
+
+build {
+  sources = ["source.oracle-oci.oke_builder"]
+
+  provisioner "shell" {
+    inline = [
+      "sudo yum-config-manager --enable ol8_developer",
+      "sudo dnf update -y",
+      "sudo dnf upgrade -y"
+    ]
+  }
+
+  provisioner "shell" {
+    inline = [
+      "sudo dnf install -y oci-fss-utils"
+    ]
+  }
+
+  provisioner "shell" {
+    inline = [
+      "sudo grubby --update-kernel=ALL --args=\"systemd.unified_cgroup_hierarchy=1\"",
+      "sudo reboot"
+    ]
+    expect_disconnect = true
+    pause_before = "10s"
+  }
+}

app-dev/devops-and-containers/oke/oke-node-packer/run-packer.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+# Run Packer build with -on-error=ask so that you can decide what to do in case of an error
+# Add the -debug flag in case you want to debug the packer script
+packer build -var-file=vars.pkrvars.hcl -on-error=ask .

app-dev/devops-and-containers/oke/oke-node-packer/variables.pkr.hcl

@@ -0,0 +1,47 @@
+variable "availability_domain" {
+  type    = string
+}
+
+variable "base_image_ocid" {
+  type    = string
+}
+
+variable "compartment_ocid" {
+  type    = string
+}
+
+variable "image_prefix" {
+  type    = string
+}
+
+variable "shape" {
+  type    = string
+}
+
+variable "ocpus" {
+  type    = number
+  default = 1
+}
+
+variable "memory_in_gbs" {
+  type    = number
+  default = 8
+}
+
+variable "subnet_ocid" {
+  type    = string
+}
+
+variable "ssh_username" {
+  type    = string
+  default = "opc"
+}
+
+variable "region" {
+  type    = string
+}
+
+variable "skip_create_image" {
+  type    = bool
+  default = false
+}

app-dev/devops-and-containers/oke/oke-node-packer/vars.pkrvars.hcl

@@ -0,0 +1,10 @@
+availability_domain = "XXXX:REGION-AD-1" // Replace with your availability domain, e.g., "gqUG:EU-FRANKFURT-1-AD-1"
+base_image_ocid = "ocid1.image.oc1.region-name.XXXXXXXXXX" // Replace with the OCID of the Oracle-provided OKE base image
+compartment_ocid = "ocid1.compartment.oc1..XXXXXXXXXX" // Replace with your OCI compartment OCID
+image_prefix = "oke-custom-image-" // Optional: Change the prefix for the generated image name
+shape = "VM.Standard.E4.Flex" // Replace with your desired VM shape
+ocpus = 1 // Optional: Number of OCPUs
+memory_in_gbs = 8 // Optional: Memory in GB
+subnet_ocid = "ocid1.subnet.oc1.region-name.XXXXXXXXXX" // Replace with your subnet OCID
+region = "region-name" // Replace with your OCI region, e.g., "eu-frankfurt-1"
+skip_create_image = false // Optional: Set to true to skip creating the image