Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

teleport config retrieval from configmap example #39566

Merged
merged 3 commits into from
Mar 27, 2024

Conversation

WilliamLoy
Copy link
Contributor

This example shows users how to retrieve the teleport.yaml file from distroless pods.

Copy link

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@WilliamLoy WilliamLoy added the no-changelog Indicates that a PR does not require a changelog entry label Mar 19, 2024
@WilliamLoy WilliamLoy changed the title teleport config retrieval from pod example teleport config retrieval from configmap example Mar 19, 2024
Copy link

🤖 Vercel preview here: https://docs-65ocmql94-goteleport.vercel.app/docs/ver/preview

Copy link

🤖 Vercel preview here: https://docs-5qx5vplmm-goteleport.vercel.app/docs/ver/preview

docs/pages/installation.mdx Outdated Show resolved Hide resolved
Copy link

🤖 Vercel preview here: https://docs-gyfl4luno-goteleport.vercel.app/docs/ver/preview

@@ -485,6 +485,9 @@ $ kubectl exec -i my-pod -- tctl status
# sending local files via stdin
$ kubectl exec -i my-pod -- tctl create -f < my-local-file.yaml

# retrieving the teleport service config file from the configmap
$ kubectl get configmap teleport-cluster-auth -o jsonpath="{.data['teleport\.yaml']}"
Copy link
Contributor

Choose a reason for hiding this comment

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

It looks like this only refers to the Auth Service configmap in the teleport-cluster chart. Do we have a user-friendly way to list all available configmaps first? E.g., kubectl get configmaps in the appropriate namespace? Or we could include similar example commands for the Proxy Service in teleport-cluster and agents in teleport-kube-agent.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The other examples seemed like they were assuming some knowledge but i'm an advocate for adding more details. @zmb3 do you think this will bloat things too much or should we add them in?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this is good enough to merge. We're just including a few snippets for how to accomplish common tasks in this section, not trying to teach the ins and outs of how to use kubectl.

@WilliamLoy WilliamLoy added this pull request to the merge queue Mar 27, 2024
Merged via the queue into master with commit 668b0f1 Mar 27, 2024
34 checks passed
@WilliamLoy WilliamLoy deleted the williamloy/distroless-yaml-echo branch March 27, 2024 14:42
@public-teleport-github-review-bot

@WilliamLoy See the table below for backport results.

Branch Result
branch/v15 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/branch/v15 documentation no-changelog Indicates that a PR does not require a changelog entry size/sm
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants