Clean up docs using https://get.pinniped.dev redirects.

We have these redirects set up to make the `kubectl apply -f [...]` commands cleaner, but we never went back and fixed up the documentation to use them until now.

Signed-off-by: Matt Moyer <moyerm@vmware.com>

2021-01-28 10:15:39 -06:00

1.8 KiB

Raw Blame History

Deploying

Connecting Pinniped to an Identity Provider

If you would like to try Pinniped, but you don't have a compatible identity provider, you can use Pinniped's test identity provider. See deploy/local-user-authenticator/README.md for details.

Installing the Latest Version with Default Options

kubectl apply -f https://get.pinniped.dev/latest/install-pinniped-concierge.yaml

Installing a Specific Version with Default Options

Choose your preferred release version number and use it to replace the version number in the URL below.

# Replace v0.4.1 with your preferred version in the URL below
kubectl apply -f https://get.pinniped.dev/v0.4.1/install-pinniped-concierge.yaml

Installing with Custom Options

Creating your own deployment YAML file requires ytt from Carvel to template the YAML files in the deploy/concierge directory. Either install ytt or use the container image from Dockerhub.

git clone this repo and git checkout the release version tag of the release that you would like to deploy.
The configuration options are in deploy/concierge/values.yml. Fill in the values in that file, or override those values using additional ytt command-line options in the command below. Use the release version tag as the image_tag value.
In a terminal, cd to this deploy/concierge directory
To generate the final YAML files, run ytt --file .
Deploy the generated YAML using your preferred deployment tool, such as kubectl or kapp. For example: ytt --file . | kapp deploy --yes --app pinniped --diff-changes --file -

1.8 KiB Raw Blame History