diff --git a/site/content/en/api-reference/_index.md b/site/content/en/api-reference/_index.md index 2b3f824b5..1c6be44dd 100644 --- a/site/content/en/api-reference/_index.md +++ b/site/content/en/api-reference/_index.md @@ -9,3 +9,5 @@ menu: description: > Reference for Kustomize client-side APIs --- + + \ No newline at end of file diff --git a/site/content/en/api-reference/glossary/_index.md b/site/content/en/api-reference/glossary/_index.md index 99f72748c..2c72782ff 100644 --- a/site/content/en/api-reference/glossary/_index.md +++ b/site/content/en/api-reference/glossary/_index.md @@ -7,6 +7,9 @@ description: > Glossary of terms --- + + + # Glossary [CRD spec]: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ diff --git a/site/content/en/api-reference/kustomization/_index.md b/site/content/en/api-reference/kustomization/_index.md index 29443fbff..c7c048d14 100644 --- a/site/content/en/api-reference/kustomization/_index.md +++ b/site/content/en/api-reference/kustomization/_index.md @@ -7,5 +7,6 @@ description: > kustomization.yaml fields and API --- + diff --git a/site/content/en/api-reference/kustomization/bases/_index.md b/site/content/en/api-reference/kustomization/bases/_index.md index 77d09108b..a2c61ecec 100644 --- a/site/content/en/api-reference/kustomization/bases/_index.md +++ b/site/content/en/api-reference/kustomization/bases/_index.md @@ -6,6 +6,8 @@ description: > Add resources from a kustomization dir. --- + + {{% pageinfo color="warning" %}} The `bases` field was deprecated in v2.1.0 {{% /pageinfo %}} diff --git a/site/content/en/api-reference/kustomization/commonannotations/_index.md b/site/content/en/api-reference/kustomization/commonannotations/_index.md index fe27b2155..af5becd99 100644 --- a/site/content/en/api-reference/kustomization/commonannotations/_index.md +++ b/site/content/en/api-reference/kustomization/commonannotations/_index.md @@ -6,6 +6,8 @@ description: > Add annotations to all resources. --- + + Add annotations to all resources. If the annotation key is already present on the resource, the value will be overridden. diff --git a/site/content/en/api-reference/kustomization/commonlabels/_index.md b/site/content/en/api-reference/kustomization/commonlabels/_index.md index 0186772a1..af840a2da 100644 --- a/site/content/en/api-reference/kustomization/commonlabels/_index.md +++ b/site/content/en/api-reference/kustomization/commonlabels/_index.md @@ -6,6 +6,9 @@ description: > Add labels and selectors to add all resources. --- + + + Add labels and selectors to all resources. If the label key already is present on the resource, the value will be overridden. diff --git a/site/content/en/api-reference/kustomization/components/_index.md b/site/content/en/api-reference/kustomization/components/_index.md index 7ba60f812..f0eca288e 100644 --- a/site/content/en/api-reference/kustomization/components/_index.md +++ b/site/content/en/api-reference/kustomization/components/_index.md @@ -6,4 +6,7 @@ description: > Compose kustomizations. --- + + + *Coming soon* diff --git a/site/content/en/api-reference/kustomization/configmapgenerator/_index.md b/site/content/en/api-reference/kustomization/configmapgenerator/_index.md index 7622890fe..4131e4c87 100644 --- a/site/content/en/api-reference/kustomization/configmapgenerator/_index.md +++ b/site/content/en/api-reference/kustomization/configmapgenerator/_index.md @@ -6,6 +6,9 @@ description: > Generate ConfigMap resources. --- + + + Each entry in this list results in the creation of one ConfigMap resource (it's a generator of n maps). diff --git a/site/content/en/api-reference/kustomization/crds/_index.md b/site/content/en/api-reference/kustomization/crds/_index.md index d2448ad06..e89031af8 100644 --- a/site/content/en/api-reference/kustomization/crds/_index.md +++ b/site/content/en/api-reference/kustomization/crds/_index.md @@ -6,6 +6,9 @@ description: > Adding CRD support --- + + + Each entry in this list should be a relative path to a file for custom resource definition (CRD). diff --git a/site/content/en/api-reference/kustomization/generatoroptions/_index.md b/site/content/en/api-reference/kustomization/generatoroptions/_index.md index 2f5fbde51..79719cd6f 100644 --- a/site/content/en/api-reference/kustomization/generatoroptions/_index.md +++ b/site/content/en/api-reference/kustomization/generatoroptions/_index.md @@ -7,6 +7,7 @@ description: > [Secret](/kustomize/api-reference/kustomization/secretgenerator) generators. --- + Additionally, generatorOptions can be set on a per resource level within each diff --git a/site/content/en/api-reference/kustomization/images/_index.md b/site/content/en/api-reference/kustomization/images/_index.md index f245b16df..6d9465ce6 100644 --- a/site/content/en/api-reference/kustomization/images/_index.md +++ b/site/content/en/api-reference/kustomization/images/_index.md @@ -6,6 +6,9 @@ description: > Modify the name, tags and/or digest for images. --- + + + Images modify the name, tags and/or digest for images without creating patches. E.g. Given this kubernetes Deployment fragment: diff --git a/site/content/en/api-reference/kustomization/nameprefix/_index.md b/site/content/en/api-reference/kustomization/nameprefix/_index.md index 5a2be7c38..eff83839a 100644 --- a/site/content/en/api-reference/kustomization/nameprefix/_index.md +++ b/site/content/en/api-reference/kustomization/nameprefix/_index.md @@ -6,6 +6,9 @@ description: > Prepends the value to the names of all resources and references. --- + + + ```yaml apiVersion: kustomize.config.k8s.io/v1beta1 kind: Kustomization diff --git a/site/content/en/api-reference/kustomization/namespace/_index.md b/site/content/en/api-reference/kustomization/namespace/_index.md index 1f8aabd29..ba5943ec1 100644 --- a/site/content/en/api-reference/kustomization/namespace/_index.md +++ b/site/content/en/api-reference/kustomization/namespace/_index.md @@ -6,6 +6,9 @@ description: > Adds namespace to all resources. --- + + + ```yaml apiVersion: kustomize.config.k8s.io/v1beta1 kind: Kustomization diff --git a/site/content/en/api-reference/kustomization/namesuffix/_index.md b/site/content/en/api-reference/kustomization/namesuffix/_index.md index 43f3eaa1e..a79fc7e3e 100644 --- a/site/content/en/api-reference/kustomization/namesuffix/_index.md +++ b/site/content/en/api-reference/kustomization/namesuffix/_index.md @@ -6,6 +6,9 @@ description: > Appends the value to the names of all resources and references. --- + + + ```yaml apiVersion: kustomize.config.k8s.io/v1beta1 kind: Kustomization diff --git a/site/content/en/api-reference/kustomization/patches/_index.md b/site/content/en/api-reference/kustomization/patches/_index.md index e499d2d84..21a4acf24 100644 --- a/site/content/en/api-reference/kustomization/patches/_index.md +++ b/site/content/en/api-reference/kustomization/patches/_index.md @@ -6,6 +6,9 @@ description: > Patch resources --- + + + [strategic merge]: /kustomize/api-reference/glossary#patchstrategicmerge [JSON]: /kustomize/api-reference/glossary#patchjson6902 diff --git a/site/content/en/api-reference/kustomization/patchesStrategicMerge/_index.md b/site/content/en/api-reference/kustomization/patchesStrategicMerge/_index.md index 0786e81da..58f47760d 100644 --- a/site/content/en/api-reference/kustomization/patchesStrategicMerge/_index.md +++ b/site/content/en/api-reference/kustomization/patchesStrategicMerge/_index.md @@ -6,6 +6,9 @@ description: > Patch resources using the strategic merge patch standard. --- + + + Each entry in this list should be either a relative file path or an inline content resolving to a partial or complete resource diff --git a/site/content/en/api-reference/kustomization/patchesjson6902/_index.md b/site/content/en/api-reference/kustomization/patchesjson6902/_index.md index fe748140a..932a1a7c2 100644 --- a/site/content/en/api-reference/kustomization/patchesjson6902/_index.md +++ b/site/content/en/api-reference/kustomization/patchesjson6902/_index.md @@ -6,6 +6,9 @@ description: > Patch resources using the [json 6902 standard](https://tools.ietf.org/html/rfc6902) --- + + + Each entry in this list should resolve to a kubernetes object and a JSON patch that will be applied to the object. The JSON patch is documented at diff --git a/site/content/en/api-reference/kustomization/replicas/_index.md b/site/content/en/api-reference/kustomization/replicas/_index.md index e21e5eb73..b021fbc95 100644 --- a/site/content/en/api-reference/kustomization/replicas/_index.md +++ b/site/content/en/api-reference/kustomization/replicas/_index.md @@ -6,6 +6,9 @@ description: > Change the number of replicas for a resource. --- + + + Given this kubernetes Deployment fragment: ``` diff --git a/site/content/en/api-reference/kustomization/resources/_index.md b/site/content/en/api-reference/kustomization/resources/_index.md index 3586b031f..12190a358 100644 --- a/site/content/en/api-reference/kustomization/resources/_index.md +++ b/site/content/en/api-reference/kustomization/resources/_index.md @@ -6,6 +6,9 @@ description: > Resources to include. --- + + + Each entry in this list must be a path to a _file_, or a path (or URL) referring to another kustomization _directory_, e.g. diff --git a/site/content/en/api-reference/kustomization/secretegenerator/_index.md b/site/content/en/api-reference/kustomization/secretegenerator/_index.md index 445b4d81f..49a1e05bf 100644 --- a/site/content/en/api-reference/kustomization/secretegenerator/_index.md +++ b/site/content/en/api-reference/kustomization/secretegenerator/_index.md @@ -6,6 +6,9 @@ description: > Generate Secret resources. --- + + + Each entry in the argument list results in the creation of one Secret resource (it's a generator of N secrets). This works like the [configMapGenerator](/kustomize/api-reference/kustomization/configmapgenerator). diff --git a/site/content/en/api-reference/kustomization/vars/_index.md b/site/content/en/api-reference/kustomization/vars/_index.md index 9cf96591c..d84d0157e 100644 --- a/site/content/en/api-reference/kustomization/vars/_index.md +++ b/site/content/en/api-reference/kustomization/vars/_index.md @@ -6,6 +6,9 @@ description: > Substitute name references. --- + + + Vars are used to capture text from one resource's field and insert that text elsewhere - a reflection feature. diff --git a/site/content/en/blog/_index.md b/site/content/en/blog/_index.md index 250a849c0..eda933bf5 100644 --- a/site/content/en/blog/_index.md +++ b/site/content/en/blog/_index.md @@ -5,3 +5,5 @@ menu: main: weight: 80 --- + + diff --git a/site/content/en/blog/releases/_index.md b/site/content/en/blog/releases/_index.md index ffae15b86..747493b71 100644 --- a/site/content/en/blog/releases/_index.md +++ b/site/content/en/blog/releases/_index.md @@ -4,3 +4,4 @@ linkTitle: "Releases" weight: 20 --- + diff --git a/site/content/en/contributing/_index.md b/site/content/en/contributing/_index.md index 2bd12baf7..028ae24e0 100644 --- a/site/content/en/contributing/_index.md +++ b/site/content/en/contributing/_index.md @@ -7,4 +7,7 @@ menu: weight: 99 --- + + + Follow are resources for Kustomize contributors. diff --git a/site/content/en/contributing/bugs/_index.md b/site/content/en/contributing/bugs/_index.md index a8a7ed4c8..6f4e17cdb 100644 --- a/site/content/en/contributing/bugs/_index.md +++ b/site/content/en/contributing/bugs/_index.md @@ -7,6 +7,8 @@ description: > How to file bugs and fix Kustomize bugs --- + + [krusty package]: https://github.com/kubernetes-sigs/kustomize/tree/master/api/krusty [reusable custom transformer test]: https://github.com/kubernetes-sigs/kustomize/tree/master/api/krusty/customconfigreusable_test.go diff --git a/site/content/en/contributing/community/_index.md b/site/content/en/contributing/community/_index.md index 4fd045497..f0c355400 100644 --- a/site/content/en/contributing/community/_index.md +++ b/site/content/en/contributing/community/_index.md @@ -7,6 +7,9 @@ description: > Joining SIG-CLI and the Kubernetes community --- + + + [CLI special interest group]: https://github.com/kubernetes/community/tree/master/sig-cli#cli-special-interest-group [contributor roles]: https://github.com/kubernetes/community/blob/master/community-membership.md#community-membership [mailing list]: https://groups.google.com/forum/#!forum/kubernetes-sig-cli diff --git a/site/content/en/contributing/docs/_index.md b/site/content/en/contributing/docs/_index.md index d57e48d8f..6d913b7f4 100644 --- a/site/content/en/contributing/docs/_index.md +++ b/site/content/en/contributing/docs/_index.md @@ -7,6 +7,9 @@ description: > How to make Kustomize docs contributions --- + + + Kustomize uses [Docsy](https://www.docsy.dev) for the site, and was forked from the [docsy-example](https://github.com/google/docsy-example) diff --git a/site/content/en/contributing/features/_index.md b/site/content/en/contributing/features/_index.md index d241a136a..cb19916aa 100644 --- a/site/content/en/contributing/features/_index.md +++ b/site/content/en/contributing/features/_index.md @@ -6,6 +6,8 @@ weight: 21 description: > How to contribute features --- + + [issue]: https://github.com/kubernetes-sigs/kustomize/issues [sig-cli]: /kustomize/contributing/community/ diff --git a/site/content/en/contributing/howitworks/_index.md b/site/content/en/contributing/howitworks/_index.md index 1e204efe4..364b12b85 100644 --- a/site/content/en/contributing/howitworks/_index.md +++ b/site/content/en/contributing/howitworks/_index.md @@ -7,6 +7,9 @@ description: > How to modify Kustomize --- + + + {{% pageinfo color="info" %}} To build kustomize using the locally modified modules, `replace` statements must be added to the `kustomize/go.mod`. diff --git a/site/content/en/contributing/mac/_index.md b/site/content/en/contributing/mac/_index.md index 0960c30ae..31f8d8911 100644 --- a/site/content/en/contributing/mac/_index.md +++ b/site/content/en/contributing/mac/_index.md @@ -6,6 +6,7 @@ weight: 50 description: > How to develop on MacOS --- + First install the tools to build and run tests diff --git a/site/content/en/contributing/windows/_index.md b/site/content/en/contributing/windows/_index.md index a0ec49a13..cc76a4255 100644 --- a/site/content/en/contributing/windows/_index.md +++ b/site/content/en/contributing/windows/_index.md @@ -7,6 +7,8 @@ description: > How to develop on Windows --- + + This is the PowerShell script to run all go tests for Kustomize on a windows based platform which mimics /build/pre-commit.sh ## Pre-Reqs diff --git a/site/content/en/faq/_index.md b/site/content/en/faq/_index.md index 6d6a471a2..a1e4e4728 100644 --- a/site/content/en/faq/_index.md +++ b/site/content/en/faq/_index.md @@ -7,6 +7,8 @@ menu: weight: 70 --- + + ## kubectl doesn't have the latest kustomize, when will it be updated? TLDR: This is blocked on either moving kubectl into its own repo, or changing its dependencies. ETA k8s ~1.20. diff --git a/site/content/en/faq/eschewedfeatures/_index.md b/site/content/en/faq/eschewedfeatures/_index.md index dc6332a14..7c53dfa86 100644 --- a/site/content/en/faq/eschewedfeatures/_index.md +++ b/site/content/en/faq/eschewedfeatures/_index.md @@ -7,6 +7,8 @@ description: > Eschewed Features --- + + The maintainers established this list to place bounds on the kustomize feature set. The bounds can be changed with diff --git a/site/content/en/faq/versioningPolicy.md b/site/content/en/faq/versioningPolicy.md index fa44f3937..c2ecddb3b 100644 --- a/site/content/en/faq/versioningPolicy.md +++ b/site/content/en/faq/versioningPolicy.md @@ -5,6 +5,8 @@ weight: 99 type: docs --- + + Running `kustomize` means one is running a particular version of a program (a CLI), using a particular version of underlying packages (a Go diff --git a/site/content/en/guides/_index.md b/site/content/en/guides/_index.md index e78b8f401..ee2c1b4ba 100644 --- a/site/content/en/guides/_index.md +++ b/site/content/en/guides/_index.md @@ -9,3 +9,4 @@ menu: description: > Reference for Kustomize usage and best practices --- + \ No newline at end of file diff --git a/site/content/en/guides/bespoke/_index.md b/site/content/en/guides/bespoke/_index.md index 9feb38eb2..f96f801ba 100644 --- a/site/content/en/guides/bespoke/_index.md +++ b/site/content/en/guides/bespoke/_index.md @@ -7,6 +7,9 @@ description: > Workflow for bespoke applications --- + + + In this workflow, all configuration (resource YAML) files are owned by the user. No content is incorporated from version control repositories owned by others. diff --git a/site/content/en/guides/components/_index.md b/site/content/en/guides/components/_index.md index 6bcaa7d0c..10cd329dc 100644 --- a/site/content/en/guides/components/_index.md +++ b/site/content/en/guides/components/_index.md @@ -6,6 +6,9 @@ description: > Kustomize components guide --- + + + As of ``v3.7.0`` Kustomize supports a special type of kustomization that allows one to define reusable pieces of configuration logic that can be included from multiple overlays. diff --git a/site/content/en/guides/offtheshelf/_index.md b/site/content/en/guides/offtheshelf/_index.md index 5694b0d8b..9aed80a10 100644 --- a/site/content/en/guides/offtheshelf/_index.md +++ b/site/content/en/guides/offtheshelf/_index.md @@ -7,6 +7,9 @@ description: > Workflow for off the shelf applications --- + + + In this workflow, all files are owned by the user and maintained in a repository under their control, but they are based on an [off-the-shelf] configuration that is periodically consulted for updates. diff --git a/site/content/en/guides/plugins/_index.md b/site/content/en/guides/plugins/_index.md index 095361844..9c60d55b1 100644 --- a/site/content/en/guides/plugins/_index.md +++ b/site/content/en/guides/plugins/_index.md @@ -7,6 +7,8 @@ description: > Kustomize plugins guide --- + + Kustomize offers a plugin framework allowing people to write their own resource _generators_ and _transformers_. diff --git a/site/content/en/guides/plugins/builtins.md b/site/content/en/guides/plugins/builtins.md index dba2bd8a1..4599635b0 100644 --- a/site/content/en/guides/plugins/builtins.md +++ b/site/content/en/guides/plugins/builtins.md @@ -6,6 +6,9 @@ description: > Builtin Plugins --- + + + # Builtin Plugins A list of kustomize's builtin plugins - both diff --git a/site/content/en/guides/plugins/execPluginGuidedExample.md b/site/content/en/guides/plugins/execPluginGuidedExample.md index 3b75514b1..ecd91c5dc 100644 --- a/site/content/en/guides/plugins/execPluginGuidedExample.md +++ b/site/content/en/guides/plugins/execPluginGuidedExample.md @@ -6,6 +6,9 @@ description: > Exec plugin on linux in 60 seconds --- + + + This is a (no reading allowed!) 60 second copy/paste guided example. Full plugin docs [here](..). diff --git a/site/content/en/guides/plugins/goPluginCaveats.md b/site/content/en/guides/plugins/goPluginCaveats.md index 74ce2f461..3a09a412c 100644 --- a/site/content/en/guides/plugins/goPluginCaveats.md +++ b/site/content/en/guides/plugins/goPluginCaveats.md @@ -6,6 +6,8 @@ description: > Go plugin Caveats --- + + [plugin package]: https://golang.org/pkg/plugin [Go modules]: https://github.com/golang/go/wiki/Modules [ELF]: https://en.wikipedia.org/wiki/Executable_and_Linkable_Format diff --git a/site/content/en/guides/plugins/goPluginGuidedExample.md b/site/content/en/guides/plugins/goPluginGuidedExample.md index 2591a3dca..e06b92f02 100644 --- a/site/content/en/guides/plugins/goPluginGuidedExample.md +++ b/site/content/en/guides/plugins/goPluginGuidedExample.md @@ -6,6 +6,9 @@ description: > Go plugin example --- + + + # Go Plugin Guided Example for Linux [SopsEncodedSecrets repository]: https://github.com/monopole/sopsencodedsecrets diff --git a/site/content/en/installation/_index.md b/site/content/en/installation/_index.md index a12e0984b..eacb9d161 100644 --- a/site/content/en/installation/_index.md +++ b/site/content/en/installation/_index.md @@ -7,3 +7,5 @@ menu: main: weight: 10 --- + + diff --git a/site/content/en/installation/binaries/_index.md b/site/content/en/installation/binaries/_index.md index e42958379..0e10a1799 100644 --- a/site/content/en/installation/binaries/_index.md +++ b/site/content/en/installation/binaries/_index.md @@ -7,6 +7,8 @@ description: > Install Kustomize by downloading precompiled binaries. --- + + Binaries at various versions for linux, MacOs and Windows are published on the [releases page]. The following [script] detects your OS and downloads the appropriate kustomize binary to your diff --git a/site/content/en/installation/chocolatey/_index.md b/site/content/en/installation/chocolatey/_index.md index e41f90371..e2e723608 100644 --- a/site/content/en/installation/chocolatey/_index.md +++ b/site/content/en/installation/chocolatey/_index.md @@ -7,6 +7,9 @@ description: > Install Kustomize for Windows using Chocolatey --- + + + ``` choco install kustomize ``` diff --git a/site/content/en/installation/homebrew/_index.md b/site/content/en/installation/homebrew/_index.md index 7d6c434d6..5e422f8fb 100644 --- a/site/content/en/installation/homebrew/_index.md +++ b/site/content/en/installation/homebrew/_index.md @@ -7,6 +7,9 @@ description: > Install Kustomize for MacOS using Homebrew or MacPorts --- + + + For [Homebrew](https://brew.sh) users: ``` diff --git a/site/content/en/installation/source/_index.md b/site/content/en/installation/source/_index.md index 2c44f95ea..f4099b6c1 100644 --- a/site/content/en/installation/source/_index.md +++ b/site/content/en/installation/source/_index.md @@ -7,6 +7,8 @@ description: > Install Kustomize from the Go source code --- + + Requires [Go] to be installed. ## Install the kustomize CLI from source without cloning the repo