Installing the OCI Native Ingress Controller as a Cluster Add-on

In a suitable editor, create a JSON file with a name of your choice (these instructions assume the file is called native-ingress-controller-addon.json) containing the following:

{
  "addonName": "NativeIngressController",
  "configurations": [
    {
      "key": "compartmentId",
      "value": "<compartment-ocid>"
    },
    {
      "key": "loadBalancerSubnetId",
      "value": "<load-balancer-subnet-ocid>"
    }    
  ]
}

where:

• <compartment-id> is the OCID of the compartment in which the OCI native ingress controller is to create the OCI load balancer and certificate.
• <load-balancer-subnet-ocid> is the OCID of the load balancer's subnet.

For example:

{
  "addonName": "NativeIngressController",
  "configurations": [
    {
      "key": "compartmentId",
      "value": "ocid1.compartment.oc1..aaaaaaaa______ddq"
    },
    {
      "key": "loadBalancerSubnetId",
      "value": "ocid1.subnet.oc1.iad.aaaaaaaa______dba"
    }    
  ]
}

• If you have set up an instance principal to enable the OCI native ingress controller to access OCI services and resources, set the authType parameter to instance.
• If you have set up a workload identity principal to enable the OCI native ingress controller to access OCI services and resources, set the authType parameter to workload.
• If you have set up a user principal to enable the OCI native ingress controller to access OCI services and resources, set the authType parameter to user.

For example:

      "key": "authType",
      "value": "workload"

Note that instance is the default value of the authType parameter, so if you do not explicitly specify a value for authType, the OCI native ingress controller uses the identity of the instance on which it is running to access OCI services and resources. For more information, see Setting Up an Instance Principal, User Principal, or Workload Identity Principal to Enable Access to OCI Services and Resources.

For example:

{
  "addonName": "NativeIngressController",
  "configurations": [
    {
      "key": "compartmentId",
      "value": "ocid1.compartment.oc1..aaaaaaaa______ddq"
    },
    {
      "key": "loadBalancerSubnetId",
      "value": "ocid1.subnet.oc1.iad.aaaaaaaa______dba"
    },
    {
      "key": "authType",
      "value": "workload"
    },
    {
      "key": "logVerbosity",
      "value": "2"
    }        
  ]
}

oci ce cluster list-addons --cluster-id <cluster-ocid>

where <cluster-ocid> is the OCID of the cluster on which you want to deploy the OCI native ingress controller add-on.

Deploy the OCI native ingress controller add-on on the cluster by entering:

oci ce cluster install-addon --addon-name NativeIngressController --cluster-id <cluster-ocid> --from-json file://./<path-to-config-file>

where:

• --cluster-id <cluster-ocid> is the OCID of the cluster in which you want to deploy the OCI native ingress controller add-on.
• --from-json file://<path-to-config-file> specifies the location of the OCI native ingress controller add-on configuration file you created earlier. For example, --from-json file://./native-ingress-controller-addon.json

For example:

oci ce cluster install-addon --addon-name NativeIngressController --from-json file://./native-ingress-controller-addon.json --cluster-id ocid1.cluster.oc1.iad.aaaaaaaam______dfr

A work request is created to deploy the OCI native ingress controller add-on.

Confirm successful deployment of the OCI native ingress controller add-on by entering:

oci ce cluster list-addons --cluster-id <cluster-ocid>

Assuming successful deployment, the output shows the OCI native ingress controller add-on with a lifecycle-state of ACTIVE. For example:

{
  "data": [
    {
      "addon-error": null,
      "current-installed-version": "v1.19.0",
      "lifecycle-state": "ACTIVE",
      "name": "NativeIngressController",
      "time-created": "2023-11-06T11:21:11+00:00",
      "version": null
    }
  ]
}