Consul server configuration JSON schema reference

This topic provides reference information about the JSON schema used to build the config.tf file. Refer to Configure Consul server settings for information about how Consul on ECS uses the JSON schema.

Configuration model

The following list describes the attributes, data types, and default values, if any, in the config.tf file. Click on a value to learn more about the attribute.

• consulServers: map
  • hosts: string
    • skipServerWatch: boolean | false
  • defaults: map
    • caCertFile: string
    • tlsServerName: string
    • tls: boolean | false
  • grpc: map
    • port: number
    • caCertFile: string
    • tlsServerName: string
    • tls: boolean | false
  • http: map
    • https: boolean | false
    • port: number
    • caCertFile: string
    • tlsServerName: string
    • tls: boolean | false

Specification

This section provides details about the attribes in the config.tf file.

consulServers

Parent-level attribute containing all of the server configurations. All other configuraitons in the file are children of the consulServers attribute.

Values

• Default: None
• Data type: Map

consulServers.hosts

Map that contains the skipServerWatch configuration for Consul server hosts.

Values

• Default: None
• Data type: Map

consulServers.hosts.skipServerWatch

Boolean that disables watches on the Consul server. Set to true if the Consul server is already behind a load balancer.

Values

• Default: false
• Data type: Boolean

consulServers.defaults

Map of default server configurations. Defaults apply to gRPC and HTTP traffic.

Values

• Default: None
• Data type: Map

The following table describes the attributes available in the defaults configuration:

consulServers.grpc

Map of server configuration for gRPC traffic that override attributes defined in consulServers.defaults.

Values

• Default: None
• Data type: Map

The following table describes the attributes available in the grpc configuration:

consulServers.http

Map of server configuration for HTTP traffic that override attributes defined in consulServers.defaults.

Values

• Default: None
• Data type: Map

The following table describes the attributes available in the grpc configuration: