Skip to content

Edit the versions section in the config reference#23800

Closed
ptgott wants to merge 2 commits intomasterfrom
paul.gottschling/2023-03-29-docs-config
Closed

Edit the versions section in the config reference#23800
ptgott wants to merge 2 commits intomasterfrom
paul.gottschling/2023-03-29-docs-config

Conversation

@ptgott
Copy link
Copy Markdown
Contributor

@ptgott ptgott commented Mar 29, 2023

Frame this as advice to users about specific features that require changing the configuration file version to opt into. This way, we can encourage users to use the latest config file version unless they specifically don't want to use one of the features we list.

zmb3 and others added 2 commits March 26, 2023 10:39
This was originally added as part of #15761, but removed during
the review cycle.

Closes #20016
Frame this as advice to users about specific features that require
changing the configuration file version to opt into. This way, we can
encourage users to use the latest config file version unless they
specifically don't want to use one of the features we list.
@github-advanced-security
Copy link
Copy Markdown

You have successfully added a new Trivy configuration .github/workflows/trivy.yaml:trivy. As part of the setup process, we have scanned this repository and found no existing alerts. In the future, you will see all code scanning alerts on the repository Security tab.

Here are the features that require users to opt in by explicitly upgrading their
configuration to a newer version.

### TLS Routing
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I'm not sure this is better, TBH. My goal was to help with questions like "whats the difference between config v2 and config v3" - that information seems harder to find now that it's hidden behind a section called "TLS Routing."

Additionally, I believe TLS routing works fine with config v1, config v2 is used to opt out of running the legacy listeners.

traffic to the correct listener rather than listening on multiple
protocol-specific ports.

For backwards compatibility, configuration version `v1` always disables TLS
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@smallinsky is this true?

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.

No, That seems to be not right.

TLS Routing feature on the teleport proxy side is always enable - no matter if v1 or v2 configuration version was selected.
So even in v1 config version the proxy_listener_mode: multiplex can be set to tell teleport proxy clients to use TLS Routing to connect to Teleport proxy.

The difference between v1 and v2 is the behavior when the additional listeners addressed were not explicitly specified. https://github.com/gravitational/teleport/blob/master/rfd/0039-sni-alpn-teleport-proxy-routing.md#proxy-configuration

v1 config will start legacy listener by default even if the address like tunnel_listen_addr was not provided/was empty( the logic fallback to the default tunnel address).
In v2 the behavior for empty proxy listener services is different. For instance if the tunnel_listen_addr proxy setting was not provided the v2 config won't start the tunnel proxy on the default address.

This v1 - v2 behavior applies to all the proxy listener expect webport where the TLS Routing logic is implemented.

@zmb3 zmb3 force-pushed the zmb3/docs-config-versions branch 3 times, most recently from c99672d to fee266c Compare March 31, 2023 20:38
Base automatically changed from zmb3/docs-config-versions to master March 31, 2023 21:18
@zmb3 zmb3 closed this in #23624 Mar 31, 2023
@ptgott ptgott deleted the paul.gottschling/2023-03-29-docs-config branch October 4, 2024 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants