2021-02-22 23:52:23 +00:00
---
title: Install the Pinniped Supervisor
description: Install the Pinniped Supervisor service in a Kubernetes cluster.
cascade:
layout: docs
menu:
docs:
name: Install Supervisor
2021-05-25 23:15:45 +00:00
weight: 60
2021-02-22 23:52:23 +00:00
parent: howtos
---
This guide shows you how to install the Pinniped Supervisor, which allows seamless login across one or many Kubernetes clusters.
You should have a supported Kubernetes cluster with working HTTPS ingress capabilities.
<!-- TODO: link to support matrix -->
## With default options
1. Install the latest version of the Supervisor into the `pinniped-supervisor` namespace with default options:
- `kubectl apply -f https://get.pinniped.dev/latest/install-pinniped-supervisor.yaml`
## With specific version and default options
1. 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.
2021-02-23 22:01:40 +00:00
1. Install the Supervisor into the `pinniped-supervisor` namespace with default options:
2021-02-22 23:52:23 +00:00
2021-05-24 16:50:16 +00:00
- `kubectl apply -f https://get.pinniped.dev/v0.8.0/install-pinniped-supervisor.yaml`
2021-05-25 21:52:32 +00:00
2021-05-24 16:50:16 +00:00
*Replace v0.8.0 with your preferred version number.*
2021-02-22 23:52:23 +00:00
## With custom options
Pinniped uses [ytt ](https://carvel.dev/ytt/ ) from [Carvel ](https://carvel.dev/ ) as a templating system.
1. Install the `ytt` command-line tool using the instructions from the [Carvel documentation ](https://carvel.dev/#whole-suite ).
1. Clone the Pinniped GitHub repository and visit the `deploy/supervisor` directory:
- `git clone git@github.com:vmware-tanzu/pinniped.git`
- `cd pinniped/deploy/supervisor`
1. Customize configuration parameters:
- Edit `values.yaml` with your custom values.
- See the [default values ](http://github.com/vmware-tanzu/pinniped/tree/main/deploy/supervisor/values.yaml ) for documentation about individual configuration parameters.
1. Render templated YAML manifests:
- `ytt --file .`
1. Deploy the templated YAML manifests:
- *If you're using `kubectl` :*
`ytt --file . | kubectl apply -f -`
- *If you're using [`kapp` from Carvel ](https://carvel.dev/kapp/ ):*
`ytt --file . | kapp deploy --yes --app pinniped-supervisor --diff-changes --file -`
2021-05-25 21:52:32 +00:00
2021-05-25 23:15:45 +00:00
## Next Steps
Now that you have installed the Supervisor, you will want to [configure the Supervisor ]({{< ref "configure-supervisor" >}} ).