From 11eb18d348c7b01531cbfb1ab75608093a0e1686 Mon Sep 17 00:00:00 2001 From: Ryan Richard Date: Wed, 14 Jul 2021 10:59:51 -0700 Subject: [PATCH] ytt install docs suggest that you checkout the release tag Previously, the ytt install docs suggested that you use ytt templates from the HEAD of main with the container image from the latest public release, which could result in a mismatch. --- site/content/docs/howto/install-concierge.md | 9 +++++++++ site/content/docs/howto/install-supervisor.md | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/site/content/docs/howto/install-concierge.md b/site/content/docs/howto/install-concierge.md index 2083a27c9..582e2c18b 100644 --- a/site/content/docs/howto/install-concierge.md +++ b/site/content/docs/howto/install-concierge.md @@ -41,9 +41,18 @@ Pinniped uses [ytt](https://carvel.dev/ytt/) from [Carvel](https://carvel.dev/) - `git clone git@github.com:vmware-tanzu/pinniped.git` - `cd pinniped/deploy/concierge` +1. Decide which release version you would like to install. All release versions are [listed on GitHub](https://github.com/vmware-tanzu/pinniped/releases). + +1. Checkout your preferred version tag, e.g. `v0.9.2`. + + - `git checkout v0.9.2` + + *Replace v0.9.2 with your preferred version number.* + 1. Customize configuration parameters: - Edit `values.yaml` with your custom values. + - Change the `image_tag` value to match your preferred version tag, e.g. `v0.9.2`. *Replace v0.9.2 with your preferred version number.* - See the [default values](http://github.com/vmware-tanzu/pinniped/tree/main/deploy/concierge/values.yaml) for documentation about individual configuration parameters. 1. Render templated YAML manifests: diff --git a/site/content/docs/howto/install-supervisor.md b/site/content/docs/howto/install-supervisor.md index 06dfe44a0..796648f14 100644 --- a/site/content/docs/howto/install-supervisor.md +++ b/site/content/docs/howto/install-supervisor.md @@ -40,9 +40,18 @@ Pinniped uses [ytt](https://carvel.dev/ytt/) from [Carvel](https://carvel.dev/) - `git clone git@github.com:vmware-tanzu/pinniped.git` - `cd pinniped/deploy/supervisor` +1. Decide which release version you would like to install. All release versions are [listed on GitHub](https://github.com/vmware-tanzu/pinniped/releases). + +1. Checkout your preferred version tag, e.g. `v0.9.2`. + + - `git checkout v0.9.2` + + *Replace v0.9.2 with your preferred version number.* + 1. Customize configuration parameters: - Edit `values.yaml` with your custom values. + - Change the `image_tag` value to match your preferred version tag, e.g. `v0.9.2`. *Replace v0.9.2 with your preferred version number.* - 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: