From 399737e7c69fd71113c7f0b0c9a409b6dc01c921 Mon Sep 17 00:00:00 2001 From: Ryan Richard Date: Wed, 25 Aug 2021 14:33:48 -0700 Subject: [PATCH 1/2] Install docs use more GitOps-friendly style --- site/content/docs/howto/install-concierge.md | 43 +++++++++++++------ site/content/docs/howto/install-supervisor.md | 31 ++++++++++--- 2 files changed, 57 insertions(+), 17 deletions(-) diff --git a/site/content/docs/howto/install-concierge.md b/site/content/docs/howto/install-concierge.md index 5c8afd31..48ecf762 100644 --- a/site/content/docs/howto/install-concierge.md +++ b/site/content/docs/howto/install-concierge.md @@ -44,32 +44,51 @@ Pinniped uses [ytt](https://carvel.dev/ytt/) from [Carvel](https://carvel.dev/) 1. Install the `ytt` and `kapp` command-line tools using the instructions from the [Carvel documentation](https://carvel.dev/#whole-suite). -1. Clone the Pinniped GitHub repository and visit the `deploy/concierge` directory: +2. Clone the Pinniped GitHub repository and visit the `deploy/concierge` directory: - `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). +3. 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. `{{< latestversion >}}`. +4. Checkout your preferred version tag, e.g. `{{< latestversion >}}`. - `git checkout {{< latestversion >}}` -1. Customize configuration parameters: +5. 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](http://github.com/vmware-tanzu/pinniped/tree/main/deploy/concierge/values.yaml) for documentation about individual configuration parameters. + - See the [default values](http://github.com/vmware-tanzu/pinniped/tree/main/deploy/concierge/values.yaml) for documentation about individual configuration parameters. + For example, you can change the number of Concierge pods by setting `replicas` or apply custom annotations to the impersonation proxy service using `impersonation_proxy_spec`. - For example, you can change the number of Concierge pods by setting `replicas` or apply custom annotations to the impersonation proxy service using `impersonation_proxy_spec`. + - In a different directory, create a new YAML file to contain your site-specific configuration. For example, you might call this file `site/dev-env.yaml`. -1. Render templated YAML manifests: + In the file, add the special ytt comment for a values file and the YAML triple-dash which starts a new YAML document. + Then add custom overrides for any of the parameters from [`values.yaml`](http://github.com/vmware-tanzu/pinniped/tree/main/deploy/concierge/values.yaml). - - `ytt --file .` + Override the `image_tag` value to match your preferred version tag, e.g. `{{< latestversion >}}`, + to ensure that you use the version of the server which matches these templates. -1. Deploy the templated YAML manifests: + Here is an example which overrides the image tag, the default logging level, and the number of replicas: + ```yaml + #@data/values + --- + image_tag: {{< latestversion >}} + log_level: debug + replicas: 1 + ``` + - Parameters for which you would like to use the default value should be excluded from this file. - - `ytt --file . | kapp deploy --app pinniped-concierge --file -` + - If you are using a GitOps-style workflow to manage the installation of Pinniped, then you may wish to commit this new YAML file to your GitOps repository. + +6. Render templated YAML manifests: + + - `ytt --file . --file site/dev-env.yaml` + + By putting the override file last in the list of `--file` options, it will override the default values. + +7. Deploy the templated YAML manifests: + + - `ytt --file . --file site/dev-env.yaml | kapp deploy --app pinniped-concierge --file -` ## Next steps diff --git a/site/content/docs/howto/install-supervisor.md b/site/content/docs/howto/install-supervisor.md index d2ca21e0..9ee5491d 100644 --- a/site/content/docs/howto/install-supervisor.md +++ b/site/content/docs/howto/install-supervisor.md @@ -49,17 +49,38 @@ Pinniped uses [ytt](https://carvel.dev/ytt/) from [Carvel](https://carvel.dev/) 1. 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](http://github.com/vmware-tanzu/pinniped/tree/main/deploy/supervisor/values.yaml) for documentation about individual configuration parameters. + - See the [default values](http://github.com/vmware-tanzu/pinniped/tree/main/deploy/supervisor/values.yaml) for documentation about individual configuration parameters. + For example, you can change the number of Concierge pods by setting `replicas` or apply custom annotations to the impersonation proxy service using `impersonation_proxy_spec`. + + - In a different directory, create a new YAML file to contain your site-specific configuration. For example, you might call this file `site/dev-env.yaml`. + + In the file, add the special ytt comment for a values file and the YAML triple-dash which starts a new YAML document. + Then add custom overrides for any of the parameters from [`values.yaml`](http://github.com/vmware-tanzu/pinniped/tree/main/deploy/supervisor/values.yaml). + + Override the `image_tag` value to match your preferred version tag, e.g. `{{< latestversion >}}`, + to ensure that you use the version of the server which matches these templates. + + Here is an example which overrides the image tag, the default logging level, and the number of replicas: + ```yaml + #@data/values + --- + image_tag: {{< latestversion >}} + log_level: debug + replicas: 1 + ``` + - Parameters for which you would like to use the default value should be excluded from this file. + + - If you are using a GitOps-style workflow to manage the installation of Pinniped, then you may wish to commit this new YAML file to your GitOps repository. 1. Render templated YAML manifests: - - `ytt --file .` + - `ytt --file . --file site/dev-env.yaml` + + By putting the override file last in the list of `--file` options, it will override the default values. 1. Deploy the templated YAML manifests: - `ytt --file . | kapp deploy --app pinniped-supervisor --file -` + `ytt --file . --file site/dev-env.yaml | kapp deploy --app pinniped-supervisor --file -` ## Next steps From 86bfd4f5e4788697a3d2c95e1b6066871e726039 Mon Sep 17 00:00:00 2001 From: Ryan Richard Date: Wed, 25 Aug 2021 16:37:36 -0700 Subject: [PATCH 2/2] Number each install step using "1." --- site/content/docs/howto/install-concierge.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/site/content/docs/howto/install-concierge.md b/site/content/docs/howto/install-concierge.md index 48ecf762..b6ad47e7 100644 --- a/site/content/docs/howto/install-concierge.md +++ b/site/content/docs/howto/install-concierge.md @@ -44,18 +44,18 @@ Pinniped uses [ytt](https://carvel.dev/ytt/) from [Carvel](https://carvel.dev/) 1. Install the `ytt` and `kapp` command-line tools using the instructions from the [Carvel documentation](https://carvel.dev/#whole-suite). -2. Clone the Pinniped GitHub repository and visit the `deploy/concierge` directory: +1. Clone the Pinniped GitHub repository and visit the `deploy/concierge` directory: - `git clone git@github.com:vmware-tanzu/pinniped.git` - `cd pinniped/deploy/concierge` -3. Decide which release version you would like to install. All release versions are [listed on GitHub](https://github.com/vmware-tanzu/pinniped/releases). +1. Decide which release version you would like to install. All release versions are [listed on GitHub](https://github.com/vmware-tanzu/pinniped/releases). -4. Checkout your preferred version tag, e.g. `{{< latestversion >}}`. +1. Checkout your preferred version tag, e.g. `{{< latestversion >}}`. - `git checkout {{< latestversion >}}` -5. Customize configuration parameters: +1. Customize configuration parameters: - See the [default values](http://github.com/vmware-tanzu/pinniped/tree/main/deploy/concierge/values.yaml) for documentation about individual configuration parameters. For example, you can change the number of Concierge pods by setting `replicas` or apply custom annotations to the impersonation proxy service using `impersonation_proxy_spec`. @@ -80,13 +80,13 @@ Pinniped uses [ytt](https://carvel.dev/ytt/) from [Carvel](https://carvel.dev/) - If you are using a GitOps-style workflow to manage the installation of Pinniped, then you may wish to commit this new YAML file to your GitOps repository. -6. Render templated YAML manifests: +1. Render templated YAML manifests: - `ytt --file . --file site/dev-env.yaml` By putting the override file last in the list of `--file` options, it will override the default values. -7. Deploy the templated YAML manifests: +1. Deploy the templated YAML manifests: - `ytt --file . --file site/dev-env.yaml | kapp deploy --app pinniped-concierge --file -`