Service Defaults Configuration Reference

This topic describes how to configure service defaults configuration entries. The service defaults configuration entry contains common configuration settings for service mesh services, such as upstreams and gateways. Refer to Define service defaults for usage information.

Configuration model

The following outline shows how to format the service defaults configuration entry. Click on a property name to view details about the configuration.

Kind: string | required
Name: string | required
Namespace: string Enterprise
Partition: string Enterprise
Meta: map | no default
Protocol: string | default: tcp
BalanceInboundConnections: string | no default
Mode: string | no default
UpstreamConfig: map | no default
- Overrides: map | no default
  - Name: string | no default
  - Namespace: string | no default
  - Peer: string | no default
  - Protocol: string | no default
  - ConnectTimeoutMs: int | default: 5000
  - MeshGateway: map | no default
    - mode: string | no default
  - BalanceOutboundConnections: string | no default
  - Limits: map | optional
    - MaxConnections: integer | 0
    - MaxPendingRequests: integer | 0
    - MaxConcurrentRequests: integer | 0
  - PassiveHealthCheck: map | optional
    - Interval: string | 0s
    - MaxFailures: integer | 0
    - EnforcingConsecutive5xx: integer | 0
    - MaxEjectionPercent: integer | 0
    - BaseEjectionTime: string | 30s
- Defaults: map | no default
  - Protocol: string | no default
  - ConnectTimeoutMs: int | default: 5000
  - MeshGateway: map | no default
    - mode: string | no default
  - BalanceOutboundConnections: string | no default
  - Limits: map | optional
    - MaxConnections: integer | 0
    - MaxPendingRequests: integer | 0
    - MaxConcurrentRequests: integer | 0
  - PassiveHealthCheck: map | optional
    - Interval: string | 0s
    - MaxFailures: integer | 0
    - EnforcingConsecutive5xx: integer | 100
    - MaxEjectionPercent: integer | 0
    - BaseEjectionTime: string | 30s
TransparentProxy: map | no default
- OutboundListenerPort: integer | 15001
- DialedDirectly: boolean | false
EnvoyExtensions: list | no default
- Name: string | ""
- Required: string | ""
- Arguments: map | nil
Destination: map | no default
- Addresses: list | no default
- Port: integer | 0
MaxInboundConnections: integer | 0
LocalConnectTimeoutMs: integer | 0
LocalRequestTimeoutMs: integer | 0
MeshGateway: map | no default
- Mode: string | no default
ExternalSNI: string | no default
Expose: map | no default
- Checks: boolean | false
- Paths: list | no default
  - Path: string | no default
  - LocalPathPort: integer | 0
  - ListenerPort: integer | 0
  - Protocol: string | http

apiVersion: string | must be set to consul.hashicorp.com/v1alpha1
kind: string | no default
metadata: map | no default
- name: string | no default
- namespace: string | no default | Enterprise
spec: map | no default
- protocol: string | default: tcp
- balanceInboundConnections: string | no default
- mode: string | no default
- upstreamConfig: map | no default
  - overrides: list | no default
    - name: string | no default
    - namespace: string | no default
    - protocol: string | no default
    - connectTimeoutMs: int | default: 5000
    - meshGateway: map | no default
      - mode: string | no default
    - balanceOutboundConnections: string | no default
    - limits: map | optional
      - maxConnections: integer | 0
      - maxPendingRequests: integer | 0
      - maxConcurrentRequests: integer | 0
    - passiveHealthCheck: map | optional
      - interval: string | 0s
      - maxFailures: integer | 0
      - enforcingConsecutive5xx: integer | 100
      - maxEjectionPercent: integer | 10
      - baseEjectionTime: string | 30s
  - defaults: map | no default
    - protocol: string | no default
    - connectTimeoutMs: int | default: 5000
    - meshGateway: map | no default
      - mode: string | no default
    - balanceOutboundConnections: string | no default
    - limits: map | optional
      - maxConnections: integer | 0
      - maxPendingRequests: integer | 0
      - maxConcurrentRequests: integer | 0
    - passiveHealthCheck: map | optional
      - interval: string | 0s
      - maxFailures: integer | 0
      - enforcingConsecutive5xx: integer | 100
      - maxEjectionPercent: integer | 10
      - baseEjectionTime: string | 30s
- transparentProxy: map | no default
  - outboundListenerPort: integer | 15001
  - dialedDirectly: boolean | false
- envoyExtensions: list | no default
  - name: string | ""
  - required: string | ""
  - arguments: map | nil
- destination: map | no default
  - addresses: list | no default
  - port: integer | 0
- maxInboundConnections: integer | 0
- localConnectTimeoutMs: integer | 0
- localRequestTimeoutMs: integer | 0
- meshGateway: map | no default
  - mode: string | no default
- externalSNI: string | no default
- expose: map | no default
  - checks: boolean | false
  - paths: list | no default
    - path: string | no default
    - localPathPort: integer | 0
    - listenerPort: integer | 0
    - protocol: string | http

Complete configuration

When every field is defined, a service-defaults configuration entry has the following form:

