42 lines
1.9 KiB
Markdown
42 lines
1.9 KiB
Markdown
|
# Deploying the Pinniped Supervisor
|
||
|
|
|
||
|
|
## What is the Pinniped Supervisor?
|
||
|
|
|
||
|
|
The Pinniped Supervisor app is a component of the Pinniped OIDC and Cluster Federation solutions.
|
||
|
|
It can be deployed when those features are needed.
|
||
|
|
|
||
|
|
## Installing the Latest Version with Default Options
|
||
|
|
|
||
|
|
```bash
|
||
|
|
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/latest/download/install-supervisor.yaml
|
||
|
|
```
|
||
|
|
|
||
|
|
## Installing an Older Version with Default Options
|
||
|
|
|
||
|
|
Choose your preferred [release](https://github.com/vmware-tanzu/pinniped/releases) version number
|
||
|
|
and use it to replace the version number in the URL below.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# Replace v0.3.0 with your preferred version in the URL below
|
||
|
|
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/download/v0.3.0/install-supervisor.yaml
|
||
|
|
```
|
||
|
|
|
||
|
|
## Installing with Custom Options
|
||
|
|
|
||
|
|
Creating your own deployment YAML file requires `ytt` from [Carvel](https://carvel.dev/) to template the YAML files
|
||
|
|
in the [deploy-supervisor](../deploy-supervisor) directory.
|
||
|
|
Either [install `ytt`](https://get-ytt.io/) or use the [container image from Dockerhub](https://hub.docker.com/r/k14s/image/tags).
|
||
|
|
|
||
|
|
1. `git clone` this repo and `git checkout` the release version tag of the release that you would like to deploy.
|
||
|
|
1. The configuration options are in [deploy-supervisor/values.yml](values.yaml).
|
||
|
|
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.
|
||
|
|
2. In a terminal, cd to this `deploy-supervisor` 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`](https://get-kapp.io/).
|
||
|
|
For example: `ytt --file . | kapp deploy --yes --app pinniped-supervisor --diff-changes --file -`
|
||
|
|
|
||
|
|
## Configuring After Installing
|
||
|
|
|
||
|
|
TODO: Provide some instructions here.
|