[v13] Refresh the teleport-cluster Helm guide#26172
Merged
ptgott merged 1 commit intobranch/v13from May 16, 2023
Merged
Conversation
Backports #25287 * Refresh the teleport-cluster Helm guide Updated the guide while testing it for v13. The goals of this change are to: - Update the guide for v13 (these are very minor changes consisting of editing example outputs) - Simplify the guide - Make the guide easier to use Updating the guide: - Remove the video, which is two years old. Simplifying the guide: - Some `Tabs` components differ only in mentioning an Enterprise-specific namespace instead of an OSS-specific namespace. By using the same namespace for both editions, we can remove these tabs. - Add tsh as a prerequisite so we don't need to install it midway through the guide. - Remove the SSO instructions: The SSO instructions rely on following other guides to complete, so these aren't really appropriate for this step-by-step guide. The only difference the SSO instructions in this guide offer from other guides is is running `tctl` on the Auth Service pod via `kubectl exec`. Since this isn't actually necessary, we can remove these instructions. - Refactor out common instructions in the OSS/Enterprise installation tabs - Remove the command to get the Proxy Service's load balancer IP, since the `get services` command already shows this Make the guide easier to use: - Add more specific Enterprise installation steps, including showing how to get the license file. - Make the DNS instructions more specific. - Add guidance in the Prerequisites for ensuring that your cluster supports Persistent Volumes. - Add a warning re: `system:masters` - Add `Var` components to code snippets so they are easier to copy/paste. Stray edits: - Adjust line widths for easier reviews. - Recommend the local Kubenetes guide in the first Admonition, rather than the Docker Compose guide, since readers will already be interested in Kubernetes. * Respond to hugoShaka feedback * Linter fixes * Respond to alexfornuto feedback
hugoShaka
approved these changes
May 12, 2023
alexfornuto
approved these changes
May 16, 2023
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Backports #25287
Updated the guide while testing it for v13.
The goals of this change are to:
Updating the guide:
Simplifying the guide:
Tabscomponents differ only in mentioning an Enterprise-specific namespace instead of an OSS-specific namespace. By using the same namespace for both editions, we can remove these tabs.tctlon the Auth Service pod viakubectl exec. Since this isn't actually necessary, we can remove these instructions.get servicescommand already shows thisMake the guide easier to use:
system:mastersVarcomponents to code snippets so they are easier to copy/paste.Stray edits:
Respond to hugoShaka feedback
Linter fixes
Respond to alexfornuto feedback