Kind      = "service-defaults"
Name      = "service_name"
Namespace = "namespace"
Partition = "partition"
Meta = {
  Key = "value"
}
Protocol                  = "tcp"
BalanceInboundConnections = "exact_balance"
Mode                      = "transparent"
UpstreamConfig = {
  Overrides = {
    Name             = "name-of-upstreams-to-override"
    Namespace        = "namespace-containing-upstreams-to-override"
    Protocol         = "http"
    ConnectTimeoutMs = 100
    MeshGateway = {
      mode = "remote"
    }
    BalanceOutboundConnections = "exact_balance"
    Limits = {
      MaxConnections        = 10
      MaxPendingRequests    = 50
      MaxConcurrentRequests = 100
    }
    PassiveHealthCheck = {
      Interval                = "5s"
      MaxFailures             = 5
      EnforcingConsecutive5xx = 99
      MaxEjectionPercent      = 10
      BaseEjectionTime        = "30s"
    }
  }
  Defaults = {
    Protocol         = "http2"
    ConnectTimeoutMs = 2000
    MeshGateway = {
      mode = "local"
    }
    BalanceOutboundConnections = "exact_balance"
    Limits = {
      MaxConnections        = 100
      MaxPendingRequests    = 500
      MaxConcurrentRequests = 1000
    }
    PassiveHealthCheck = {
      Interval                = "1s"
      MaxFailures             = 1
      EnforcingConsecutive5xx = 89
      MaxEjectionPercent      = 10
      BaseEjectionTime        = "30s"
    }
  }
}
TransparentProxy = {
  OutboundListenerPort = 15002
  DialedDirectly       = true
}
Destination = {
  Addresses = [
    "First IP address",
    "Second IP address"
  ]
  Port = 88
}
MaxInboundConnections = 100
LocalConnectTimeoutMs = 10
LocalRequestTimeoutMs = 10
MeshGateway = {
  Mode = "remote"
}
ExternalSNI = "sni-server-host"
Expose = {
  Checks = true
  Paths = [
    {
      Path          = "/local/dir"
      LocalPathPort = 99
      LocalListenerPort = 98
      Protocol      = "http2"
    }
  ]
}

apiVersion: consul.hashicorp.com/v1alpha1
kind: ServiceDefaults
metadata:
  name: <name of the service you are configuring>
  namespace: <Consul Enterprise namespace>
spec:
  protocol: tcp
  balanceInboundConnections: exact_balance
  mode: transparent
  upstreamConfig:
    overrides:
    - name: <name of upstream>
      namespace: <namespace containing upstream - Consul Enterprise>
      protocol: <protocol for the upstream listener>
      connectTimeoutMs: 5000
      meshGateway:
        mode: <type of mesh gateway>
      balanceOutboundConnections: exact_balance
      limits:
        maxConnections: 0
        maxPendingRequests: 0
        maxConcurrentRequests: 0
      passiveHealthCheck:
        interval: "10s"
        maxFailures: 0
        enforcingConsecutive5xx: 100
        maxEjectionPercent: 10
        baseEjectionTime: "30s"
    defaults:
      protocol: <protocol for the upstream listener>
      connectTimeoutMs: 5000
      meshGateway:
        mode: <type of mesh gateway>
      balanceOutboundConnections: exact_balance
      limits:
        maxConnections: 0
        maxPendingRequests: 0
        maxConcurrentRequests: 0
      passiveHealthCheck:
        interval: "0s"
        maxFailures: 0
        enforcingConsecutive5xx: 100
        maxEjectionPercent: 10
        baseEjectionTime: "30s"
  transparentProxy:
    outboundListenerPort: 15001
    dialedDirectly: false
  destination:
    addresses:
    - <First hostname or IP address>
      <Second hostname or IP address>
    port:  0
  maxInboundConnections: 0
  meshGateway:
    mode: <type of mesh gateway>
  externalSNI: <name of TLS SNI outside o f the mesh>
  expose:
    checks: false
    paths:
    - path: <HTTP path to expose through Envoy>
      localPathPort: 0
      listenerPort: 0
      protocol: http

{
  "apiVersion": "consul.hashicorp.com/v1alpha1",
  "kind": "ServiceDefaults",
  "metadata": {
    "name": "<name of the service you are configuring>",
    "namespace": "<Consul Enterprise namespace>",
    "partition": "<Consul Enterprise admin partition>"
  },
  "spec": {
    "protocol": "tcp",
    "balanceInboundConnections": "exact_balance",
    "mode": "transparent",
    "upstreamConfig": {
      "overrides": [
        {
          "name": "<name of upstream>",
          "namespace": "<namespace containing upstream - Consul Enterprise>",
          "peer": "<peer name of the upstream service>",
          "protocol": "<protocol for the upstream listener>",
          "connectTimeoutMs": 5000,
          "meshGateway": {
            "mode": "<type of mesh gateway>"
          },
          "balanceOutboundConnections": "exact_balance",
          "limits": {
            "maxConnections": 0,
            "maxPendingRequests": 0,
            "maxConcurrentRequests": 0
          },
          "passiveHealthCheck": {
            "interval": "0s",
            "maxFailures": 0,
            "enforcingConsecutive5xx": 100,
            "maxEjectionPercent": 10,
            "baseEjectionTime": "30s",
          },
        }
      ],
      "defaults": {
        "protocol": "<protocol for the upstream listener>",
        "connectTimeoutMs": 5000,
        "meshGateway": {
          "mode": "<type of mesh gateway>"
        },
        "balanceOutboundConnections": "exact_balance",
        "limits": {
          "maxConnections": 0,
          "maxPendingRequests": 0,
          "maxConcurrentRequests": 0
        },
        "passiveHealthCheck": {
          "interval": "0s",
          "maxFailures": 0,
          "enforcingConsecutive5xx": 100,
          "maxEjectionPercent": 10,
          "baseEjectionTime": "30s",
        }
      }
    },
    "transparentProxy": {
      "outboundListenerPort": 15001,
      "dialedDirectly": false
    },
    "destination": {
      "addresses": [
        "<First hostname or IP address>",
        "<Second hostname or IP address>"
      ],
      "port": 0
    },
    "maxInboundConnections": 0,
    "meshGateway": {
      "mode": "<type of mesh gateway>"
    },
    "externalSNI": "<name of TLS SNI outside o f the mesh>",
    "expose": {
      "checks": false,
      "paths": [
        {
          "path": "<HTTP path to expose through Envoy>",
          "localPathPort": 0,
          "listenerPort": 0,
          "protocol": "http"
        }
      ]
    }
  }
}

