Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix typo and improve readability of examples/kustomization_user_deploy/README.md #1312

Merged
merged 1 commit into from
Apr 9, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions examples/kustomization_user_deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@ Pretty sure I butchered a lot ;)

### Assuming you followed the `DO not Skip` part of the installation

In the project folder, where the `kube.tf` is located.<br>
Create a folder named `extra-manifests`<br>
In it create a file named `kustomization.yaml.tpl`<br>
and **your** manifest file(s), there names must be listed in the `kustomization.yaml.tpl` `recources` without the `.tpl`<br>
e.g. `some-random-name.yaml.tpl`
In the project folder, where the `kube.tf` is located:
1. Create a folder named `extra-manifests`.
2. In it create a file named `kustomization.yaml.tpl` and **your** manifest file(s). Be sure to use the `resources` field, in the `kustomization.yaml` file, to define the list of resources to include in a configuration.

## Apply the kustomized configuration

Expand All @@ -22,13 +20,17 @@ Assuming no errors have been made, apply this by run `terraform apply`<br>
In the highly unlikely case that an actual error has occurred...<br>
Anyway, you can rerun just the kustomization part like this:

terraform apply -replace='module.kube-hetzner.null_resource.kustomization_user["kustomization.yaml.tpl"]' --auto-approve
```sh
terraform apply -replace='module.kube-hetzner.null_resource.kustomization_user["kustomization.yaml.tpl"]' --auto-approve
```

Check what kustomization exists:

(⎈|dev3:default)➜ dev3-cluster (main) ✗ terraform state list | grep kustom
...
module.kube-hetzner.null_resource.kustomization
module.kube-hetzner.null_resource.kustomization_user["some-random-name.yaml.tpl"]
module.kube-hetzner.null_resource.kustomization_user["kustomization.yaml.tpl"]
...
```sh
(⎈|dev3:default)➜ dev3-cluster (main) ✗ terraform state list | grep kustom
...
module.kube-hetzner.null_resource.kustomization
module.kube-hetzner.null_resource.kustomization_user["some-random-name.yaml.tpl"]
module.kube-hetzner.null_resource.kustomization_user["kustomization.yaml.tpl"]
...
```