f5xc_workload Resource - terraform-provider-f5xc

f5xc_workload (Resource)

Manages a Workload resource in F5 Distributed Cloud for workload. configuration.

~> Note For more information about this resource, please refer to the F5 XC API Documentation.

Example Usage

# Workload Resource Example
# Manages a Workload resource in F5 Distributed Cloud for workload. configuration.

terraform {
  required_version = ">= 1.0"

  required_providers {
    f5xc = {
      source  = "f5xc-salesdemos/f5xc"
      version = ">= 0.1.0"
    }
  }
}

# Basic Workload configuration
resource "f5xc_workload" "example" {
  name      = "example-workload"
  namespace = "staging"

  labels = {
    environment = "production"
    managed_by  = "terraform"
  }

  annotations = {
    "owner" = "platform-team"
  }

  # Workload configuration
  # Container configuration
  containers {
    name = "web"
    image {
      name        = "nginx"
      public      = {}
      pull_policy = "IMAGE_PULL_POLICY_ALWAYS"
    }
  }

  # Deploy on regional edge
  deploy_on_re {
    virtual_site {
      name      = "example-virtual-site"
      namespace = "staging"
    }
  }
}

Argument Reference

🔶 High Risk Operations — Some operations on this resource have high danger level. Destructive operations may require confirmation.

~> Dependencies — This resource requires: virtual_k8s.

Metadata Argument Reference

• name - Required String
Name of the Workload. Must be unique within the namespace

• namespace - Required String
Namespace where the Workload will be created

• annotations - Optional Map
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata

• description - Optional String
Human readable description for the object

• disable - Optional Bool
A value of true will administratively disable the object

• labels - Optional Map
Labels is a user defined key value map that can be attached to resources for organization and filtering

Spec Argument Reference

-> One of the following: • job - Optional Block
Jobs are used for running batch processing tasks and run to completion. Jobs are generally used for tasks like report generation, billing, parallel data processing, ETL processing, etc
See Job below for details.

• service - Optional Block
Service does not maintain per replica state, however it can be configured to use persistent storage that is shared amongst all the replicas. Replicas of a service are fungible and do not have a stable network identity or storage. Common examples of services are web servers, application servers
See Service below for details.

• simple_service - Optional Block
SimpleService is a service having one container and one replica that is deployed on all Regional Edges and advertised on internet via HTTP loadbalancer on default VIP

• stateful_service - Optional Block
StatefulService maintains per replica state and each replica has its own persistent storage. Each replica has a unique network identity and stable storage. Stateful service are used for distributed stateful applications like Cassandra, MongoDB, redis, etc

• timeouts - Optional Block

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id - Optional String
Unique identifier for the resource

Job

A job block supports the following:

• configuration - Optional Block
Configuration parameters of the workload
See Configuration below.

• containers - Optional Block
Containers to use for the job
See Containers below.

• deploy_options - Optional Block
Deploy OPTIONS are used to configure the workload deployment OPTIONS
See Deploy Options below.

• num_replicas - Optional Number
Number of replicas of the batch job to spawn per site

• volumes - Optional Block
Volumes. Volumes for the job
See Volumes below.

Job Configuration

A configuration block (within job) supports the following:

• parameters - Optional Block
Parameters. Parameters for the workload
See Parameters below.

Job Configuration Parameters

A parameters block (within job.configuration) supports the following:

• env_var - Optional Block
Environment Variable. Environment Variable
See Env Var below.

• file - Optional Block
Configuration File. Configuration File for the workload
See File below.

Job Configuration Parameters Env Var

An env_var block (within job.configuration.parameters) supports the following:

• name - Optional String
Name. Name of Environment Variable

• value - Optional String
Value. Value of Environment Variable

Job Configuration Parameters File

A file block (within job.configuration.parameters) supports the following:

• data - Optional String
Data. File data

• mount - Optional Block
Volume mount describes how volume is mounted inside a workload
See Mount below.

• name - Optional String
Name. Name of the file

• volume_name - Optional String
Volume Name. Name of the Volume

Job Configuration Parameters File Mount

A mount block (within job.configuration.parameters.file) supports the following:

• mode - Optional String Defaults to VOLUME_MOUNT_READ_ONLY
Possible values are VOLUME_MOUNT_READ_ONLY, VOLUME_MOUNT_READ_WRITE
[Enum: VOLUME_MOUNT_READ_ONLY|VOLUME_MOUNT_READ_WRITE] Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode

• mount_path - Optional String
Path within the workload container at which the volume should be mounted. Must not contain ’:’