Specification

This section provides details about the fields you can configure in the service defaults configuration entry.

`Kind`

Specifies the configuration entry type.

Values

Default: none
This field is required.
Data type: String value that must be set to service-defaults.

`Name`

Specifies the name of the service you are setting the defaults for.

Values

Default: none
This field is required.
Data type: string

`Namespace`

Specifies the Consul namespace that the configuration entry applies to.

Values

Default: default
Data type: string

`Partition`

Specifies the name of the Consul admin partition that the configuration entry applies to. Refer to Admin Partitions for additional information.

Values

Default: default
Data type: string

`Meta`

Specifies a set of custom key-value pairs to add to the Consul KV store.

Values

Default: none
Data type: Map of one or more key-value pairs.
- keys: string
- values: string, integer, or float

`Protocol`

Specifies the default protocol for the service. In service mesh use cases, the protocol configuration is required to enable the following features and components:

You can set the global protocol for proxies in the proxy-defaults configuration entry, but the protocol specified in the service-defaults configuration entry overrides the proxy-defaults configuration.

Values

Default: tcp
You can specify one of the following string values:
- tcp (default)
- http
- http2
- grpc

Refer to Set the default protocol for an example configuration.

`BalanceInboundConnections`

Specifies the strategy for allocating inbound connections to the service across Envoy proxy threads. The only supported value is exact_balance. By default, no connections are balanced. Refer to the Envoy documentation for details.

Values

Default: none
Data type: string

`Mode`

Specifies a mode for how the service directs inbound and outbound traffic.

Default: none
You can specify the following string values:
- direct: The proxy's listeners must be dialed directly by the local application and other proxies.
- transparent: The service captures inbound and outbound traffic and redirects it through the proxy. The mode does not enable the traffic redirection. It instructs Consul to configure Envoy as if traffic is already being redirected.

`UpstreamConfig`

Controls default upstream connection settings and custom overrides for individual upstream services. If your network contains federated datacenters, individual upstream configurations apply to all pairs of source and upstream destination services in the network. Refer to the following fields for details:

Values

Default: none
Data type: map

`UpstreamConfig.Overrides[]`

Specifies options that override the default upstream configurations for individual upstreams.

Values

Default: none
Data type: list

`UpstreamConfig.Overrides[].Name`

Specifies the name of the upstream service that the configuration applies to. We recommend that you do not use the * wildcard to avoid applying the configuration to unintended upstreams.

Values

Default: none
Data type: string

`UpstreamConfig.Overrides[].Namespace`

Specifies the namespace containing the upstream service that the configuration applies to. Do not use the * wildcard to prevent the configuration from appling to unintended upstreams.

Values

Default: none
Data type: string

`UpstreamConfig.Overrides[].Protocol`

Specifies the protocol to use for requests to the upstream listener.

We recommend configuring the protocol in the main Protocol field of the configuration entry so that you can leverage L7 features. Setting the protocol in an upstream configuration limits L7 management functionality.

Values

Default: none
Data type: string

`UpstreamConfig.Overrides[].ConnectTimeoutMs`

Specifies how long in milliseconds that the service should attempt to establish an upstream connection before timing out.

We recommend configuring the upstream timeout in the connection_timeout field of the service-resolver configuration entry for the upstream destination service. Doing so enables you to leverage L7 features. Configuring the timeout in the service-defaults upstream configuration limits L7 management functionality.

Values

Default: 5000
Data type: integer

`UpstreamConfig.Overrides[].MeshGateway`

Map that contains the default mesh gateway mode field for the upstream. Refer to Service Mesh Proxy Configuration in the mesh gateway documentation for additional information.

Values

Default: none
You can specify the following string values for the mode field:
- none: The service does not make outbound connections through a mesh gateway. Instead, the service makes outbound connections directly to the destination services.
- local: The service mesh proxy makes an outbound connection to a gateway running in the same datacenter.
- remote: The service mesh proxy makes an outbound connection to a gateway running in the destination datacenter.

`UpstreamConfig.Overrides[].BalanceOutboundConnections`

Sets the strategy for allocating outbound connections from the upstream across Envoy proxy threads.

Values

The only supported value is exact_balance. By default, no connections are balanced. Refer to the Envoy documentation for details.

Default: none
Data type: string

`UpstreamConfig.Overrides[].Limits`

Map that specifies a set of limits to apply to when connecting to individual upstream services.

Values

The following table describes limits you can configure:

