github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

reformatted the JSON schema server conf ref

pull/19288/head
trujillo-adam 2023-10-18 16:46:35 -07:00
parent d52ee6a222
commit 8d16fc3252
1 changed files with 109 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

129
website/content/docs/ecs/reference/consul-server-json.mdx
View File

@ -8,24 +8,113 @@ description: Learn about the fields available in the JSON scheme for configuring
This topic provides reference information about the JSON schema used to build the `config.tf` file. Refer to [Configure Consul server settings](/consul/docs/ecs/deploy/terraform#configure-consul-server-settings) for information about how Consul on ECS uses the JSON schema. This topic provides reference information about the JSON schema used to build the `config.tf` file. Refer to [Configure Consul server settings](/consul/docs/ecs/deploy/terraform#configure-consul-server-settings) for information about how Consul on ECS uses the JSON schema.
```json ## Configuration model
`consulServers`
`hosts`: string 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.
`skipServerWatch`: boolean; set to true if the Consul server is already behind a load balancer
`defaults`: map - applies to both gRPC and HTTP - [`consulServers`](#consulservers): map
`caCertFile`: string path to the certificate .pem file - [`hosts`](#consulservers-hosts): string
`tlsServerName`: string name of the TLS server - [`skipServerWatch`](#consulservers-hosts): boolean | `false`
`tls`: boolean that enables TLS - [`defaults`](#consulservers-defaults): map
`grpc`: map - overrides for gRPC traffic - [`caCertFile`](#consulservers-defaults): string
`port`: number specifying the port for gRPC communication - [`tlsServerName`](#consulservers-defaults): string
`caCertFile`: string path to the certificate .pem file for authorizing gRPC - [`tls`](#consulservers-defaults): boolean | `false`
`tlsServerName`: string name of the TLS server - [`grpc`](#consulservers-grpc): map
`tls`: boolean that enables TLS for gRPC - [`port`](#consulservers-grpc): number
`http`: map - overrides for HTTP traffic - [`caCertFile`](#consulservers-grpc): string
`https`: boolean that enables HTTPS - [`tlsServerName`](#consulservers-grpc): string
`port`: number specifying the port for HTTPS communication - [`tls`](#consulservers-grpc): boolean | `false`
`caCertFile`: string path to the certificate .pem file for authorizing HTTPS - [`http`](#consulservers-http): map
`tlsServerName`: string name of the TLS server - [`https`](#consulservers-http): boolean | `false`
`tls`: boolean that enables TLS for HTTPS - [`port`](#consulservers-http): number
- [`caCertFile`](#consulservers-http): string
- [`tlsServerName`](#consulservers-http): string
- [`tls`](#consulservers-http): 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:
| Attribute | Description | Data type | Default |
| --- | --- | --- | --- |
| `caCertFile` | Specifies the path to the certificate .pem file. | String | None |
| `tlsServerName` | Specifies the name of the TLS server. | String | None |
| `tls` | Enables TLS on the server. | Boolean | `false` |
### `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:
| Attribute | Description | Data type | Default |
| --- | --- | --- | --- |
| `port` | Specifies the port number for gRPC communication. | Number | None |
| `caCertFile` | Specifies the path to the certificate .pem file. | String | None |
| `tlsServerName` | Specifies the name of the TLS server. | String | None |
| `tls` | Enables TLS for gRPC traffic on the server. | Boolean | `false` |
### `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:
| Attribute | Description | Data type | Default |
| --- | --- | --- | --- |
| `https` | Enables HTTPS. | Boolean | `false` |
| `port` | Specifies the port number for HTTPS communication. | Number | None |
| `caCertFile` | Specifies the path to the certificate .pem file. | String | None |
| `tlsServerName` | Specifies the name of the TLS server. | String | None |
| `tls` | Enables TLS for HTTPS traffic on the server. | Boolean | `false` |
```