ContainerImage.Pinniped/deploy
Ryan Richard 80a520390b Rename many of resources that are created in Kubernetes by Pinniped
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
2020-09-18 15:56:50 -07:00
..
crd.pinniped.dev_credentialissuerconfigs.yaml Define the WebhookIdentityProvider CRD. 2020-09-15 11:44:23 -05:00
deployment.yaml Rename many of resources that are created in Kubernetes by Pinniped 2020-09-18 15:56:50 -07:00
idp.pinniped.dev_webhookidentityproviders.yaml Define the WebhookIdentityProvider CRD. 2020-09-15 11:44:23 -05:00
rbac.yaml Rename many of resources that are created in Kubernetes by Pinniped 2020-09-18 15:56:50 -07:00
README.md Add demo instructions 2020-09-15 12:10:20 -07:00
values.yaml local-user-authenticator can be deployed from a private registry image 2020-09-17 16:07:31 -07:00
webhook.yaml Update copyright to reference Pinniped contributors 2020-09-16 10:05:51 -04:00

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

  1. 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.
  2. In a terminal, cd to this deploy directory
  3. To generate the final YAML files, run: ytt --file .
  4. 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 -