Limit	Description	Data type	Default
`MaxConnections`	Specifies the maximum number of connections a service instance can establish against the upstream. Define this limit for HTTP/1.1 traffic.	integer	`0`
`MaxPendingRequests`	Specifies the maximum number of requests that are queued while waiting for a connection to establish. An L7 protocol must be defined in the `protocol` field for this limit to take effect.	integer	`0`
`MaxConcurrentRequests`	Specifies the maximum number of concurrent requests. Define this limit for HTTP/2 traffic. An L7 protocol must be defined in the `protocol` field for this limit to take effect.	integer	`0`

Refer to the upstream configuration example for additional guidance.

`UpstreamConfig.Overrides[].PassiveHealthCheck`

Map that specifies a set of rules that enable Consul to remove hosts from the upstream cluster that are unreachable or that return errors.

Values

The following table describes passive health check parameters you can configure:

Limit	Description	Data type	Default
`Interval`	Specifies the time between checks.	string	`0s`
`MaxFailures`	Specifies the number of consecutive failures allowed per check interval. If exceeded, Consul removes the host from the load balancer.	integer	`0`
`EnforcingConsecutive5xx`	Specifies a percentage that indicates how many times out of 100 that Consul ejects the host when it detects an outlier status. The outlier status is determined by consecutive errors in the 500-599 response range.	integer	`100`
`MaxEjectionPercent`	Specifies the maximum percentage of an upstream cluster that Consul ejects when the proxy reports an outlier. Consul ejects at least one host when an outlier is detected regardless of the value.	integer	`10`
`BaseEjectionTime`	Specifies the minimum amount of time that an ejected host must remain outside the cluster before rejoining. The real time is equal to the value of the `BaseEjectionTime` multiplied by the number of times the host has been ejected.	string	`30s`

`UpstreamConfig.Defaults`

Specifies configurations that set default upstream settings. For information about overriding the default configurations for in for individual upstreams, refer to UpstreamConfig.Overrides.

Values

Default: none
Data type: map

`UpstreamConfig.Defaults.Protocol`

Specifies default protocol for upstream listeners.

Default: none
Data type: string

`UpstreamConfig.Defaults.ConnectTimeoutMs`

Specifies how long in milliseconds that all services should continue attempting to establish an upstream connection before timing out.

For non-Kubernetes environments, we recommend configuring the upstream timeout in the connection_timeout field of the service-resolver configuration entry for the upstream destination service. Doing so enables you to leverage L7 features. Configuring the timeout in the service-defaults upstream configuration limits L7 management functionality.

Default: 5000
Data type: integer

`UpstreamConfig.Defaults.MeshGateway`

Specifies the default mesh gateway mode field for all upstreams. Refer to Service Mesh Proxy Configuration in the mesh gateway documentation for additional information.

You can specify the following string values for the mode field:

none: The service does not make outbound connections through a mesh gateway. Instead, the service makes outbound connections directly to the destination services.
local: The service mesh proxy makes an outbound connection to a gateway running in the same datacenter.
remote: The service mesh proxy makes an outbound connection to a gateway running in the destination datacenter.

`UpstreamConfig.Defaults.BalanceOutboundConnections`

Sets the strategy for allocating outbound connections from upstreams across Envoy proxy threads. The only supported value is exact_balance. By default, no connections are balanced. Refer to the Envoy documentation for details.

Default: none
Data type: string

`UpstreamConfig.Defaults.Limits`

Map that specifies a set of limits to apply to when connecting upstream services. The following table describes limits you can configure:

Limit	Description	Data type	Default
`MaxConnections`	Specifies the maximum number of connections a service instance can establish against the upstream. Define this limit for HTTP/1.1 traffic.	integer	`0`
`MaxPendingRequests`	Specifies the maximum number of requests that are queued while waiting for a connection to establish. An L7 protocol must be defined in the `protocol` field for this limit to take effect.	integer	`0`
`MaxConcurrentRequests`	Specifies the maximum number of concurrent requests. Define this limit for HTTP/2 traffic. An L7 protocol must be defined in the `protocol` field for this limit to take effect.	integer	`0`

`UpstreamConfig.Defaults.PassiveHealthCheck`

Map that specifies a set of rules that enable Consul to remove hosts from the upstream cluster that are unreachable or that return errors. The following table describes the health check parameters you can configure:

Limit	Description	Data type	Default
`Interval`	Specifies the time between checks.	string	`0s`
`MaxFailures`	Specifies the number of consecutive failures allowed per check interval. If exceeded, Consul removes the host from the load balancer.	integer	`0`
`EnforcingConsecutive5xx`	Specifies a percentage that indicates how many times out of 100 that Consul ejects the host when it detects an outlier status. The outlier status is determined by consecutive errors in the 500-599 response range.	integer	`100`
`MaxEjectionPercent`	Specifies the maximum percentage of an upstream cluster that Consul ejects when the proxy reports an outlier. Consul ejects at least one host when an outlier is detected regardless of the value.	integer	`10`
`BaseEjectionTime`	Specifies the minimum amount of time that an ejected host must remain outside the cluster before rejoining. The real time is equal to the value of the `BaseEjectionTime` multiplied by the number of times the host has been ejected.	string	`30s`

`TransparentProxy`

Controls configurations specific to proxies in transparent mode. Refer to Transparent Proxy for additional information.

You can configure the following parameters in the TransparentProxy block:

