80a520390b
New resource naming conventions: - Do not repeat the Kind in the name, e.g. do not call it foo-cluster-role-binding, just call it foo - Names will generally start with a prefix to identify our component, so when a user lists all objects of that kind, they can tell to which component it is related, e.g. `kubectl get configmaps` would list one named "pinniped-config" - It should be possible for an operator to make the word "pinniped" mostly disappear if they choose, by specifying the app_name in values.yaml, to the extent that is practical (but not from APIService names because those are hardcoded in golang) - Each role/clusterrole and its corresponding binding have the same name - Pinniped resource names that must be known by the server golang code are passed to the code at run time via ConfigMap, rather than hardcoded in the golang code. This also allows them to be prepended with the app_name from values.yaml while creating the ConfigMap. - Since the CLI `get-kubeconfig` command cannot guess the name of the CredentialIssuerConfig resource in advance anymore, it lists all CredentialIssuerConfig in the app's namespace and returns an error if there is not exactly one found, and then uses that one regardless of its name |
||
---|---|---|
.. | ||
crd.pinniped.dev_credentialissuerconfigs.yaml | ||
deployment.yaml | ||
idp.pinniped.dev_webhookidentityproviders.yaml | ||
rbac.yaml | ||
README.md | ||
values.yaml | ||
webhook.yaml |
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.
Tools
This example deployment uses ytt
and kapp
from Carvel to template the YAML files
and to deploy the app.
Either install ytt
and kapp
or use the container image from Dockerhub.
Procedure
- The configuration options are in values.yml. Fill in the values in that file, or override those values
using
ytt
command-line options in the command below. - In a terminal, cd to this
deploy
directory - To generate the final YAML files, run:
ytt --file .
- Deploy the generated YAML using your preferred deployment tool, such as
kubectl
orkapp
. For example:ytt --file . | kapp deploy --yes --app pinniped --diff-changes --file -