• sub_path - Optional String Defaults to '' (volume's root)
Path within the volume from which the workload’s volume should be mounted

Job Containers

A containers block (within job) supports the following:

• args - Optional List
Arguments to the entrypoint. Overrides the Docker image’s CMD

• command - Optional List
Command to execute. Overrides the Docker image’s ENTRYPOINT

• custom_flavor - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
See Custom Flavor below.

• default_flavor - Optional Block
Configuration parameter for default flavor

• flavor - Optional String Defaults to CONTAINER_FLAVOR_TYPE_TINY
Possible values are CONTAINER_FLAVOR_TYPE_TINY, CONTAINER_FLAVOR_TYPE_MEDIUM, CONTAINER_FLAVOR_TYPE_LARGE
[Enum: CONTAINER_FLAVOR_TYPE_TINY|CONTAINER_FLAVOR_TYPE_MEDIUM|CONTAINER_FLAVOR_TYPE_LARGE] Container Flavor type - CONTAINER_FLAVOR_TYPE_TINY: Tiny Tiny containers have limit of 0.1 vCPU and 256 MiB (mebibyte) memory - CONTAINER_FLAVOR_TYPE_MEDIUM: Medium Medium containers have limit of 0.25 vCPU and 512 MiB (mebibyte) memory - CONTAINER_FLAVOR_TYPE_LARGE: Large Large containers have

• image - Optional Block
ImageType configures the image to use, how to pull the image, and the associated secrets to use if any
See Image below.

• init_container - Optional Bool
Specialized container that runs before application container and runs to completion

• liveness_check - Optional Block
HealthCheckType describes a health check to be performed against a container to determine whether it has started up or is alive or ready to receive traffic
See Liveness Check below.

• name - Optional String
Name. Name of the container

• readiness_check - Optional Block
HealthCheckType describes a health check to be performed against a container to determine whether it has started up or is alive or ready to receive traffic
See Readiness Check below.

Job Containers Custom Flavor

A custom_flavor block (within job.containers) supports the following:

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

Job Containers Image

An image block (within job.containers) supports the following:

• container_registry - Optional Block
Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name
See Container Registry below.

• name - Optional String
Name is a container image which are usually given a name such as alpine, Ubuntu, or quay.I/O/etcd:0.13. The format is registry/image:tag or registry/image@image-digest. If registry is not specified, the Docker public registry is assumed

• public - Optional Block
Enable this option

• pull_policy - Optional String Defaults to IMAGE_PULL_POLICY_DEFAULT
Possible values are IMAGE_PULL_POLICY_DEFAULT, IMAGE_PULL_POLICY_IF_NOT_PRESENT, IMAGE_PULL_POLICY_ALWAYS, IMAGE_PULL_POLICY_NEVER
[Enum: IMAGE_PULL_POLICY_DEFAULT|IMAGE_PULL_POLICY_IF_NOT_PRESENT|IMAGE_PULL_POLICY_ALWAYS|IMAGE_PULL_POLICY_NEVER] Image pull policy type enumerates the policy choices to use for pulling the image prior to starting the workload - IMAGE_PULL_POLICY_DEFAULT: Default Default will always pull image if :latest tag is specified in image name. If :latest tag is not specified in image name, it will pull image only

Job Containers Image Container Registry

A container_registry block (within job.containers.image) supports the following:

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

Job Containers Liveness Check

A liveness_check block (within job.containers) supports the following:

• exec_health_check - Optional Block
ExecHealthCheckType describes a health check based on ‘run in container’ action. Exit status of 0 is treated as live/healthy and non-zero is unhealthy
See Exec Health Check below.

• healthy_threshold - Optional Number
Number of consecutive successful responses after having failed before declaring healthy. In other words, this is the number of healthy health checks required before marking healthy. Note that during startup and liveliness, only a single successful health check is required to mark a container

• http_health_check - Optional Block
HTTPHealthCheckType describes a health check based on HTTP GET requests
See HTTP Health Check below.

• initial_delay - Optional Number
Number of seconds after the container has started before health checks are initiated

• interval - Optional Number
Time interval in seconds between two health check requests

• tcp_health_check - Optional Block
TCPHealthCheckType describes a health check based on opening a TCP connection
See TCP Health Check below.

• timeout - Optional Number
Timeout in seconds to wait for successful response. In other words, it is the time to wait for a health check response. If the timeout is reached the health check attempt will be considered a failure

• unhealthy_threshold - Optional Number
Number of consecutive failed responses before declaring unhealthy. In other words, this is the number of unhealthy health checks required before a container is marked unhealthy

Job Containers Liveness Check Exec Health Check

An exec_health_check block (within job.containers.liveness_check) supports the following:

• command - Optional List
Command is the command line to execute inside the container, the working directory for the command is root (’/’) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions (’|’, etc) won’t work. To use a shell, you need to

Job Containers Liveness Check HTTP Health Check

A http_health_check block (within job.containers.liveness_check) supports the following:

• headers - Optional Block
Specifies a list of HTTP headers that should be added to each request that is sent to the health checked container. This is a list of key-value pairs

• host_header - Optional String
The value of the host header in the HTTP health check request

• path - Optional String
Path to access on the HTTP server

• port - Optional Block
Port. Port
See Port below.

Job Containers Liveness Check HTTP Health Check Port

Deeply nested Port block collapsed for readability.

Job Containers Liveness Check TCP Health Check

A tcp_health_check block (within job.containers.liveness_check) supports the following:

• port - Optional Block
Port. Port
See Port below.

Job Containers Liveness Check TCP Health Check Port

Deeply nested Port block collapsed for readability.

Job Containers Readiness Check

A readiness_check block (within job.containers) supports the following:

• http_health_check - Optional Block
HTTPHealthCheckType describes a health check based on HTTP GET requests
See HTTP Health Check below.

• initial_delay - Optional Number
Number of seconds after the container has started before health checks are initiated

• interval - Optional Number
Time interval in seconds between two health check requests

• tcp_health_check - Optional Block
TCPHealthCheckType describes a health check based on opening a TCP connection
See TCP Health Check below.

Job Containers Readiness Check Exec Health Check

An exec_health_check block (within job.containers.readiness_check) supports the following:

Job Containers Readiness Check HTTP Health Check

A http_health_check block (within job.containers.readiness_check) supports the following:

• headers - Optional Block
Specifies a list of HTTP headers that should be added to each request that is sent to the health checked container. This is a list of key-value pairs

• host_header - Optional String
The value of the host header in the HTTP health check request

• path - Optional String
Path to access on the HTTP server

• port - Optional Block
Port. Port
See Port below.

Job Containers Readiness Check HTTP Health Check Port

Deeply nested Port block collapsed for readability.

Job Containers Readiness Check TCP Health Check

A tcp_health_check block (within job.containers.readiness_check) supports the following:

• port - Optional Block
Port. Port
See Port below.

Job Containers Readiness Check TCP Health Check Port

Deeply nested Port block collapsed for readability.

Job Deploy Options

A deploy_options block (within job) supports the following:

• all_res - Optional Block
Enable this option

• default_virtual_sites - Optional Block
Enable this option

• deploy_ce_sites - Optional Block
Defines a way to deploy a workload on specific Customer sites
See Deploy CE Sites below.

• deploy_ce_virtual_sites - Optional Block
Defines a way to deploy a workload on specific Customer virtual sites
See Deploy CE Virtual Sites below.

• deploy_re_sites - Optional Block
Defines a way to deploy a workload on specific Regional Edge sites
See Deploy RE Sites below.

• deploy_re_virtual_sites - Optional Block
Defines a way to deploy a workload on specific Regional Edge virtual sites
See Deploy RE Virtual Sites below.

Job Deploy Options Deploy CE Sites

A deploy_ce_sites block (within job.deploy_options) supports the following:

• site - Optional Block
Which customer sites should this workload be deployed
See Site below.

Job Deploy Options Deploy CE Sites Site

A site block (within job.deploy_options.deploy_ce_sites) supports the following:

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

Job Deploy Options Deploy CE Virtual Sites

A deploy_ce_virtual_sites block (within job.deploy_options) supports the following:

• virtual_site - Optional Block
Which customer virtual sites should this workload be deployed
See Virtual Site below.

Job Deploy Options Deploy CE Virtual Sites Virtual Site

Deeply nested Site block collapsed for readability.

Job Deploy Options Deploy RE Sites

A deploy_re_sites block (within job.deploy_options) supports the following:

• site - Optional Block
Which regional edge sites should this workload be deployed
See Site below.

Job Deploy Options Deploy RE Sites Site

A site block (within job.deploy_options.deploy_re_sites) supports the following:

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

Job Deploy Options Deploy RE Virtual Sites

A deploy_re_virtual_sites block (within job.deploy_options) supports the following:

• virtual_site - Optional Block
Which regional edge virtual sites should this workload be deployed
See Virtual Site below.

Job Deploy Options Deploy RE Virtual Sites Virtual Site

Deeply nested Site block collapsed for readability.

Job Volumes

A volumes block (within job) supports the following:

• empty_dir - Optional Block
Volume containing a temporary directory whose lifetime is the same as a replica of a workload
See Empty Dir below.

• host_path - Optional Block
Volume containing a host mapped path into the workload
See Host Path below.

• name - Optional String
Name. Name of the volume

• persistent_volume - Optional Block
Volume containing the Persistent Storage for the workload
See Persistent Volume below.

Job Volumes Empty Dir

An empty_dir block (within job.volumes) supports the following:

• mount - Optional Block
Volume mount describes how volume is mounted inside a workload
See Mount below.

• size_limit - Optional Number
Size Limit (in GiB)

Job Volumes Empty Dir Mount

A mount block (within job.volumes.empty_dir) supports the following:

• mount_path - Optional String
Path within the workload container at which the volume should be mounted. Must not contain ’:’

• sub_path - Optional String Defaults to '' (volume's root)
Path within the volume from which the workload’s volume should be mounted

Job Volumes Host Path

A host_path block (within job.volumes) supports the following:

• mount - Optional Block
Volume mount describes how volume is mounted inside a workload
See Mount below.

• path - Optional String
Path of the directory on the host

Job Volumes Host Path Mount

A mount block (within job.volumes.host_path) supports the following:

• mount_path - Optional String
Path within the workload container at which the volume should be mounted. Must not contain ’:’

• sub_path - Optional String Defaults to '' (volume's root)
Path within the volume from which the workload’s volume should be mounted

Job Volumes Persistent Volume

A persistent_volume block (within job.volumes) supports the following:

• mount - Optional Block
Volume mount describes how volume is mounted inside a workload
See Mount below.

• storage - Optional Block
Persistent storage configuration is used to configure Persistent Volume Claim (PVC)
See Storage below.

Job Volumes Persistent Volume Mount

A mount block (within job.volumes.persistent_volume) supports the following:

• mount_path - Optional String
Path within the workload container at which the volume should be mounted. Must not contain ’:’

• sub_path - Optional String Defaults to '' (volume's root)
Path within the volume from which the workload’s volume should be mounted

Job Volumes Persistent Volume Storage

A storage block (within job.volumes.persistent_volume) supports the following:

• access_mode - Optional String Defaults to ACCESS_MODE_READ_WRITE_ONCE
Possible values are ACCESS_MODE_READ_WRITE_ONCE, ACCESS_MODE_READ_WRITE_MANY, ACCESS_MODE_READ_ONLY_MANY
[Enum: ACCESS_MODE_READ_WRITE_ONCE|ACCESS_MODE_READ_WRITE_MANY|ACCESS_MODE_READ_ONLY_MANY] Persistence storage access mode is used to configure access mode for persistent storage - ACCESS_MODE_READ_WRITE_ONCE: Read Write Once Read Write Once is used to mount persistent storage in read/write mode to exactly 1 host - ACCESS_MODE_READ_WRITE_MANY: Read Write Many Read Write Many is used

• class_name - Optional String
Use the specified class name

• default - Optional Block
Enable this option

• storage_size - Optional Number
Size in GiB of the persistent storage

Service

A service block supports the following:

• advertise_options - Optional Block
Advertise OPTIONS are used to configure how and where to advertise the workload using load balancers
See Advertise Options below.

• configuration - Optional Block
Configuration parameters of the workload
See Configuration below.

• containers - Optional Block
Containers to use for service
See Containers below.

• deploy_options - Optional Block
Deploy OPTIONS are used to configure the workload deployment OPTIONS
See Deploy Options below.

• num_replicas - Optional Number
Number of replicas of service to spawn per site

• scale_to_zero - Optional Block
Configuration parameter for scale to zero

• volumes - Optional Block
Volumes. Volumes for the service
See Volumes below.

Service Advertise Options

An advertise_options block (within service) supports the following:

• advertise_custom - Optional Block
Advertise this workload via loadbalancer on specific sites
See Advertise Custom below.

• advertise_in_cluster - Optional Block
Advertise the workload locally in-cluster
See Advertise In Cluster below.

• advertise_on_public - Optional Block
Advertise this workload via loadbalancer on internet with default VIP
See Advertise On Public below.

• do_not_advertise - Optional Block
Configuration parameter for do not advertise

Service Advertise Options Advertise Custom

An advertise_custom block (within service.advertise_options) supports the following:

• advertise_where - Optional Block
Where should this load balancer be available
See Advertise Where below.

• ports - Optional Block
Ports. Ports to advertise
See Ports below.

Service Advertise Options Advertise Custom Advertise Where

An advertise_where block (within service.advertise_options.advertise_custom) supports the following:

• site - Optional Block
Defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised
See Site below.

• virtual_site - Optional Block
Defines a reference to a customer site virtual site along with network type where a load balancer could be advertised
See Virtual Site below.

• vk8s_service - Optional Block
Defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network
See Vk8s Service below.

Service Advertise Options Advertise Custom Advertise Where Site

Deeply nested Site block collapsed for readability.

Service Advertise Options Advertise Custom Advertise Where Site Site

Deeply nested Site block collapsed for readability.

Service Advertise Options Advertise Custom Advertise Where Virtual Site

Deeply nested Site block collapsed for readability.

Service Advertise Options Advertise Custom Advertise Where Virtual Site Virtual Site

Deeply nested Site block collapsed for readability.

Service Advertise Options Advertise Custom Advertise Where Vk8s Service

Deeply nested Service block collapsed for readability.

Service Advertise Options Advertise Custom Advertise Where Vk8s Service Site

Deeply nested Site block collapsed for readability.

Service Advertise Options Advertise Custom Advertise Where Vk8s Service Virtual Site

Deeply nested Site block collapsed for readability.

Service Advertise Options Advertise Custom Ports

A ports block (within service.advertise_options.advertise_custom) supports the following:

• http_loadbalancer - Optional Block
Configuration parameter for HTTP loadbalancer
See HTTP Loadbalancer below.

• port - Optional Block
Port. Port of the workload
See Port below.

• tcp_loadbalancer - Optional Block
Configuration parameter for TCP loadbalancer
See TCP Loadbalancer below.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer

Deeply nested Loadbalancer block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Default Route

Deeply nested Route block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTP

Deeply nested HTTP block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS

Deeply nested HTTPS block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Coalescing Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS HTTP Protocol Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only

Deeply nested Only block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation

Deeply nested Transformation block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params

Deeply nested Params block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Certificates

Deeply nested Certificates block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config

Deeply nested Config block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS

Deeply nested mTLS block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters

Deeply nested Parameters block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates

Deeply nested Certificates block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Custom Hash Algorithms

Deeply nested Algorithms block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key

Deeply nested Key block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Clear Secret Info

Deeply nested Info block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config

Deeply nested Config block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS

Deeply nested mTLS block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert

Deeply nested Cert block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Coalescing Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only

Deeply nested Only block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation

Deeply nested Transformation block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config

Deeply nested Config block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS

Deeply nested mTLS block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes

Deeply nested Routes block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes

Deeply nested Routes block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object

Deeply nested Object block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object Route Ref

Deeply nested Ref block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route

Deeply nested Route block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Headers

Deeply nested Headers block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Incoming Port

Deeply nested Port block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Path

Deeply nested Path block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Route Direct Response

Deeply nested Response block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route

Deeply nested Route block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Headers

Deeply nested Headers block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Incoming Port

Deeply nested Port block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Path

Deeply nested Path block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Route Redirect

Deeply nested Redirect block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Simple Route

Deeply nested Route block collapsed for readability.

Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Simple Route Path

Deeply nested Path block collapsed for readability.

Service Advertise Options Advertise Custom Ports Port

A port block (within service.advertise_options.advertise_custom.ports) supports the following:

• info - Optional Block
Port Information. Port information
See Info below.

• name - Optional String
Name. Name of the Port

Service Advertise Options Advertise Custom Ports Port Info

Deeply nested Info block collapsed for readability.

Service Advertise Options Advertise Custom Ports TCP Loadbalancer

Deeply nested Loadbalancer block collapsed for readability.

Service Advertise Options Advertise In Cluster

An advertise_in_cluster block (within service.advertise_options) supports the following:

• multi_ports - Optional Block
Multiple Ports. Multiple ports
See Multi Ports below.

• port - Optional Block
Port. Single port
See Port below.

Service Advertise Options Advertise In Cluster Multi Ports

Deeply nested Ports block collapsed for readability.

Service Advertise Options Advertise In Cluster Multi Ports Ports

Deeply nested Ports block collapsed for readability.

Service Advertise Options Advertise In Cluster Multi Ports Ports Info

Deeply nested Info block collapsed for readability.

Service Advertise Options Advertise In Cluster Port

A port block (within service.advertise_options.advertise_in_cluster) supports the following:

• info - Optional Block
Port Information. Port information
See Info below.

Service Advertise Options Advertise In Cluster Port Info

Deeply nested Info block collapsed for readability.

Service Advertise Options Advertise On Public

An advertise_on_public block (within service.advertise_options) supports the following:

• multi_ports - Optional Block
Advertise Multiple Ports. Advertise multiple ports
See Multi Ports below.

• port - Optional Block
Advertise Port. Advertise single port
See Port below.

Service Advertise Options Advertise On Public Multi Ports

Deeply nested Ports block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports

Deeply nested Ports block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer

Deeply nested Loadbalancer block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Default Route

Deeply nested Route block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTP

Deeply nested HTTP block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS

Deeply nested HTTPS block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Coalescing Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS HTTP Protocol Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only

Deeply nested Only block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation

Deeply nested Transformation block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params

Deeply nested Params block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Certificates

Deeply nested Certificates block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config

Deeply nested Config block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS

Deeply nested mTLS block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters

Deeply nested Parameters block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates

Deeply nested Certificates block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Custom Hash Algorithms

Deeply nested Algorithms block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key

Deeply nested Key block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Clear Secret Info

Deeply nested Info block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config

Deeply nested Config block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS

Deeply nested mTLS block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert

Deeply nested Cert block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Coalescing Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only

Deeply nested Only block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation

Deeply nested Transformation block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config

Deeply nested Config block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS

Deeply nested mTLS block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes

Deeply nested Routes block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes

Deeply nested Routes block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object

Deeply nested Object block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object Route Ref

Deeply nested Ref block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route

Deeply nested Route block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Headers

Deeply nested Headers block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Incoming Port

Deeply nested Port block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Path

Deeply nested Path block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Route Direct Response

Deeply nested Response block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route

Deeply nested Route block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Headers

Deeply nested Headers block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Incoming Port

Deeply nested Port block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Path

Deeply nested Path block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Route Redirect

Deeply nested Redirect block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Simple Route

Deeply nested Route block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Simple Route Path

Deeply nested Path block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports Port

Deeply nested Port block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports Port Info

Deeply nested Info block collapsed for readability.

Service Advertise Options Advertise On Public Multi Ports Ports TCP Loadbalancer

Deeply nested Loadbalancer block collapsed for readability.

Service Advertise Options Advertise On Public Port

A port block (within service.advertise_options.advertise_on_public) supports the following:

• http_loadbalancer - Optional Block
Configuration parameter for HTTP loadbalancer
See HTTP Loadbalancer below.

• port - Optional Block
Port. Single port
See Port below.

• tcp_loadbalancer - Optional Block
Configuration parameter for TCP loadbalancer
See TCP Loadbalancer below.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer

Deeply nested Loadbalancer block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Default Route

Deeply nested Route block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTP

Deeply nested HTTP block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS

Deeply nested HTTPS block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Coalescing Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS HTTP Protocol Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only

Deeply nested Only block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation

Deeply nested Transformation block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params

Deeply nested Params block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Certificates

Deeply nested Certificates block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params TLS Config

Deeply nested Config block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS

Deeply nested mTLS block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters

Deeply nested Parameters block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates

Deeply nested Certificates block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Custom Hash Algorithms

Deeply nested Algorithms block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key

Deeply nested Key block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Clear Secret Info

Deeply nested Info block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Config

Deeply nested Config block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS

Deeply nested mTLS block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert

Deeply nested Cert block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Coalescing Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only

Deeply nested Only block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation

Deeply nested Transformation block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert TLS Config

Deeply nested Config block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS

Deeply nested mTLS block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes

Deeply nested Routes block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes

Deeply nested Routes block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Custom Route Object

Deeply nested Object block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Custom Route Object Route Ref

Deeply nested Ref block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route

Deeply nested Route block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Headers

Deeply nested Headers block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Incoming Port

Deeply nested Port block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Path

Deeply nested Path block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Route Direct Response

Deeply nested Response block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route

Deeply nested Route block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Headers

Deeply nested Headers block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Incoming Port

Deeply nested Port block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Path

Deeply nested Path block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Route Redirect

Deeply nested Redirect block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Simple Route

Deeply nested Route block collapsed for readability.

Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Simple Route Path

Deeply nested Path block collapsed for readability.

Service Advertise Options Advertise On Public Port Port

Deeply nested Port block collapsed for readability.

Service Advertise Options Advertise On Public Port Port Info

Deeply nested Info block collapsed for readability.

Service Advertise Options Advertise On Public Port TCP Loadbalancer

Deeply nested Loadbalancer block collapsed for readability.

Service Configuration

A configuration block (within service) supports the following:

• parameters - Optional Block
Parameters. Parameters for the workload
See Parameters below.

Service Configuration Parameters

A parameters block (within service.configuration) supports the following:

• env_var - Optional Block
Environment Variable. Environment Variable
See Env Var below.

• file - Optional Block
Configuration File. Configuration File for the workload
See File below.

Service Configuration Parameters Env Var

An env_var block (within service.configuration.parameters) supports the following:

• name - Optional String
Name. Name of Environment Variable

• value - Optional String
Value. Value of Environment Variable

Service Configuration Parameters File

A file block (within service.configuration.parameters) supports the following:

• data - Optional String
Data. File data

• mount - Optional Block
Volume mount describes how volume is mounted inside a workload
See Mount below.

• name - Optional String
Name. Name of the file

• volume_name - Optional String
Volume Name. Name of the Volume

Service Configuration Parameters File Mount

A mount block (within service.configuration.parameters.file) supports the following:

• mount_path - Optional String
Path within the workload container at which the volume should be mounted. Must not contain ’:’

• sub_path - Optional String Defaults to '' (volume's root)
Path within the volume from which the workload’s volume should be mounted

Service Containers

A containers block (within service) supports the following:

• args - Optional List
Arguments to the entrypoint. Overrides the Docker image’s CMD

• command - Optional List
Command to execute. Overrides the Docker image’s ENTRYPOINT

• default_flavor - Optional Block
Configuration parameter for default flavor

• image - Optional Block
ImageType configures the image to use, how to pull the image, and the associated secrets to use if any
See Image below.

• init_container - Optional Bool
Specialized container that runs before application container and runs to completion

• name - Optional String
Name. Name of the container

Service Containers Custom Flavor

A custom_flavor block (within service.containers) supports the following:

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

Service Containers Image

An image block (within service.containers) supports the following:

• public - Optional Block
Enable this option

Service Containers Image Container Registry

A container_registry block (within service.containers.image) supports the following:

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

Service Containers Liveness Check

A liveness_check block (within service.containers) supports the following:

• http_health_check - Optional Block
HTTPHealthCheckType describes a health check based on HTTP GET requests
See HTTP Health Check below.

• initial_delay - Optional Number
Number of seconds after the container has started before health checks are initiated

• interval - Optional Number
Time interval in seconds between two health check requests

• tcp_health_check - Optional Block
TCPHealthCheckType describes a health check based on opening a TCP connection
See TCP Health Check below.

Service Containers Liveness Check Exec Health Check

An exec_health_check block (within service.containers.liveness_check) supports the following:

Service Containers Liveness Check HTTP Health Check

A http_health_check block (within service.containers.liveness_check) supports the following:

• headers - Optional Block
Specifies a list of HTTP headers that should be added to each request that is sent to the health checked container. This is a list of key-value pairs

• host_header - Optional String
The value of the host header in the HTTP health check request

• path - Optional String
Path to access on the HTTP server

• port - Optional Block
Port. Port
See Port below.

Service Containers Liveness Check HTTP Health Check Port

Deeply nested Port block collapsed for readability.

Service Containers Liveness Check TCP Health Check

A tcp_health_check block (within service.containers.liveness_check) supports the following:

• port - Optional Block
Port. Port
See Port below.

Service Containers Liveness Check TCP Health Check Port

Deeply nested Port block collapsed for readability.

Service Containers Readiness Check

A readiness_check block (within service.containers) supports the following:

• http_health_check - Optional Block
HTTPHealthCheckType describes a health check based on HTTP GET requests
See HTTP Health Check below.

• initial_delay - Optional Number
Number of seconds after the container has started before health checks are initiated

• interval - Optional Number
Time interval in seconds between two health check requests

• tcp_health_check - Optional Block
TCPHealthCheckType describes a health check based on opening a TCP connection
See TCP Health Check below.

Service Containers Readiness Check Exec Health Check

An exec_health_check block (within service.containers.readiness_check) supports the following:

Service Containers Readiness Check HTTP Health Check

A http_health_check block (within service.containers.readiness_check) supports the following:

• headers - Optional Block
Specifies a list of HTTP headers that should be added to each request that is sent to the health checked container. This is a list of key-value pairs

• host_header - Optional String
The value of the host header in the HTTP health check request

• path - Optional String
Path to access on the HTTP server

• port - Optional Block
Port. Port
See Port below.

Service Containers Readiness Check HTTP Health Check Port

Deeply nested Port block collapsed for readability.

Service Containers Readiness Check TCP Health Check

A tcp_health_check block (within service.containers.readiness_check) supports the following:

• port - Optional Block
Port. Port
See Port below.

Service Containers Readiness Check TCP Health Check Port

Deeply nested Port block collapsed for readability.

Service Deploy Options

A deploy_options block (within service) supports the following:

• all_res - Optional Block
Enable this option

• default_virtual_sites - Optional Block
Enable this option

• deploy_ce_sites - Optional Block
Defines a way to deploy a workload on specific Customer sites
See Deploy CE Sites below.

• deploy_ce_virtual_sites - Optional Block
Defines a way to deploy a workload on specific Customer virtual sites
See Deploy CE Virtual Sites below.

• deploy_re_sites - Optional Block
Defines a way to deploy a workload on specific Regional Edge sites
See Deploy RE Sites below.

• deploy_re_virtual_sites - Optional Block
Defines a way to deploy a workload on specific Regional Edge virtual sites
See Deploy RE Virtual Sites below.

Service Deploy Options Deploy CE Sites

A deploy_ce_sites block (within service.deploy_options) supports the following:

• site - Optional Block
Which customer sites should this workload be deployed
See Site below.

Service Deploy Options Deploy CE Sites Site

A site block (within service.deploy_options.deploy_ce_sites) supports the following:

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

Service Deploy Options Deploy CE Virtual Sites

A deploy_ce_virtual_sites block (within service.deploy_options) supports the following:

• virtual_site - Optional Block
Which customer virtual sites should this workload be deployed
See Virtual Site below.

Service Deploy Options Deploy CE Virtual Sites Virtual Site

Deeply nested Site block collapsed for readability.

Service Deploy Options Deploy RE Sites

A deploy_re_sites block (within service.deploy_options) supports the following:

• site - Optional Block
Which regional edge sites should this workload be deployed
See Site below.

Service Deploy Options Deploy RE Sites Site

A site block (within service.deploy_options.deploy_re_sites) supports the following:

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

Service Deploy Options Deploy RE Virtual Sites

A deploy_re_virtual_sites block (within service.deploy_options) supports the following:

• virtual_site - Optional Block
Which regional edge virtual sites should this workload be deployed
See Virtual Site below.

Service Deploy Options Deploy RE Virtual Sites Virtual Site

Deeply nested Site block collapsed for readability.

Service Volumes

A volumes block (within service) supports the following:

• empty_dir - Optional Block
Volume containing a temporary directory whose lifetime is the same as a replica of a workload
See Empty Dir below.

• host_path - Optional Block
Volume containing a host mapped path into the workload
See Host Path below.

• name - Optional String
Name. Name of the volume

• persistent_volume - Optional Block
Volume containing the Persistent Storage for the workload
See Persistent Volume below.

Service Volumes Empty Dir

An empty_dir block (within service.volumes) supports the following:

• mount - Optional Block
Volume mount describes how volume is mounted inside a workload
See Mount below.

• size_limit - Optional Number
Size Limit (in GiB)

Service Volumes Empty Dir Mount

A mount block (within service.volumes.empty_dir) supports the following:

• mount_path - Optional String
Path within the workload container at which the volume should be mounted. Must not contain ’:’

• sub_path - Optional String Defaults to '' (volume's root)
Path within the volume from which the workload’s volume should be mounted

Service Volumes Host Path

A host_path block (within service.volumes) supports the following:

• mount - Optional Block
Volume mount describes how volume is mounted inside a workload
See Mount below.

• path - Optional String
Path of the directory on the host

Service Volumes Host Path Mount

A mount block (within service.volumes.host_path) supports the following:

• mount_path - Optional String
Path within the workload container at which the volume should be mounted. Must not contain ’:’

• sub_path - Optional String Defaults to '' (volume's root)
Path within the volume from which the workload’s volume should be mounted

Service Volumes Persistent Volume

A persistent_volume block (within service.volumes) supports the following:

• mount - Optional Block
Volume mount describes how volume is mounted inside a workload
See Mount below.

• storage - Optional Block
Persistent storage configuration is used to configure Persistent Volume Claim (PVC)
See Storage below.

Service Volumes Persistent Volume Mount

A mount block (within service.volumes.persistent_volume) supports the following:

• mount_path - Optional String
Path within the workload container at which the volume should be mounted. Must not contain ’:’

• sub_path - Optional String Defaults to '' (volume's root)
Path within the volume from which the workload’s volume should be mounted

Service Volumes Persistent Volume Storage

A storage block (within service.volumes.persistent_volume) supports the following:

• class_name - Optional String
Use the specified class name

• default - Optional Block
Enable this option

• storage_size - Optional Number
Size in GiB of the persistent storage

Simple Service

A simple_service block supports the following:

• configuration - Optional Block
Configuration parameters of the workload
See Configuration below.

• container - Optional Block
ContainerType configures the container information
See Container below.

• disabled - Optional Block
Enable this option

• do_not_advertise - Optional Block
Configuration parameter for do not advertise

• enabled - Optional Block
Persistent storage volume configuration for the workload
See Enabled below.

• scale_to_zero - Optional Bool
Scale down replicas of the service to zero

• simple_advertise - Optional Block
Configuration parameter for simple advertise
See Simple Advertise below.

Simple Service Configuration

A configuration block (within simple_service) supports the following:

• parameters - Optional Block
Parameters. Parameters for the workload
See Parameters below.

Simple Service Configuration Parameters

A parameters block (within simple_service.configuration) supports the following:

• env_var - Optional Block
Environment Variable. Environment Variable
See Env Var below.

• file - Optional Block
Configuration File. Configuration File for the workload
See File below.

Simple Service Configuration Parameters Env Var

An env_var block (within simple_service.configuration.parameters) supports the following:

• name - Optional String
Name. Name of Environment Variable

• value - Optional String
Value. Value of Environment Variable

Simple Service Configuration Parameters File

A file block (within simple_service.configuration.parameters) supports the following:

• data - Optional String
Data. File data

• mount - Optional Block
Volume mount describes how volume is mounted inside a workload
See Mount below.

• name - Optional String
Name. Name of the file

• volume_name - Optional String
Volume Name. Name of the Volume

Simple Service Configuration Parameters File Mount

A mount block (within simple_service.configuration.parameters.file) supports the following:

• mount_path - Optional String
Path within the workload container at which the volume should be mounted. Must not contain ’:’

• sub_path - Optional String Defaults to '' (volume's root)
Path within the volume from which the workload’s volume should be mounted

Simple Service Container

A container block (within simple_service) supports the following:

• args - Optional List
Arguments to the entrypoint. Overrides the Docker image’s CMD

• command - Optional List
Command to execute. Overrides the Docker image’s ENTRYPOINT

• default_flavor - Optional Block
Configuration parameter for default flavor

• image - Optional Block
ImageType configures the image to use, how to pull the image, and the associated secrets to use if any
See Image below.

• init_container - Optional Bool
Specialized container that runs before application container and runs to completion

• name - Optional String
Name. Name of the container

Simple Service Container Custom Flavor

A custom_flavor block (within simple_service.container) supports the following:

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

Simple Service Container Image

An image block (within simple_service.container) supports the following:

• public - Optional Block
Enable this option

Simple Service Container Image Container Registry

A container_registry block (within simple_service.container.image) supports the following:

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

Simple Service Container Liveness Check

A liveness_check block (within simple_service.container) supports the following:

• http_health_check - Optional Block
HTTPHealthCheckType describes a health check based on HTTP GET requests
See HTTP Health Check below.

• initial_delay - Optional Number
Number of seconds after the container has started before health checks are initiated

• interval - Optional Number
Time interval in seconds between two health check requests

• tcp_health_check - Optional Block
TCPHealthCheckType describes a health check based on opening a TCP connection
See TCP Health Check below.

Simple Service Container Liveness Check Exec Health Check

Deeply nested Check block collapsed for readability.

Simple Service Container Liveness Check HTTP Health Check

Deeply nested Check block collapsed for readability.

Simple Service Container Liveness Check HTTP Health Check Port

Deeply nested Port block collapsed for readability.

Simple Service Container Liveness Check TCP Health Check

Deeply nested Check block collapsed for readability.

Simple Service Container Liveness Check TCP Health Check Port

Deeply nested Port block collapsed for readability.

Simple Service Container Readiness Check

A readiness_check block (within simple_service.container) supports the following:

• http_health_check - Optional Block
HTTPHealthCheckType describes a health check based on HTTP GET requests
See HTTP Health Check below.

• initial_delay - Optional Number
Number of seconds after the container has started before health checks are initiated

• interval - Optional Number
Time interval in seconds between two health check requests

• tcp_health_check - Optional Block
TCPHealthCheckType describes a health check based on opening a TCP connection
See TCP Health Check below.

Simple Service Container Readiness Check Exec Health Check

Deeply nested Check block collapsed for readability.

Simple Service Container Readiness Check HTTP Health Check

Deeply nested Check block collapsed for readability.

Simple Service Container Readiness Check HTTP Health Check Port

Deeply nested Port block collapsed for readability.

Simple Service Container Readiness Check TCP Health Check

Deeply nested Check block collapsed for readability.

Simple Service Container Readiness Check TCP Health Check Port

Deeply nested Port block collapsed for readability.

Simple Service Enabled

An enabled block (within simple_service) supports the following:

• name - Optional String
Name. Name of the volume

• persistent_volume - Optional Block
Volume containing the Persistent Storage for the workload
See Persistent Volume below.

Simple Service Enabled Persistent Volume

A persistent_volume block (within simple_service.enabled) supports the following:

• mount - Optional Block
Volume mount describes how volume is mounted inside a workload
See Mount below.

• storage - Optional Block
Persistent storage configuration is used to configure Persistent Volume Claim (PVC)
See Storage below.

Simple Service Enabled Persistent Volume Mount

A mount block (within simple_service.enabled.persistent_volume) supports the following:

• mount_path - Optional String
Path within the workload container at which the volume should be mounted. Must not contain ’:’

• sub_path - Optional String Defaults to '' (volume's root)
Path within the volume from which the workload’s volume should be mounted

Simple Service Enabled Persistent Volume Storage

A storage block (within simple_service.enabled.persistent_volume) supports the following:

• class_name - Optional String
Use the specified class name

• default - Optional Block
Enable this option

• storage_size - Optional Number
Size in GiB of the persistent storage

Simple Service Simple Advertise

A simple_advertise block (within simple_service) supports the following:

• domains - Optional List
List of Domains (host/authority header) that will be matched to Load Balancer. Wildcard hosts are supported in the suffix or prefix form Supported Domains and search order: 1. Exact Domain names: www.example.com. 2

• service_port - Optional Number
Service port to advertise on internet via HTTP loadbalancer using port 80

Stateful Service

A stateful_service block supports the following:

• advertise_options - Optional Block
Advertise OPTIONS are used to configure how and where to advertise the workload using load balancers
See Advertise Options below.

• configuration - Optional Block
Configuration parameters of the workload
See Configuration below.

• containers - Optional Block
Containers to use for service
See Containers below.

• deploy_options - Optional Block
Deploy OPTIONS are used to configure the workload deployment OPTIONS
See Deploy Options below.

• num_replicas - Optional Number
Number of replicas of service to spawn per site

• persistent_volumes - Optional Block
Persistent storage configuration for the service
See Persistent Volumes below.

• scale_to_zero - Optional Block
Configuration parameter for scale to zero

• volumes - Optional Block
Ephemeral Volumes. Ephemeral volumes for the service
See Volumes below.

Stateful Service Advertise Options

An advertise_options block (within stateful_service) supports the following:

• advertise_custom - Optional Block
Advertise this workload via loadbalancer on specific sites
See Advertise Custom below.

• advertise_in_cluster - Optional Block
Advertise the workload locally in-cluster
See Advertise In Cluster below.

• advertise_on_public - Optional Block
Advertise this workload via loadbalancer on internet with default VIP
See Advertise On Public below.

• do_not_advertise - Optional Block
Configuration parameter for do not advertise

Stateful Service Advertise Options Advertise Custom

An advertise_custom block (within stateful_service.advertise_options) supports the following:

• advertise_where - Optional Block
Where should this load balancer be available
See Advertise Where below.

• ports - Optional Block
Ports. Ports to advertise
See Ports below.

Stateful Service Advertise Options Advertise Custom Advertise Where

Deeply nested Where block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Advertise Where Site

Deeply nested Site block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Advertise Where Site Site

Deeply nested Site block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Advertise Where Virtual Site

Deeply nested Site block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Advertise Where Virtual Site Virtual Site

Deeply nested Site block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Advertise Where Vk8s Service

Deeply nested Service block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Advertise Where Vk8s Service Site

Deeply nested Site block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Advertise Where Vk8s Service Virtual Site

Deeply nested Site block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports

A ports block (within stateful_service.advertise_options.advertise_custom) supports the following:

• http_loadbalancer - Optional Block
Configuration parameter for HTTP loadbalancer
See HTTP Loadbalancer below.

• port - Optional Block
Port. Port of the workload
See Port below.

• tcp_loadbalancer - Optional Block
Configuration parameter for TCP loadbalancer
See TCP Loadbalancer below.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer

Deeply nested Loadbalancer block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Default Route

Deeply nested Route block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTP

Deeply nested HTTP block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS

Deeply nested HTTPS block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Coalescing Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS HTTP Protocol Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only

Deeply nested Only block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation

Deeply nested Transformation block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params

Deeply nested Params block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Certificates

Deeply nested Certificates block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config

Deeply nested Config block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS

Deeply nested mTLS block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters

Deeply nested Parameters block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates

Deeply nested Certificates block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Custom Hash Algorithms

Deeply nested Algorithms block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key

Deeply nested Key block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Clear Secret Info

Deeply nested Info block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config

Deeply nested Config block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS

Deeply nested mTLS block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert

Deeply nested Cert block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Coalescing Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only

Deeply nested Only block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation

Deeply nested Transformation block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config

Deeply nested Config block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS

Deeply nested mTLS block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes

Deeply nested Routes block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes

Deeply nested Routes block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object

Deeply nested Object block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object Route Ref

Deeply nested Ref block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route

Deeply nested Route block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Headers

Deeply nested Headers block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Incoming Port

Deeply nested Port block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Path

Deeply nested Path block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Route Direct Response

Deeply nested Response block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route

Deeply nested Route block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Headers

Deeply nested Headers block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Incoming Port

Deeply nested Port block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Path

Deeply nested Path block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Route Redirect

Deeply nested Redirect block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Simple Route

Deeply nested Route block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Simple Route Path

Deeply nested Path block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports Port

Deeply nested Port block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports Port Info

Deeply nested Info block collapsed for readability.

Stateful Service Advertise Options Advertise Custom Ports TCP Loadbalancer

Deeply nested Loadbalancer block collapsed for readability.

Stateful Service Advertise Options Advertise In Cluster

An advertise_in_cluster block (within stateful_service.advertise_options) supports the following:

• multi_ports - Optional Block
Multiple Ports. Multiple ports
See Multi Ports below.

• port - Optional Block
Port. Single port
See Port below.

Stateful Service Advertise Options Advertise In Cluster Multi Ports

Deeply nested Ports block collapsed for readability.

Stateful Service Advertise Options Advertise In Cluster Multi Ports Ports

Deeply nested Ports block collapsed for readability.

Stateful Service Advertise Options Advertise In Cluster Multi Ports Ports Info

Deeply nested Info block collapsed for readability.

Stateful Service Advertise Options Advertise In Cluster Port

Deeply nested Port block collapsed for readability.

Stateful Service Advertise Options Advertise In Cluster Port Info

Deeply nested Info block collapsed for readability.

Stateful Service Advertise Options Advertise On Public

An advertise_on_public block (within stateful_service.advertise_options) supports the following:

• multi_ports - Optional Block
Advertise Multiple Ports. Advertise multiple ports
See Multi Ports below.

• port - Optional Block
Advertise Port. Advertise single port
See Port below.

Stateful Service Advertise Options Advertise On Public Multi Ports

Deeply nested Ports block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports

Deeply nested Ports block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer

Deeply nested Loadbalancer block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Default Route

Deeply nested Route block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTP

Deeply nested HTTP block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS

Deeply nested HTTPS block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Coalescing Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS HTTP Protocol Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only

Deeply nested Only block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation

Deeply nested Transformation block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params

Deeply nested Params block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Certificates

Deeply nested Certificates block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config

Deeply nested Config block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS

Deeply nested mTLS block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters

Deeply nested Parameters block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates

Deeply nested Certificates block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Custom Hash Algorithms

Deeply nested Algorithms block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key

Deeply nested Key block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Clear Secret Info

Deeply nested Info block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config

Deeply nested Config block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS

Deeply nested mTLS block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert

Deeply nested Cert block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Coalescing Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only

Deeply nested Only block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation

Deeply nested Transformation block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config

Deeply nested Config block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS

Deeply nested mTLS block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes

Deeply nested Routes block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes

Deeply nested Routes block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object

Deeply nested Object block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object Route Ref

Deeply nested Ref block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route

Deeply nested Route block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Headers

Deeply nested Headers block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Incoming Port

Deeply nested Port block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Path

Deeply nested Path block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Route Direct Response

Deeply nested Response block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route

Deeply nested Route block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Headers

Deeply nested Headers block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Incoming Port

Deeply nested Port block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Path

Deeply nested Path block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Route Redirect

Deeply nested Redirect block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Simple Route

Deeply nested Route block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Simple Route Path

Deeply nested Path block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports Port

Deeply nested Port block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports Port Info

Deeply nested Info block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Multi Ports Ports TCP Loadbalancer

Deeply nested Loadbalancer block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port

Deeply nested Port block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer

Deeply nested Loadbalancer block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Default Route

Deeply nested Route block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTP

Deeply nested HTTP block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS

Deeply nested HTTPS block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Coalescing Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS HTTP Protocol Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only

Deeply nested Only block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation

Deeply nested Transformation block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params

Deeply nested Params block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Certificates

Deeply nested Certificates block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params TLS Config

Deeply nested Config block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS

Deeply nested mTLS block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters

Deeply nested Parameters block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates

Deeply nested Certificates block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Custom Hash Algorithms

Deeply nested Algorithms block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key

Deeply nested Key block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Blindfold Secret Info

Deeply nested Info block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Clear Secret Info

Deeply nested Info block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Config

Deeply nested Config block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS

Deeply nested mTLS block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert

Deeply nested Cert block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Coalescing Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only

Deeply nested Only block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation

Deeply nested Transformation block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert TLS Config

Deeply nested Config block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert TLS Config Custom Security

Deeply nested Security block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS

Deeply nested mTLS block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS CRL

Deeply nested CRL block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS Trusted CA

Deeply nested CA block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS Xfcc Options

Deeply nested Options block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes

Deeply nested Routes block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes

Deeply nested Routes block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Custom Route Object

Deeply nested Object block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Custom Route Object Route Ref

Deeply nested Ref block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route

Deeply nested Route block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Headers

Deeply nested Headers block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Incoming Port

Deeply nested Port block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Path

Deeply nested Path block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Route Direct Response

Deeply nested Response block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route

Deeply nested Route block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Headers

Deeply nested Headers block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Incoming Port

Deeply nested Port block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Path

Deeply nested Path block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Route Redirect

Deeply nested Redirect block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Simple Route

Deeply nested Route block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Simple Route Path

Deeply nested Path block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port Port

Deeply nested Port block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port Port Info

Deeply nested Info block collapsed for readability.

Stateful Service Advertise Options Advertise On Public Port TCP Loadbalancer

Deeply nested Loadbalancer block collapsed for readability.

Stateful Service Configuration

A configuration block (within stateful_service) supports the following:

• parameters - Optional Block
Parameters. Parameters for the workload
See Parameters below.

Stateful Service Configuration Parameters

A parameters block (within stateful_service.configuration) supports the following:

• env_var - Optional Block
Environment Variable. Environment Variable
See Env Var below.

• file - Optional Block
Configuration File. Configuration File for the workload
See File below.

Stateful Service Configuration Parameters Env Var

An env_var block (within stateful_service.configuration.parameters) supports the following:

• name - Optional String
Name. Name of Environment Variable

• value - Optional String
Value. Value of Environment Variable

Stateful Service Configuration Parameters File

A file block (within stateful_service.configuration.parameters) supports the following:

• data - Optional String
Data. File data

• mount - Optional Block
Volume mount describes how volume is mounted inside a workload
See Mount below.

• name - Optional String
Name. Name of the file

• volume_name - Optional String
Volume Name. Name of the Volume

Stateful Service Configuration Parameters File Mount

A mount block (within stateful_service.configuration.parameters.file) supports the following:

• mount_path - Optional String
Path within the workload container at which the volume should be mounted. Must not contain ’:’

• sub_path - Optional String Defaults to '' (volume's root)
Path within the volume from which the workload’s volume should be mounted

Stateful Service Containers

A containers block (within stateful_service) supports the following:

• args - Optional List
Arguments to the entrypoint. Overrides the Docker image’s CMD

• command - Optional List
Command to execute. Overrides the Docker image’s ENTRYPOINT

• default_flavor - Optional Block
Configuration parameter for default flavor

• image - Optional Block
ImageType configures the image to use, how to pull the image, and the associated secrets to use if any
See Image below.

• init_container - Optional Bool
Specialized container that runs before application container and runs to completion

• name - Optional String
Name. Name of the container

Stateful Service Containers Custom Flavor

A custom_flavor block (within stateful_service.containers) supports the following:

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

Stateful Service Containers Image

An image block (within stateful_service.containers) supports the following:

• public - Optional Block
Enable this option

Stateful Service Containers Image Container Registry

A container_registry block (within stateful_service.containers.image) supports the following:

• name - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name

• namespace - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace

• tenant - Optional String
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant

Stateful Service Containers Liveness Check

A liveness_check block (within stateful_service.containers) supports the following:

• http_health_check - Optional Block
HTTPHealthCheckType describes a health check based on HTTP GET requests
See HTTP Health Check below.

• initial_delay - Optional Number
Number of seconds after the container has started before health checks are initiated

• interval - Optional Number
Time interval in seconds between two health check requests

• tcp_health_check - Optional Block
TCPHealthCheckType describes a health check based on opening a TCP connection
See TCP Health Check below.

Stateful Service Containers Liveness Check Exec Health Check

Deeply nested Check block collapsed for readability.

Stateful Service Containers Liveness Check HTTP Health Check

Deeply nested Check block collapsed for readability.

Stateful Service Containers Liveness Check HTTP Health Check Port

Deeply nested Port block collapsed for readability.

Stateful Service Containers Liveness Check TCP Health Check

Deeply nested Check block collapsed for readability.

Stateful Service Containers Liveness Check TCP Health Check Port

Deeply nested Port block collapsed for readability.

Stateful Service Containers Readiness Check

A readiness_check block (within stateful_service.containers) supports the following:

• http_health_check - Optional Block
HTTPHealthCheckType describes a health check based on HTTP GET requests
See HTTP Health Check below.

• initial_delay - Optional Number
Number of seconds after the container has started before health checks are initiated

• interval - Optional Number
Time interval in seconds between two health check requests

• tcp_health_check - Optional Block
TCPHealthCheckType describes a health check based on opening a TCP connection
See TCP Health Check below.

Stateful Service Containers Readiness Check Exec Health Check

Deeply nested Check block collapsed for readability.

Stateful Service Containers Readiness Check HTTP Health Check

Deeply nested Check block collapsed for readability.

Stateful Service Containers Readiness Check HTTP Health Check Port

Deeply nested Port block collapsed for readability.

Stateful Service Containers Readiness Check TCP Health Check

Deeply nested Check block collapsed for readability.

Stateful Service Containers Readiness Check TCP Health Check Port

Deeply nested Port block collapsed for readability.

Stateful Service Deploy Options

A deploy_options block (within stateful_service) supports the following:

• all_res - Optional Block
Enable this option

• default_virtual_sites - Optional Block
Enable this option

• deploy_ce_sites - Optional Block
Defines a way to deploy a workload on specific Customer sites
See Deploy CE Sites below.

• deploy_ce_virtual_sites - Optional Block
Defines a way to deploy a workload on specific Customer virtual sites
See Deploy CE Virtual Sites below.

• deploy_re_sites - Optional Block
Defines a way to deploy a workload on specific Regional Edge sites
See Deploy RE Sites below.

• deploy_re_virtual_sites - Optional Block
Defines a way to deploy a workload on specific Regional Edge virtual sites
See Deploy RE Virtual Sites below.

Stateful Service Deploy Options Deploy CE Sites

A deploy_ce_sites block (within stateful_service.deploy_options) supports the following:

• site - Optional Block
Which customer sites should this workload be deployed
See Site below.

Stateful Service Deploy Options Deploy CE Sites Site

Deeply nested Site block collapsed for readability.

Stateful Service Deploy Options Deploy CE Virtual Sites

Deeply nested Sites block collapsed for readability.

Stateful Service Deploy Options Deploy CE Virtual Sites Virtual Site

Deeply nested Site block collapsed for readability.

Stateful Service Deploy Options Deploy RE Sites

A deploy_re_sites block (within stateful_service.deploy_options) supports the following:

• site - Optional Block
Which regional edge sites should this workload be deployed
See Site below.

Stateful Service Deploy Options Deploy RE Sites Site

Deeply nested Site block collapsed for readability.

Stateful Service Deploy Options Deploy RE Virtual Sites

Deeply nested Sites block collapsed for readability.

Stateful Service Deploy Options Deploy RE Virtual Sites Virtual Site

Deeply nested Site block collapsed for readability.

Stateful Service Persistent Volumes

A persistent_volumes block (within stateful_service) supports the following:

• name - Optional String
Name. Name of the volume

• persistent_volume - Optional Block
Volume containing the Persistent Storage for the workload
See Persistent Volume below.

Stateful Service Persistent Volumes Persistent Volume

A persistent_volume block (within stateful_service.persistent_volumes) supports the following:

• mount - Optional Block
Volume mount describes how volume is mounted inside a workload
See Mount below.

• storage - Optional Block
Persistent storage configuration is used to configure Persistent Volume Claim (PVC)
See Storage below.

Stateful Service Persistent Volumes Persistent Volume Mount

A mount block (within stateful_service.persistent_volumes.persistent_volume) supports the following:

• mount_path - Optional String
Path within the workload container at which the volume should be mounted. Must not contain ’:’

• sub_path - Optional String Defaults to '' (volume's root)
Path within the volume from which the workload’s volume should be mounted

Stateful Service Persistent Volumes Persistent Volume Storage

A storage block (within stateful_service.persistent_volumes.persistent_volume) supports the following:

• class_name - Optional String
Use the specified class name

• default - Optional Block
Enable this option

• storage_size - Optional Number
Size in GiB of the persistent storage

Stateful Service Volumes

A volumes block (within stateful_service) supports the following:

• empty_dir - Optional Block
Volume containing a temporary directory whose lifetime is the same as a replica of a workload
See Empty Dir below.

• host_path - Optional Block
Volume containing a host mapped path into the workload
See Host Path below.

• name - Optional String
Name. Name of the volume

Stateful Service Volumes Empty Dir

An empty_dir block (within stateful_service.volumes) supports the following:

• mount - Optional Block
Volume mount describes how volume is mounted inside a workload
See Mount below.

• size_limit - Optional Number
Size Limit (in GiB)

Stateful Service Volumes Empty Dir Mount

A mount block (within stateful_service.volumes.empty_dir) supports the following:

• mount_path - Optional String
Path within the workload container at which the volume should be mounted. Must not contain ’:’

• sub_path - Optional String Defaults to '' (volume's root)
Path within the volume from which the workload’s volume should be mounted

Stateful Service Volumes Host Path

A host_path block (within stateful_service.volumes) supports the following:

• mount - Optional Block
Volume mount describes how volume is mounted inside a workload
See Mount below.

• path - Optional String
Path of the directory on the host

Stateful Service Volumes Host Path Mount

A mount block (within stateful_service.volumes.host_path) supports the following:

• mount_path - Optional String
Path within the workload container at which the volume should be mounted. Must not contain ’:’

• sub_path - Optional String Defaults to '' (volume's root)
Path within the volume from which the workload’s volume should be mounted

Timeouts

A timeouts block supports the following:

• create - Optional String (Defaults to 10 minutes)
Used when creating the resource

• delete - Optional String (Defaults to 10 minutes)
Used when deleting the resource

• read - Optional String (Defaults to 5 minutes)
Used when retrieving the resource

• update - Optional String (Defaults to 10 minutes)
Used when updating the resource

Common Types

The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.

Object Reference {#common-object-reference}

Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format tenant/namespace/name.

Field	Type	Description
`name`	String	Name of the referenced object
`namespace`	String	Namespace containing the referenced object
`tenant`	String	Tenant of the referenced object (system-managed)

Transformers {#common-transformers}

Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.

Value	Description
`LOWER_CASE`	Convert to lowercase
`UPPER_CASE`	Convert to uppercase
`BASE64_DECODE`	Decodebase64 content
`NORMALIZE_PATH`	Normalize URL path
`REMOVE_WHITESPACE`	Remove whitespace characters
`URL_DECODE`	Decode URL-encoded characters
`TRIM_LEFT`	Trim leading whitespace
`TRIM_RIGHT`	Trim trailing whitespace
`TRIM`	Trim both leading and trailing whitespace

HTTP Methods {#common-http-methods}

HTTP methods used for request matching.

Value	Description
`ANY`	Match any HTTP method
`GET`	HTTP GET request
`HEAD`	HTTP HEAD request
`POST`	HTTP POST request
`PUT`	HTTP PUT request
`DELETE`	HTTP DELETE request
`CONNECT`	HTTP CONNECT request
`OPTIONS`	HTTP OPTIONS request
`TRACE`	HTTP TRACE request
`PATCH`	HTTP PATCH request
`COPY`	HTTP COPY request (WebDAV)

TLS Fingerprints {#common-tls-fingerprints}

TLS fingerprint categories for malicious client detection.

Value	Description
`TLS_FINGERPRINT_NONE`	No fingerprint matching
`ANY_MALICIOUS_FINGERPRINT`	Match any known malicious fingerprint
`ADWARE`	Adware-associated fingerprints
`DRIDEX`	Dridex malware fingerprints
`GOOTKIT`	Gootkit malware fingerprints
`RANSOMWARE`	Ransomware-associated fingerprints
`TRICKBOT`	Trickbot malware fingerprints

IP Threat Categories {#common-ip-threat-categories}

IP address threat categories for security filtering.

Value	Description
`SPAM_SOURCES`	Known spam sources
`WINDOWS_EXPLOITS`	Windows exploit sources
`WEB_ATTACKS`	Web attack sources
`BOTNETS`	Known botnet IPs
`SCANNERS`	Network scanner IPs
`REPUTATION`	Poor reputation IPs
`PHISHING`	Phishing-related IPs
`PROXY`	Anonymous proxy IPs
`MOBILE_THREATS`	Mobile threat sources
`TOR_PROXY`	Tor exit nodes
`DENIAL_OF_SERVICE`	DoS attack sources
`NETWORK`	Known bad network ranges

Import

Import is supported using the following syntax:

# Import using namespace/name format
terraform import f5xc_workload.example system/example