Oracle Cloud Infrastructure Documentation

Summary of Annotations for Load Balancers and Network Load Balancers

Find out which annotations to use to define the Oracle Cloud Infrastructure load balancers and network load balancers that Kubernetes Engine (OKE) provisions for a Kubernetes service of type LoadBalancer.

Annotations for Load Balancers

Annotation for Load Balancers Details
oci.oraclecloud.com/load-balancer-type: "lb" Specifying the Annotation for an OCI Load Balancer
service.beta.kubernetes.io/oci-load-balancer-ssl-ports: "443" Terminating SSL/TLS at the Load Balancer
service.beta.kubernetes.io/oci-load-balancer-tls-secret: ssl-certificate-secret Terminating SSL/TLS at the Load Balancer
oci.oraclecloud.com/oci-load-balancer-listener-ssl-config: '{"CipherSuiteName":"<cipher-suite-name>", "Protocols":["<tls-version>"]}' Terminating SSL/TLS at the Load Balancer
service.beta.kubernetes.io/oci-load-balancer-tls-backendset-secret: <value> Implementing SSL/TLS between the Load Balancer and Worker Nodes
oci.oraclecloud.com/oci-load-balancer-backendset-ssl-config: '{"CipherSuiteName":"<cipher-suite-name>", "Protocols":["<tls-version>"]}' Implementing SSL/TLS between the Load Balancer and Worker Nodes
service.beta.kubernetes.io/oci-load-balancer-shape: <value> Specifying Alternative Load Balancer Shapes
service.beta.kubernetes.io/oci-load-balancer-shape: "flexible" Specifying Flexible Load Balancer Shapes
service.beta.kubernetes.io/oci-load-balancer-shape-flex-min: "<min-value>" Specifying Flexible Load Balancer Shapes
service.beta.kubernetes.io/oci-load-balancer-shape-flex-max: "<max-value>" Specifying Flexible Load Balancer Shapes
service.beta.kubernetes.io/oci-load-balancer-connection-idle-timeout: <value> Specifying Load Balancer Connection Timeout
service.beta.kubernetes.io/oci-load-balancer-internal: "true" Creating Internal Load Balancers
service.beta.kubernetes.io/oci-load-balancer-subnet1: "<subnet-OCID>" Creating Internal Load Balancers
oci.oraclecloud.com/oci-network-security-groups: "<nsg-ocid>" Specifying Network Security Groups (recommended)
service.beta.kubernetes.io/oci-load-balancer-security-list-management-mode: <value> Specifying Security List Management Options When Provisioning an OCI Load Balancer
oci.oraclecloud.com/security-rule-management-mode: "<value>" Specifying Security Rule Management Options for Load Balancers and Network Load Balancers
oci.oraclecloud.com/oci-backend-network-security-group: "<nsg-ocid>" Specifying Security Rule Management Options for Load Balancers and Network Load Balancers
service.beta.kubernetes.io/oci-load-balancer-backend-protocol: <value> Specifying Listener Protocols
service.beta.kubernetes.io/oci-load-balancer-health-check-retries: "<value>" Specifying Health Check Parameters
service.beta.kubernetes.io/oci-load-balancer-health-check-timeout: "<value>" Specifying Health Check Parameters
service.beta.kubernetes.io/oci-load-balancer-health-check-interval: "<value>" Specifying Health Check Parameters
oci.oraclecloud.com/node-label-selector: <label> Selecting Worker Nodes To Include In Backend Sets
oci.oraclecloud.com/loadbalancer-policy: <value> Specifying Backend Set Policies
oci.oraclecloud.com/ingress-ip-mode: <value> Specifying IPMode to adjust traffic routing
oci.oraclecloud.com/initial-defined-tags-override: '{"<tag-namespace>": {"<tag-key>": "<tag-value>"}}' Tagging Load Balancers and Network Load Balancers
oci.oraclecloud.com/initial-freeform-tags-override: '{"<tag-key>": "<tag-value>"}' Tagging Load Balancers and Network Load Balancers
service.beta.kubernetes.io/oci-load-balancer-connection-proxy-protocol-version: "<value>" Enabling Proxy Protocol

Annotations for Network Load Balancers

Load Balancer Annotation Details
oci.oraclecloud.com/load-balancer-type: "nlb" Specifying the Annotation for an OCI Network Load Balancer
oci-network-load-balancer.oraclecloud.com/internal: "true" Creating Internal Load Balancers
oci-network-load-balancer.oraclecloud.com/subnet: "<subnet-OCID>" Creating Internal Load Balancers
oci-network-load-balancer.oraclecloud.com/oci-network-security-groups: "<nsg-ocid>" Specifying Network Security Groups (recommended)
oci-network-load-balancer.oraclecloud.com/security-list-management-mode: <value> Specifying Security List Management Options When Provisioning an OCI Load Balancer
oci.oraclecloud.com/security-rule-management-mode: "<value>" Specifying Security Rule Management Options for Load Balancers and Network Load Balancers
oci.oraclecloud.com/oci-backend-network-security-group: "<nsg-ocid>" Specifying Security Rule Management Options for Load Balancers and Network Load Balancers
oci-network-load-balancer.oraclecloud.com/is-preserve-source: "<value>" Terminating Requests at the Receiving Node
oci-network-load-balancer.oraclecloud.com/backend-policy Specifying Backend Set Policies
oci-network-load-balancer.oraclecloud.com/health-check-retries: "<value>" Specifying Health Check Parameters
oci-network-load-balancer.oraclecloud.com/health-check-timeout: "<value>" Specifying Health Check Parameters
oci-network-load-balancer.oraclecloud.com/health-check-interval: "<value>" Specifying Health Check Parameters
oci-network-load-balancer.oraclecloud.com/node-label-selector: <label> Selecting Worker Nodes To Include In Backend Sets
oci.oraclecloud.com/ingress-ip-mode: <value> Specifying IPMode to adjust traffic routing
oci-network-load-balancer.oraclecloud.com/defined-tags: '{"<tag-namespace>": {"<tag-key>": "<tag-value>"}}' Tagging Load Balancers and Network Load Balancers
oci-network-load-balancer.oraclecloud.com/freeform-tags: '{"<tag-key>": "<tag-value>"}' Tagging Load Balancers and Network Load Balancers
oci-network-load-balancer.oraclecloud.com/is-ppv2-enabled: "<value>" Enabling Proxy Protocol