pinniped/site/content/docs/howto/install-concierge.md at fd5ed2e5da67d436818dc0d799a26676e780af48

mirror of https://github.com/vmware-tanzu/pinniped.git synced 2026-02-14 18:10:17 +00:00

Files

Matt Moyer fd5ed2e5da Rework "install" sections of our docs.

- Remove all the "latest" links and replace them with our new shortcode so they point at the latest release in a more explicit way.
  This also eliminates one of the sections in our Concierge and Supervisor install guides, since you're always installing a specific version.

- Provide instructions for installing with both kapp (one step) and kubectl (two steps for the Concierge).

- Minor wording changes. Mainly we are now a bit less verbose about reminding people they can choose a different version (once per page instead of in each step).

- When we give an example `kapp deploy` command, don't suggest `--yes` and `--diff-changes`.
  Users can still use these but it seems overly verbose for an example command.

Signed-off-by: Matt Moyer <moyerm@vmware.com>

2021-07-29 08:45:19 -05:00

3.2 KiB

Raw Blame History

title, description, cascade, menu

title

description

cascade

Install the Pinniped Concierge

Install the Pinniped Concierge service in a Kubernetes cluster.

layout
docs

docs

name	weight	parent
Install Concierge	20	howtos

This guide shows you how to install the Pinniped Concierge. You should have a [supported Kubernetes cluster]({{< ref "../reference/supported-clusters" >}}).

In the examples below, you can replace {{< latestversion >}} with your preferred version number. You can find a list of Pinniped releases on GitHub.

With default options

Warning: the default Concierge configuration may create a public LoadBalancer Service on your cluster if that is the default on your cloud provider. If you'd prefer to customize the annotations or load balancer IP address, see the "With custom options" section below.

Using kapp

Install the latest version of the Concierge into the pinniped-concierge namespace with default options using kapp:
- kapp deploy --app pinniped-concierge--file https://get.pinniped.dev/{{< latestversion >}}/install-pinniped-concierge.yaml

Using kubectl

Install the latest version of the Concierge CustomResourceDefinitions:
- kubectl apply -f https://get.pinniped.dev/{{< latestversion >}}/install-pinniped-concierge-crds.yaml
This step is required so kubectl can validate the custom resources deployed in the next step.
Install the latest version of the Concierge into the pinniped-concierge namespace with default options:
- kubectl apply -f https://get.pinniped.dev/{{< latestversion >}}/install-pinniped-concierge.yaml

With custom options

Pinniped uses ytt from Carvel as a templating system.

Install the ytt and kapp command-line tools using the instructions from the Carvel documentation.
Clone the Pinniped GitHub repository and visit the deploy/concierge directory:
- git clone git@github.com:vmware-tanzu/pinniped.git
- cd pinniped/deploy/concierge
Decide which release version you would like to install. All release versions are listed on GitHub.
Checkout your preferred version tag, e.g. {{< latestversion >}}.
- git checkout {{< latestversion >}}
Customize configuration parameters:
- Edit values.yaml with your custom values.
- Change the image_tag value to match your preferred version tag, e.g. {{< latestversion >}}.
- See the default values for documentation about individual configuration parameters.
Render templated YAML manifests:
- ytt --file .
Deploy the templated YAML manifests:
- ytt --file . | kapp deploy --app pinniped-concierge --file -

Next steps

Next, configure the Concierge for [JWT]({{< ref "configure-concierge-jwt.md" >}}) or [webhook]({{< ref "configure-concierge-webhook.md" >}}) authentication, or [configure the Concierge to use the Supervisor for authentication]({{< ref "configure-concierge-supervisor-jwt" >}}).

3.2 KiB Raw Blame History