Parameter	Description	Data type	Default
`OutboundListenerPort`	Specifies the port that the proxy listens on for outbound traffic. This must be the same port number where outbound application traffic is redirected.	integer	`15001`
`DialedDirectly`	Enables transparent proxies to dial the proxy instance's IP address directly when set to `true`. Transparent proxies commonly dial upstreams at the `"virtual"` tagged address, which load balances across instances. Dialing individual instances can be helpful for stateful services, such as a database cluster with a leader.	boolean	`false`

`EnvoyExtensions`

List of extensions to modify Envoy proxy configuration. Refer to Envoy Extensions for additional information.

You can configure the following parameters in the EnvoyExtensions block:

Parameter	Description	Data type	Default
`Name`	Name of the extension.	string	`""`
`Required`	When Required is true and the extension does not update any Envoy resources, an error is returned. Use this parameter to ensure that extensions required for secure communication are not unintentionally bypassed.	string	`""`
`Arguments`	Arguments to pass to the extension executable.	map	`nil`

`Destination[]`

Configures the destination for service traffic through terminating gateways. Refer to Terminating Gateway for additional information.

You can configure the following parameters in the Destination block:

Parameter	Description	Data type	Default
`Address`	Specifies a list of addresses for the destination. You can configure a list of hostnames and IP addresses. Wildcards are not supported.	list	none
`Port`	Specifies the port number of the destination.	integer	`0`

`MaxInboundConnections`

Specifies the maximum number of concurrent inbound connections to each service instance.

Default: 0
Data type: integer

`LocalConnectTimeoutMs`

Specifies the number of milliseconds allowed for establishing connections to the local application instance before timing out.

Default: 5000
Data type: integer

`LocalRequestTimeoutMs`

Specifies the timeout for HTTP requests to the local application instance. Applies to HTTP-based protocols only. If not specified, inherits the Envoy default for route timeouts.

Default: Inherits 15s from Envoy as the default
Data type: string

`MeshGateway`

Specifies the default mesh gateway mode field for the service. Refer to Service Mesh Proxy Configuration in the mesh gateway documentation for additional information.

You can specify the following string values for the mode field:

none: The service does not make outbound connections through a mesh gateway. Instead, the service makes outbound connections directly to the destination services.
local: The service mesh proxy makes an outbound connection to a gateway running in the same datacenter.
remote: The service mesh proxy makes an outbound connection to a gateway running in the destination datacenter.

`ExternalSNI`

Specifies the TLS server name indication (SNI) when federating with an external system.

Default: none
Data type: string

`Expose`

Specifies default configurations for exposing HTTP paths through Envoy. Exposing paths through Envoy enables services to listen on localhost only. Applications that are not Consul service mesh-enabled can still contact an HTTP endpoint. Refer to Expose Paths Configuration Reference for additional information and example configurations.

Default: none
Data type: map

`Expose.Checks`

Exposes all HTTP and gRPC checks registered with the agent if set to true. Envoy exposes listeners for the checks and only accepts connections originating from localhost or Consul's advertise_addr. The ports for the listeners are dynamically allocated from the agent's expose_min_port and expose_max_port configurations.

We recommend enabling the Checks configuration when a Consul client cannot reach registered services over localhost, such as when Consul agents run in their own pods in Kubernetes.

Default: false
Data type: boolean

`Expose.Paths[]`

Specifies a list of configuration maps that define paths to expose through Envoy when Expose.Checks is set to true. You can configure the following parameters for each map in the list:

Parameter	Description	Data type	Default
`Path`	Specifies the HTTP path to expose. You must prepend the path with a forward slash (`/`).	string	none
`LocalPathPort`	Specifies the port where the local service listens for connections to the path.	integer	`0`
`ListenPort`	Specifies the port where the proxy listens for connections. The port must be available. If the port is unavailable, Envoy does not expose a listener for the path and the proxy registration still succeeds.	integer	`0`
`Protocol`	Specifies the protocol of the listener. You can configure one of the following values: `http` `http2`: Use with gRPC traffic	integer	`http`

`apiVersion`

Specifies the version of the Consul API for integrating with Kubernetes. The value must be consul.hashicorp.com/v1alpha1. The apiVersion field is not supported for non-Kubernetes deployments.

Default: none
This field is required.
String value that must be set to consul.hashicorp.com/v1alpha1.

`kind`

Specifies the configuration entry type. Must be ServiceDefaults.

Required: required
String value that must be set to ServiceDefaults.

`metadata`

Map that contains the service name, namespace, and admin partition that the configuration entry applies to.

Values

Default: none
Map containing the following strings:

`metadata.name`

Specifies the name of the service you are setting the defaults for.

Values

Default: none
This field is required
Data type: string

`metadata.namespace`

Specifies the Consul namespace that the configuration entry applies to. Refer to Consul Enterprise for information about how Consul namespaces map to Kubernetes Namespaces. Open source Consul distributions (Consul OSS) ignore the metadata.namespace configuration.

Default: default
Data type: string

`spec`

Map that contains the details about the ServiceDefaults configuration entry. The apiVersion, kind, and metadata fields are siblings of the spec field. All other configurations are children.

`spec.protocol`

Specifies the default protocol for the service. In service service mesh use cases, the protocol configuration is required to enable the following features and components:

You can set the global protocol for proxies in the ProxyDefaults configuration entry, but the protocol specified in the ServiceDefaults configuration entry overrides the ProxyDefaults configuration.

Values

Default: tcp
You can specify one of the following string values:

Refer to Set the default protocol for an example configuration.

`spec.balanceInboundConnections`

Values

Default: none
Data type: string

