From bb8bc875b4183a98fcc00c6c1effe064789d68b5 Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Thu, 11 Feb 2021 12:22:21 +0100 Subject: [PATCH] docs: improve Kustomize behavior FAQ - Fix the formatting of the list. - Add a hint block for validating changes locally and/or in CI. Signed-off-by: Hidde Beydals --- docs/faq/index.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/faq/index.md b/docs/faq/index.md index 742a1d82..4c04f0fd 100644 --- a/docs/faq/index.md +++ b/docs/faq/index.md @@ -153,12 +153,18 @@ cd ./deploy/prod && kustomize create --autodetect --recursive ### What is the behavior of Kustomize used by Flux We referred to the Kustomization CLI flags here, so that you can replicate the same behavior using the CLI. The behavior of Kustomize used by the controller is currently configured as following: - - `--allow_id_changes` is set to false, so it does not change any resource IDs. - - `--enable_kyaml` is disabled by default, so it currently used `k8sdeps` to process YAMLs. - - `--enable_alpha_plugins` is disabled by default, so it uses only the built-in plugins. - - `--load_restrictor` is set to `LoadRestrictionsNone`, so it allows loading files outside the dir containing `kustomization.yaml`. - - `--reorder` resources is done in the `legacy` mode, so they will be Namespaces and Cluster roles/role bindings first, CRDs before CRs, Webhooks last in the output. +- `--allow_id_changes` is set to false, so it does not change any resource IDs. +- `--enable_kyaml` is disabled by default, so it currently used `k8sdeps` to process YAMLs. +- `--enable_alpha_plugins` is disabled by default, so it uses only the built-in plugins. +- `--load_restrictor` is set to `LoadRestrictionsNone`, so it allows loading files outside the dir containing `kustomization.yaml`. +- `--reorder` resources is done in the `legacy` mode, so the output will have namespaces and cluster roles/role bindings first, CRDs before CRs, and webhooks last. + +!!! hint "`kustomization.yaml` validation" + To validate changes before committing and/or merging, [a validation + utility script is available](https://github.com/fluxcd/flux2-kustomize-helm-example/blob/main/scripts/validate.sh), + it runs `kustomize` locally or in CI with the same set of flags as + the controller and validates the output using `kubeval`. ## Helm questions