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

Jump to bottom

document usage of --pinniped-cli-path option #1716

Merged
merged 1 commit into from
Oct 10, 2023
Merged

document usage of --pinniped-cli-path option #1716

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions site/content/docs/howto/login.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,17 @@ and if that FederationDomain allows multiple identity providers, then you will n
you would like to use in the resulting kubeconfig with the `--upstream-identity-provider-name` and/or `--upstream-identity-provider-type` flags.
You may call `pinniped get kubeconfig` multiple times to generate multiple kubeconfigs for the cluster.

By default, the resulting kubeconfig will contain the absolute path to the Pinniped CLI binary that was used to run `pinniped get kubeconfig`.
However, this absolute path may not work on the local machines for your end users to whom you distribute the kubeconfig,
since they may have the Pinniped CLI installed elsewhere.
You can optionally set the absolute path or executable name in the resulting kubeconfig by using the `--pinniped-cli-path`
argument. For example, when using `pinniped get kubeconfig --pinniped-cli-path=pinniped` then the resulting kubeconfig
will include `pinniped` as the command to execute the Pinniped CLI, and during user login it will find the CLI by
searching the user's PATH for a binary named `pinniped`. This also works on Windows, where using `pinniped` as the command
can find a binary named `pinniped.exe` in the user's PATH.
Alternatively, you could use `pinniped get kubeconfig --pinniped-cli-path=/usr/local/bin/pinniped`
if you have reason to believe that your end users' machines will always have the Pinniped CLI installed in `/usr/local/bin`.

## Use the generated kubeconfig with `kubectl` to access the cluster

A cluster user will typically be given a Pinniped-compatible kubeconfig by their cluster admin. They can use this kubeconfig
Expand Down