Fortinet white logo
Fortinet white logo

Service Annotations

Service Annotations

You can define the health check profile and SSL profile in the Kubernetes service annotation.

The health check profile and SSL profile will be automatically configured in the corresponding real server pool on FortiADC.

Parameter

Description

Default

health-check-ctrl Enable/disable the health checking for the real server pool. disable
health-check-relation
  • AND — All of the selected health checks must pass for the server to be considered available.

  • OR — One of the selected health checks must pass for the server to be considered available.

health-check-list

One or more health check configuration names. Concatenate the health check names with a space between each name.

For example: "LB_HLTHCK_ICMP LB_HLTHCK_HTTP".

For more details, see the FortiADC Administration Guide on health checks.

real-server-ssl-profile

Specify the real server SSL profile name. Real server profiles determine settings for communication between FortiADC and the backend real servers.

The default is NONE, which is applicable for non-SSL traffic.

For more details, see the FortiADC Administration Guide on SSL profiles.

NONE

overlay_tunnel

Specify the overlay tunnel name. This is used for services with the ClusterIP type.

Here is an example service.yaml with health check parameters:

kind: Service
apiVersion: v1
metadata:
  labels:
  name: default-http-backend
  namespace: default
  annotations: {
    "health-check-ctrl" : "enable",
    "health-check-relation" : "OR",
    "health-check-list" : "LB_HLTHCK_ICMP",
    "real-server-ssl-profile" : "NONE"
  }
spec:
  type: NodePort
  ports:
  - port: 80
    protocol: TCP
    targetPort: 80
  selector:
    app: nginx
  sessionAffinity: None

Service Annotations

Service Annotations

You can define the health check profile and SSL profile in the Kubernetes service annotation.

The health check profile and SSL profile will be automatically configured in the corresponding real server pool on FortiADC.

Parameter

Description

Default

health-check-ctrl Enable/disable the health checking for the real server pool. disable
health-check-relation
  • AND — All of the selected health checks must pass for the server to be considered available.

  • OR — One of the selected health checks must pass for the server to be considered available.

health-check-list

One or more health check configuration names. Concatenate the health check names with a space between each name.

For example: "LB_HLTHCK_ICMP LB_HLTHCK_HTTP".

For more details, see the FortiADC Administration Guide on health checks.

real-server-ssl-profile

Specify the real server SSL profile name. Real server profiles determine settings for communication between FortiADC and the backend real servers.

The default is NONE, which is applicable for non-SSL traffic.

For more details, see the FortiADC Administration Guide on SSL profiles.

NONE

overlay_tunnel

Specify the overlay tunnel name. This is used for services with the ClusterIP type.

Here is an example service.yaml with health check parameters:

kind: Service
apiVersion: v1
metadata:
  labels:
  name: default-http-backend
  namespace: default
  annotations: {
    "health-check-ctrl" : "enable",
    "health-check-relation" : "OR",
    "health-check-list" : "LB_HLTHCK_ICMP",
    "real-server-ssl-profile" : "NONE"
  }
spec:
  type: NodePort
  ports:
  - port: 80
    protocol: TCP
    targetPort: 80
  selector:
    app: nginx
  sessionAffinity: None