`spec.mode`

Specifies a mode for how the service directs inbound and outbound traffic.

Values

Default: none
Required: optional
You can specified the following string values:
direct: The proxy's listeners must be dialed directly by the local application and other proxies.
transparent: The service captures inbound and outbound traffic and redirects it through the proxy. The mode does not enable the traffic redirection. It instructs Consul to configure Envoy as if traffic is already being redirected.

`spec.upstreamConfig`

Specifies a map that controls default upstream connection settings and custom overrides for individual upstream services. If your network contains federated datacenters, individual upstream configurations apply to all pairs of source and upstream destination services in the network.

Values

Default: none
Map that contains the following configurations:
- UpstreamConfig.Overrides
- UpstreamConfig.Defaults

`spec.upstreamConfig.overrides[]`

Specifies options that override the default upstream configurations for individual upstreams.

Values

Default: none
Data type: list

`spec.upstreamConfig.overrides[].name`

Specifies the name of the upstream service that the configuration applies to. Do not use the * wildcard to prevent the configuration from applying to unintended upstreams.

Values

Default: none
Data type: string

`spec.upstreamConfig.overrides[].namespace`

Specifies the namespace containing the upstream service that the configuration applies to. Do not use the * wildcard to prevent the configuration from applying to unintended upstreams.

Values

Default: none
Data type: string

`spec.upstreamConfig.overrides[].protocol`

Specifies the protocol to use for requests to the upstream listener. We recommend configuring the protocol in the main protocol field of the configuration entry so that you can leverage L7 features. Setting the protocol in an upstream configuration limits L7 management functionality.

Values

Default: inherits the main protocol configuration
Data type: string

`spec.upstreamConfig.overrides[].connectTimeoutMs`

Specifies how long in milliseconds that the service should attempt to establish an upstream connection before timing out.

We recommend configuring the upstream timeout in the connectTimeout field of the ServiceResolver CRD for the upstream destination service. Doing so enables you to leverage L7 features. Configuring the timeout in the ServiceDefaults upstream configuration limits L7 management functionality.

Values

Default: 5000
Data type: integer

`spec.upstreamConfig.overrides[].meshGateway.mode`

Map that contains the default mesh gateway mode field for the upstream. Refer to Connect Proxy Configuration in the mesh gateway documentation for additional information.

Values

You can specify the following string values for the mode field:

none: The service does not make outbound connections through a mesh gateway. Instead, the service makes outbound connections directly to the destination services.
local: The service mesh proxy makes an outbound connection to a gateway running in the same datacenter.
remote: The service mesh proxy makes an outbound connection to a gateway running in the destination datacenter.

`spec.upstreamConfig.overrides[].balanceInboundConnections`

Sets the strategy for allocating outbound connections from the upstream across Envoy proxy threads. The only supported value is exact_balance. By default, no connections are balanced. Refer to the Envoy documentation for details.

Values

Default: none
Data type: string

`spec.upstreamConfig.overrides[].limits`

Map that specifies a set of limits to apply to when connecting to individual upstream services.

Values

The following table describes limits you can configure:

Limit	Description	Data type	Default
`maxConnections`	Specifies the maximum number of connections a service instance can establish against the upstream. Define this limit for HTTP/1.1 traffic.	integer	`0`
`maxPendingRequests`	Specifies the maximum number of requests that are queued while waiting for a connection to establish. An L7 protocol must be defined in the `protocol` field for this limit to take effect.	integer	`0`
`maxConcurrentRequests`	Specifies the maximum number of concurrent requests. Define this limit for HTTP/2 traffic. An L7 protocol must be defined in the `protocol` field for this limit to take effect.	integer	`0`

`spec.upstreamConfig.overrides[].passiveHealthCheck`

Map that specifies a set of rules that enable Consul to remove hosts from the upstream cluster that are unreachable or that return errors.

Values

The following table describes passive health check parameters you can configure:

Limit	Description	Data type	Default
`interval`	Specifies the time between checks.	string	`0s`
`maxFailures`	Specifies the number of consecutive failures allowed per check interval. If exceeded, Consul removes the host from the load balancer.	integer	`0`
`enforcingConsecutive5xx`	Specifies a percentage that indicates how many times out of 100 that Consul ejects the host when it detects an outlier status. The outlier status is determined by consecutive errors in the 500-599 response range.	integer	`100`
`maxEjectionPercent`	The maximum % of an upstream cluster that can be ejected due to outlier detection. Defaults to 10% but will eject at least one host regardless of the value.	integer	`10`
`baseEjectionTime`	The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected and is capped by max_ejection_time (Default 300s). Defaults to 30000ms or 30s.	string	`30s`

`spec.upstreamConfig.defaults`

Map of configurations that set default upstream configurations for the service. For information about overriding the default configurations for in for individual upstreams, refer to spec.upstreamConfig.overrides.

Values

Default: none
Data type: list

`spec.upstreamConfig.defaults.protocol`

Specifies default protocol for upstream listeners. We recommend configuring the protocol in the main Protocol field of the configuration entry so that you can leverage L7 features. Setting the protocol in an upstream configuration limits L7 management functionality.

Values

Default: none
Data type: string

`spec.upstreamConfig.default.connectTimeoutMs`

Specifies how long in milliseconds that all services should continue attempting to establish an upstream connection before timing out.

We recommend configuring the upstream timeout in the connectTimeout field of the ServiceResolver CRD for upstream destination services. Doing so enables you to leverage L7 features. Configuring the timeout in the ServiceDefaults upstream configuration limits L7 management functionality.

Values

Default: 5000
Data type: integer

`spec.upstreamConfig.defaults.meshGateway.mode`

Specifies the default mesh gateway mode field for all upstreams. Refer to Service Mesh Proxy Configuration in the mesh gateway documentation for additional information.

Values

You can specify the following string values for the mode field:

none: The service does not make outbound connections through a mesh gateway. Instead, the service makes outbound connections directly to the destination services.
local: The service mesh proxy makes an outbound connection to a gateway running in the same datacenter.
remote: The service mesh proxy makes an outbound connection to a gateway running in the destination datacenter.

`spec.upstreamConfig.defaults.balanceInboundConnections`

Values

Default: none
Data type: string

`spec.upstreamConfig.defaults.limits`

Map that specifies a set of limits to apply to when connecting upstream services.

Values

The following table describes limits you can configure:

Limit	Description	Data type	Default
`maxConnections`	Specifies the maximum number of connections a service instance can establish against the upstream. Define this limit for HTTP/1.1 traffic.	integer	`0`
`maxPendingRequests`	Specifies the maximum number of requests that are queued while waiting for a connection to establish. An L7 protocol must be defined in the `protocol` field for this limit to take effect.	integer	`0`
`maxConcurrentRequests`	Specifies the maximum number of concurrent requests. Define this limit for HTTP/2 traffic. An L7 protocol must be defined in the `protocol` field for this limit to take effect.	integer	`0`

`spec.upstreamConfig.defaults.passiveHealthCheck`

Map that specifies a set of rules that enable Consul to remove hosts from the upstream cluster that are unreachable or that return errors.

Values

The following table describes the health check parameters you can configure:

Limit	Description	Data type	Default
`interval`	Specifies the time between checks.	string	`0s`
`maxFailures`	Specifies the number of consecutive failures allowed per check interval. If exceeded, Consul removes the host from the load balancer.	integer	`0`
`enforcingConsecutive5xx`	Specifies a percentage that indicates how many times out of 100 that Consul ejects the host when it detects an outlier status. The outlier status is determined by consecutive errors in the 500-599 response range.	integer	`100`
`MaxEjectionPercent`	Specifies the maximum percentage of an upstream cluster that Consul ejects when the proxy reports an outlier. Consul ejects at least one host when an outlier is detected regardless of the value.	integer	`10`
`BaseEjectionTime`	Specifies the minimum amount of time that an ejected host must remain outside the cluster before rejoining. The real time is equal to the value of the `BaseEjectionTime` multiplied by the number of times the host has been ejected.	string	`30s`

`spec.transparentProxy`

Map of configurations specific to proxies in transparent mode. Refer to Transparent Proxy for additional information.

Values

You can configure the following parameters in the TransparentProxy block:

Parameter	Description	Data type	Default
`outboundListenerPort`	Specifies the port that the proxy listens on for outbound traffic. This must be the same port number where outbound application traffic is redirected.	integer	`15001`
`dialedDirectly`	Enables transparent proxies to dial the proxy instance's IP address directly when set to `true`. Transparent proxies commonly dial upstreams at the `"virtual"` tagged address, which load balances across instances. Dialing individual instances can be helpful for stateful services, such as a database cluster with a leader.	boolean	`false`

`spec.envoyExtensions`

List of extensions to modify Envoy proxy configuration. Refer to Envoy Extensions for additional information.

Values

You can configure the following parameters in the EnvoyExtensions block:

Parameter	Description	Data type	Default
`name`	Name of the extension.	string	`""`
`required`	When Required is true and the extension does not update any Envoy resources, an error is returned. Use this parameter to ensure that extensions required for secure communication are not unintentionally bypassed.	string	`""`
`arguments`	Arguments to pass to the extension executable.	map	`nil`

`spec.destination`

Map of configurations that specify one or more destinations for service traffic routed through terminating gateways. Refer to Terminating Gateway for additional information.

Values

You can configure the following parameters in the Destination block:

Parameter	Description	Data type	Default
`address`	Specifies a list of addresses for the destination. You can configure a list of hostnames and IP addresses. Wildcards are not supported.	list	none
`port`	Specifies the port number of the destination.	integer	`0`

`spec.maxInboundConnections`

Specifies the maximum number of concurrent inbound connections to each service instance.

Values

Default: 0
Data type: integer

`spec.localConnectTimeoutMs`

Specifies the number of milliseconds allowed for establishing connections to the local application instance before timing out.

Values

Default: 5000
Data type: integer

`spec.localRequestTimeoutMs`

Specifies the timeout for HTTP requests to the local application instance. Applies to HTTP-based protocols only. If not specified, inherits the Envoy default for route timeouts.

Values

Default of 15s is inherited from Envoy
Data type: string

`spec.meshGateway.mode`

Specifies the default mesh gateway mode field for the service. Refer to Service Mesh Proxy Configuration in the mesh gateway documentation for additional information.

Values

You can specify the following string values for the mode field:

none: The service does not make outbound connections through a mesh gateway. Instead, the service makes outbound connections directly to the destination services.
local: The service mesh proxy makes an outbound connection to a gateway running in the same datacenter.
remote: The service mesh proxy makes an outbound connection to a gateway running in the destination datacenter.

`spec.externalSNI`

Specifies the TLS server name indication (SNI) when federating with an external system.

