Skip to content

Improve chart documentation and best practices#25601

Merged
hugoShaka merged 1 commit intomasterfrom
hugo/improve-chart-ux
May 5, 2023
Merged

Improve chart documentation and best practices#25601
hugoShaka merged 1 commit intomasterfrom
hugo/improve-chart-ux

Conversation

@hugoShaka
Copy link
Copy Markdown
Contributor

@hugoShaka hugoShaka commented May 3, 2023

This PR mitigates two frequently reported UX issues causing support load:

  • users are using teleportVersionOverride to control the Teleport version, which causes compatibility issues. The chart is versioned with Teleport, and the versions should match unless they know what they are doing
  • users are using scratch mode while they could just pass a configuration override through teleportConfig. As they are not familiar with how auth/proxy are clustering, this leads to broken setups.

Thanks @tigrato and @webvictim for reporting the issues

NOTE: For certificates to be provisioned, you must also install cert-manager (https://cert-manager.io/docs/) and configure an appropriate
Issuer with access to your DNS provider to handle DNS01 challenges (https://cert-manager.io/docs/configuration/acme/dns01/#supported-dns01-providers)

For more information, please see the Helm guides in the Teleport docs (https://goteleport.com/docs/kubernetes-access/helm/guides/)
Copy link
Copy Markdown
Contributor Author

@hugoShaka hugoShaka May 3, 2023

Choose a reason for hiding this comment

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

Note for reviewers: I dropped this condition because it was broken for cert mounting through tls and we are doing checks at other places

Comment thread docs/pages/reference/helm-reference/teleport-kube-agent.mdx Outdated
Comment thread docs/pages/reference/helm-reference/teleport-cluster.mdx Outdated
Comment thread docs/pages/reference/helm-reference/teleport-cluster.mdx Outdated
Comment thread docs/pages/reference/helm-reference/teleport-cluster.mdx Outdated
Comment thread docs/pages/reference/helm-reference/teleport-kube-agent.mdx Outdated
Comment thread examples/chart/teleport-cluster/values.yaml Outdated
Comment thread examples/chart/teleport-kube-agent/values.yaml Outdated
Comment thread docs/pages/reference/helm-reference/teleport-kube-agent.mdx Outdated
Copy link
Copy Markdown
Collaborator

@r0mant r0mant left a comment

Choose a reason for hiding this comment

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

Bot.

@hugoShaka hugoShaka force-pushed the hugo/improve-chart-ux branch from bcc0abb to 654c658 Compare May 5, 2023 21:37
@hugoShaka hugoShaka enabled auto-merge May 5, 2023 21:41
@hugoShaka hugoShaka added this pull request to the merge queue May 5, 2023
Merged via the queue into master with commit 2b0532b May 5, 2023
@hugoShaka hugoShaka deleted the hugo/improve-chart-ux branch May 5, 2023 22:28
@public-teleport-github-review-bot
Copy link
Copy Markdown

@hugoShaka See the table below for backport results.

Branch Result
branch/v12 Failed
branch/v13 Failed

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.

6 participants