Skip to content

update config defaults, add docs#15302

Merged
malizz merged 13 commits into
mainfrom
malizz/NET-1203/change-1.14-config-defaults
Nov 9, 2022
Merged

update config defaults, add docs#15302
malizz merged 13 commits into
mainfrom
malizz/NET-1203/change-1.14-config-defaults

Conversation

@malizz
Copy link
Copy Markdown
Contributor

@malizz malizz commented Nov 8, 2022

Description

Change 1.14 Config Defaults

  • Peering is enabled by default
  • Set the gRPC TLS port to 8503 by default (on Consul servers)
  • Connect is enabled by default

PR Checklist

  • updated test coverage
  • external facing docs updated
  • not a security concern

@malizz malizz requested a review from hashi-derek November 8, 2022 22:07
@malizz malizz requested a review from a team as a code owner November 8, 2022 22:07
@github-actions github-actions Bot added theme/config Relating to Consul Agent configuration, including reloading type/docs Documentation needs to be created/updated/clarified labels Nov 8, 2022
Comment thread website/content/docs/upgrading/upgrade-specific.mdx Outdated
Comment thread website/content/docs/agent/config/config-files.mdx Outdated
Comment thread agent/config/builder.go Outdated
Comment thread agent/config/builder.go Outdated
Comment thread agent/config/builder.go Outdated
@david-yu
Copy link
Copy Markdown
Contributor

david-yu commented Nov 8, 2022

Hi @malizz Thanks for doing this, could we also call out the connect and cluster peering defaults as breaking changes in our changelog. In our upgrade specific guideline, we should also note that during upgrades those settings must be set to false prior to the upgrade if you do not want to enable such functionality.

Maliz and others added 3 commits November 8, 2022 14:23
Co-authored-by: Derek Menteer <105233703+hashi-derek@users.noreply.github.com>
Co-authored-by: Derek Menteer <105233703+hashi-derek@users.noreply.github.com>
Comment thread .changelog/15302.txt
Comment thread agent/config/builder.go Outdated
Comment thread website/content/docs/upgrading/upgrade-specific.mdx Outdated
release. Refer to `grpc_tls` for more information on configuring a TLS-enabled port.
- `grpc_tls` ((#grpc_tls_port)) - The gRPC API with TLS connections, -1 to disable. Default -1 (disabled).
**We recommend using `8502` for `grpc_tls`** as your conventional gRPC port number, as it allows some
- `grpc_tls` ((#grpc_tls_port)) - The gRPC API with TLS connections, -1 to disable. gRPC_TLS is enabled by default on port 8503 for Consul servers.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `grpc_tls` ((#grpc_tls_port)) - The gRPC API with TLS connections, -1 to disable. gRPC_TLS is enabled by default on port 8503 for Consul servers.
- `grpc_tls` ((#grpc_tls_port)) - The gRPC API with TLS connections, -1 to disable. `grpc_tls` is enabled by default on port 8503 for Consul servers.

This is probably a bit more consistent.

files#grpc_port) configuration **will stop supporting encryption in a future release**. As of version 1.14,
`ports.grpc_tls` is the recommended configuration to encrypt gRPC traffic.
[`ports.grpc_tls`](/docs/agent/config/config-files#grpc_tls_port) is the recommended configuration to encrypt gRPC traffic.
The default value for gRPC TLS port is 8503 for Consul servers. To disable the gRPC TLS port, use value -1.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The default value for gRPC TLS port is 8503 for Consul servers. To disable the gRPC TLS port, use value -1.
The default gRPC TLS port is 8503 for Consul servers. To disable the gRPC TLS port, use value -1.

@malizz malizz merged commit b9a9e12 into main Nov 9, 2022
@malizz malizz deleted the malizz/NET-1203/change-1.14-config-defaults branch November 9, 2022 17:29
hashi-derek added a commit that referenced this pull request Nov 10, 2022
* update config defaults, add docs

* update grpc tls port for non-default values

* add changelog

* Update website/content/docs/upgrading/upgrade-specific.mdx

Co-authored-by: Derek Menteer <105233703+hashi-derek@users.noreply.github.com>

* Update website/content/docs/agent/config/config-files.mdx

Co-authored-by: Derek Menteer <105233703+hashi-derek@users.noreply.github.com>

* update logic for setting grpc tls port value

* move default config to default.go, update changelog

* update docs

* Fix config tests.

* Fix linter error.

* Fix ConnectCA tests.

* Cleanup markdown on upgrade notes.

Co-authored-by: Derek Menteer <105233703+hashi-derek@users.noreply.github.com>
Co-authored-by: Derek Menteer <derek.menteer@hashicorp.com>
hashi-derek added a commit that referenced this pull request Nov 10, 2022
* update config defaults, add docs

* update grpc tls port for non-default values

* add changelog

* Update website/content/docs/upgrading/upgrade-specific.mdx

Co-authored-by: Derek Menteer <105233703+hashi-derek@users.noreply.github.com>

* Update website/content/docs/agent/config/config-files.mdx

Co-authored-by: Derek Menteer <105233703+hashi-derek@users.noreply.github.com>

* update logic for setting grpc tls port value

* move default config to default.go, update changelog

* update docs

* Fix config tests.

* Fix linter error.

* Fix ConnectCA tests.

* Cleanup markdown on upgrade notes.

Co-authored-by: Derek Menteer <105233703+hashi-derek@users.noreply.github.com>
Co-authored-by: Derek Menteer <derek.menteer@hashicorp.com>

Co-authored-by: malizz <maliheh.monshizadeh@hashicorp.com>
Co-authored-by: Derek Menteer <105233703+hashi-derek@users.noreply.github.com>
Co-authored-by: Derek Menteer <derek.menteer@hashicorp.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

theme/config Relating to Consul Agent configuration, including reloading type/docs Documentation needs to be created/updated/clarified

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants