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.

Sign up for GitHub

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
Merged

teleport config retrieval from configmap example #39566

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a204b5
Update installation.mdx
WilliamLoy Mar 19, 2024
4925b5b
technically coming from the configmap
WilliamLoy Mar 19, 2024
26c39ca
Update docs/pages/installation.mdx
WilliamLoy Mar 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/pages/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.


# retrieving output via stdout and tar
$ kubectl exec -i my-pod -- tctl auth sign --user admin --format tls --ttl 10m --tar -o admin| tar xv -C local
$ ls -l local
Expand Down
Loading