luxolus/open-consul
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity
open-consul/website/source/docs/agent/config-entries/service-defaults.html.md

1.8 KiB
Raw Blame History

layout page_title sidebar_current description
docs Configuration Entry Kind: Service Defaults docs-agent-cfg_entries-service_defaults The service-defaults config entry kind controls default global values for a service, such as its protocol.

Service Defaults

The service-defaults config entry kind controls default global values for a service, such as its protocol.

Sample Config Entries

Set the default protocol for a service to HTTP:

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

Available Fields

  • Kind - Must be set to service-defaults

  • Name (string: <required>) - Set to the name of the service being configured.

  • Protocol (string: "tcp") - Sets the protocol of the service. This is used by Connect proxies for things like observability features and to unlock usage of the service-splitter and service-router config entries for a service.

  • MeshGateway (MeshGatewayConfig: <optional>) - Controls the default mesh gateway configuration for this service. Added in v1.6.0.

    • Mode (string: "") - One of none, local, or remote.

  • ExternalSNI (string: "") - This is an optional setting that allows for the TLS SNI value to be changed to a non-connect value when federating with an external system. Added in v1.6.0.

ACLs

Configuration entries may be protected by ACLs.

Reading a service-defaults config entry requires service:read on itself.

Creating, updating, or deleting a service-defaults config entry requires service:write on itself.