History

Matt Moyer 7f2c43cd62 Put all of our APIs into a "pinniped" category, and never use "all". We want to have our APIs respond to `kubectl get pinniped`, and we shouldn't use `all` because we don't think most average users should have permission to see our API types, which means if we put our types there, they would get an error from `kubectl get all`. I also added some tests to assert these properties on all `*.pinniped.dev` API resources. Signed-off-by: Matt Moyer <moyerm@vmware.com>		2020-11-12 16:26:34 -06:00
..
authentication.concierge.pinniped.dev_webhookauthenticators.yaml	Put all of our APIs into a "pinniped" category, and never use "all".	2020-11-12 16:26:34 -06:00
config.concierge.pinniped.dev_credentialissuers.yaml	Put all of our APIs into a "pinniped" category, and never use "all".	2020-11-12 16:26:34 -06:00
deployment.yaml	Add YTT template value for setting log level	2020-11-11 09:01:38 -05:00
helpers.lib.yaml	Add YTT template value for setting log level	2020-11-11 09:01:38 -05:00
rbac.yaml	Give the concierge access to use any PodSecurityPolicy.	2020-11-02 15:10:00 -06:00
README.md	Add supervisor yaml and rename concierge yaml in release process	2020-10-12 09:43:52 -07:00
values.yaml	Add YTT template value for setting log level	2020-11-11 09:01:38 -05:00
z0_crd_overlay.yaml	Rename CredentialIssuerConfig to CredentialIssuer.	2020-11-02 17:39:42 -06:00

README.md

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://github.com/vmware-tanzu/pinniped/releases/download/$(curl https://api.github.com/repos/vmware-tanzu/pinniped/releases/latest -s | jq .name -r)/install-pinniped-concierge.yaml

Installing an Older Version with Default Options

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

# Replace v0.2.0 with your preferred version in the URL below
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/download/v0.2.0/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 -