Doc updates

This commit is contained in:
Ryan Richard
2020-08-27 10:14:03 -07:00
parent 9440316c20
commit 1375df185d
4 changed files with 80 additions and 66 deletions
+10 -6
View File
@@ -1,11 +1,15 @@
# Deploying
This example deployment uses `ytt` and `kapp` from [k14s.io](https://k14s.io/).
## Tools
If you would rather not install these command-line tools directly on your machine,
you can alternatively use the most recent version of this container image:
https://hub.docker.com/r/k14s/image/tags
This example deployment uses `ytt` from [Carvel](https://carvel.dev/) to template the YAML files.
Either [install `ytt`](https://get-ytt.io/) or use the [container image from Dockerhub](https://hub.docker.com/r/k14s/image/tags).
1. Fill in the values in [values.yml](values.yaml)
## Procedure
1. The configuration options are in [values.yml](values.yaml). Fill in the values in that file, or override those values
using `ytt` command-line options in the command below.
2. In a terminal, cd to this `deploy` directory
3. Run: `ytt --file . | kapp deploy --yes --app pinniped --diff-changes --file -`
3. To generate the final YAML files, run: `ytt --file .`
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 -`
+1 -2
View File
@@ -5,8 +5,7 @@
---
app_name: pinniped
namespace: #! e.g. pinniped
namespace: pinniped
#! Specify either an image_digest or an image_tag. If both are given, only image_digest will be used.
image_repo: #! e.g. registry.example.com/your-project-name/repo-name