Values

Default: none
Data type: string

`spec.expose`

Specifies default configurations for exposing HTTP paths through Envoy. Exposing paths through Envoy enables services to listen on localhost only. Applications that are not Consul service mesh-enabled can still contact an HTTP endpoint. Refer to Expose Paths Configuration Reference for additional information and example configurations.

Values

Default: none
Data type: string

`spec.expose.checks`

We recommend enabling the Checks configuration when a Consul client cannot reach registered services over localhost, such as when Consul agents run in their own pods in Kubernetes.

Values

Default: false
Data type: boolean

`spec.expose.paths[]`

Specifies an list of maps that define paths to expose through Envoy when spec.expose.checks is set to true.

Values

The following table describes the parameters for each map:

Parameter	Description	Data type	Default
`path`	Specifies the HTTP path to expose. You must prepend the path with a forward slash (`/`).	string	none
`localPathPort`	Specifies the port where the local service listens for connections to the path.	integer	`0`
`listenPort`	Specifies the port where the proxy listens for connections. The port must be available. If the port is unavailable, Envoy does not expose a listener for the path and the proxy registration still succeeds.	integer	`0`
`protocol`	Specifies the protocol of the listener. You can configure one of the following values: `http` `http2`: Use with gRPC traffic	integer	`http`

Example configurations

The following examples describe common service-defaults configurations.

Set the default protocol

In the following example, protocol for the web service in the default namespace is set to http:

Kind      = "service-defaults"
Name      = "web"
Namespace = "default"
Protocol  = "http"

You can also set the global default protocol for all proxies in the proxy-defaults configuration entry, but the protocol specified for individual service instances in the service-defaults configuration entry takes precedence over the globally-configured value set in the proxy-defaults.

Upstream configuration

The following example sets default connection limits and mesh gateway mode across all upstreams of the dashboard service. It also overrides the mesh gateway mode used when dialing its counting upstream service.

Kind = "service-defaults"
Name = "dashboard"

UpstreamConfig = {
  Defaults = {
    MeshGateway = {
      Mode = "local"
    }
    Limits = {
      MaxConnections = 512
      MaxPendingRequests = 512
      MaxConcurrentRequests = 512
    }
  }

  Overrides = [
    {
      Name = "counting"
      MeshGateway = {
        Mode = "remote"
      }
    }
  ]
}

apiVersion: consul.hashicorp.com/v1alpha1
kind: ServiceDefaults
metadata:
  name: dashboard
spec:
  upstreamConfig:
    defaults:
      meshGateway:
        mode: local
      limits:
        maxConnections: 512
        maxPendingRequests: 512
        maxConcurrentRequests: 512
    overrides:
      - name: counting
        meshGateway:
          mode: remote

{
  "Kind": "service-defaults",
  "Name": "dashboard",
  "UpstreamConfig": {
    "Defaults": {
      "MeshGateway": {
        "Mode": "local"
      },
      "Limits": {
        "MaxConnections": 512,
        "MaxPendingRequests": 512,
        "MaxConcurrentRequests": 512
      }
    },
    "Overrides": [
      {
        "Name": "counting",
        "MeshGateway": {
          "Mode": "remote"
        }
      }
    ]
  }
}

The following example configures the default connection limits and mesh gateway mode for all of the counting service's upstreams. It also overrides the mesh gateway mode used when dialing the dashboard service in the frontend namespace.

Kind = "service-defaults"
Name = "dashboard"
Namespace = "product"

UpstreamConfig = {
  Defaults = {
    MeshGateway = {
      Mode = "local"
    }
    Limits = {
      MaxConnections = 512
      MaxPendingRequests = 512
      MaxConcurrentRequests = 512
    }
  }

  Overrides = [
    {
      Name = "counting"
      Namespace = "backend"
      MeshGateway = {
        Mode = "remote"
      }
    }
  ]
}

apiVersion: consul.hashicorp.com/v1alpha1
kind: ServiceDefaults
metadata:
  name: dashboard
  namespace: product
spec:
  upstreamConfig:
    defaults:
      meshGateway:
        mode: local
      limits:
        maxConnections: 512
        maxPendingRequests: 512
        maxConcurrentRequests: 512
    overrides:
      - name: counting
        namespace: backend
        meshGateway:
          mode: remote

{
  "Kind": "service-defaults",
  "Name": "dashboard",
  "Namespace": "product",
  "UpstreamConfig": {
    "Defaults": {
      "MeshGateway": {
        "Mode": "local"
      },
      "Limits": {
        "MaxConnections": 512,
        "MaxPendingRequests": 512,
        "MaxConcurrentRequests": 512
      }
    },
    "Overrides": [
      {
        "Name": "counting",
        "Namespace": "backend",
        "MeshGateway": {
          "Mode": "remote"
        }
      }
    ]
  }
}

Terminating gateway destination

The following examples creates a default destination assigned to a terminating gateway. A destination represents a location outside the Consul cluster. Services can dial destinations dialed directly when transparent proxy mode is enabled.

Kind = "service-defaults"
Name = "test-destination"
Protocol = "tcp"
Destination {
  Addresses = ["test.com","test.org"]
  Port = 443
}

apiVersion: consul.hashicorp.com/v1alpha1
kind: ServiceDefaults
metadata:
  name: test-destination
spec:
  protocol: tcp
  destination:
    addresses:
      - "test.com"
      - "test.org"
    port: 443