Update/improve the "kubernetes-cluster" guide#20779
Closed
Conversation
Contributor
Author
|
I just noticed that a lot of this overlaps with work in #19881. |
Collaborator
Contributor
Author
I made these edits while testing out v12 while following our "kubernetes-cluster" guide. **Update the guide:** - Specify that there are two pods deployed via the chart, not one - Update the `/webapi/ping` example output. - Add `kubernetes_resources` to the example role. - Reference the config file in tctl commands to overcome #20346 **Move the guide** to the "Try out Teleport" path, since it launches a small-scale cluster that isn't really production ready. **Minor edits for clarity:** - Clarify that the Kubernetes version belongs to the deployment on your cloud provider and the Helm deployment is on your local machine. - Change the Admonition for local-only users to recommend the minikube guide, not the docker-compose guide. - Note that you can access the Kubernetes cluster in this setup **Make the guide easier to follow:** - Use the `Var` component instead of env vars for installation instructions. - Include detailed instructions re: obtaining an Enterprise license - Add a step for verifying that Teleport has deployed - Require tsh as a prerequisite, rather than including installation instructions in the guide, since installation steps vary between environments - Use the `teleport-cluster` namespace for both OSS and Enterprise deployments so the instructions for accessing the cluster don't vary between editions. - Replace the use of the "dns.mdx" partial with custom instructions, since the partial's instructions for launching DNS records require the user to install a lot of software on one of the `teleport-cluster` chart's Kubernetes pods. - Move the SSO section to "Next steps". That section requires you to read a completely different guide, so I thought it would make sense to move this to "Next steps" to make this guide more self-contained.
ptgott
force-pushed
the
paul.gottschling/2023-01-26-kube-cluster
branch
from
0a4c4b2 to
8286a48
Compare
Contributor
Author
|
Closing in favor of #25287 |
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
2 participants
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.
I made these edits while testing out v12 while following our "kubernetes-cluster" guide.
Update the guide:
/webapi/pingexample output.kubernetes_resourcesto the example role.tctlno longer defaults to local auth connection when no config is provided #20346Move the guide to the "Try out Teleport" path, since it launches a small-scale cluster that isn't really production ready.
Minor edits for clarity:
Make the guide easier to follow:
Varcomponent instead of env vars for installation instructions.teleport-clusternamespace for both OSS and Enterprise deployments so the instructions for accessing the cluster don't vary between editions.teleport-clusterchart's Kubernetes pods.