2020-07-07 20:17:34 +00:00
|
|
|
# Deploying
|
|
|
|
|
|
2020-09-10 02:06:39 +00:00
|
|
|
## 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.
|
2020-10-09 17:00:22 +00:00
|
|
|
See [deploy/local-user-authenticator/README.md](../../deploy/local-user-authenticator/README.md)
|
2020-09-10 02:06:39 +00:00
|
|
|
for details.
|
|
|
|
|
|
2020-09-25 00:55:53 +00:00
|
|
|
## Installing the Latest Version with Default Options
|
2020-07-08 01:50:35 +00:00
|
|
|
|
2020-09-25 00:55:53 +00:00
|
|
|
```bash
|
2020-10-12 16:43:52 +00:00
|
|
|
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
|
2020-09-25 00:55:53 +00:00
|
|
|
```
|
2020-07-07 20:17:34 +00:00
|
|
|
|
2020-09-25 00:55:53 +00:00
|
|
|
## Installing an Older Version with Default Options
|
2020-08-27 17:14:03 +00:00
|
|
|
|
2020-09-25 00:55:53 +00:00
|
|
|
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.2.0 with your preferred version in the URL below
|
2020-10-12 16:43:52 +00:00
|
|
|
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/download/v0.2.0/install-pinniped-concierge.yaml
|
2020-09-25 00:55:53 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Installing with Custom Options
|
|
|
|
|
|
|
|
|
|
Creating your own deployment YAML file requires `ytt` from [Carvel](https://carvel.dev/) to template the YAML files
|
2020-10-09 17:00:22 +00:00
|
|
|
in the `deploy/concierge` directory.
|
2020-09-25 00:55:53 +00:00
|
|
|
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.
|
2020-10-09 17:00:22 +00:00
|
|
|
1. The configuration options are in [deploy/concierge/values.yml](values.yaml).
|
2020-09-25 00:55:53 +00:00
|
|
|
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.
|
2020-10-09 17:00:22 +00:00
|
|
|
2. In a terminal, cd to this `deploy/concierge` directory
|
2020-09-25 00:55:53 +00:00
|
|
|
3. To generate the final YAML files, run `ytt --file .`
|
2020-08-27 17:14:03 +00:00
|
|
|
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 --diff-changes --file -`
|
