From 69adcf9aaf7ab032f4a387ad70048255f5294a98 Mon Sep 17 00:00:00 2001 From: Vignesh Subramanian Date: Tue, 30 Jun 2020 00:44:14 +0530 Subject: [PATCH] configMapGenerator docs content addition --- docs/api-reference/glossary/index.html | 6 +++--- docs/api-reference/index.html | 2 +- .../kustomization/bases/index.html | 2 +- .../kustomization/commonannotations/index.html | 2 +- .../kustomization/commonlabels/index.html | 2 +- .../kustomization/components/index.html | 2 +- .../configmapgenerator/index.html | 18 +++++++++++++----- .../kustomization/crds/index.html | 2 +- .../kustomization/generatoroptions/index.html | 2 +- .../kustomization/images/index.html | 2 +- docs/api-reference/kustomization/index.html | 2 +- docs/api-reference/kustomization/index.xml | 18 +++++++++++++----- .../kustomization/nameprefix/index.html | 2 +- .../kustomization/namespace/index.html | 2 +- .../kustomization/namesuffix/index.html | 2 +- .../kustomization/patches/index.html | 10 +++++----- .../kustomization/patchesjson6902/index.html | 6 +++--- .../patchesstrategicmerge/index.html | 6 +++--- .../kustomization/replicas/index.html | 2 +- .../kustomization/resources/index.html | 2 +- .../kustomization/secretegenerator/index.html | 2 +- .../kustomization/vars/index.html | 4 ++-- docs/blog/2018/05/21/v1.0.1/index.html | 2 +- docs/blog/2019/02/05/v2.0.0/index.html | 2 +- docs/blog/2019/06/18/v2.1.0/index.html | 2 +- docs/blog/2019/07/03/v3.0.0/index.html | 2 +- docs/blog/2019/07/26/v3.1.0/index.html | 2 +- docs/blog/2019/09/17/v3.2.0/index.html | 2 +- docs/blog/2019/09/26/v3.2.1/index.html | 2 +- docs/blog/2019/10/24/v3.3.0/index.html | 2 +- docs/blog/index.html | 2 +- docs/blog/releases/index.html | 2 +- docs/contributing/bugs/index.html | 2 +- docs/contributing/community/index.html | 2 +- docs/contributing/docs/index.html | 2 +- docs/contributing/features/index.html | 2 +- docs/contributing/howitworks/index.html | 2 +- docs/contributing/index.html | 2 +- docs/contributing/mac/index.html | 2 +- docs/contributing/windows/index.html | 2 +- docs/en/sitemap.xml | 4 ++-- docs/faq/eschewedfeatures/index.html | 2 +- docs/faq/index.html | 2 +- docs/faq/versioningpolicy/index.html | 2 +- docs/guides/bespoke/index.html | 2 +- docs/guides/index.html | 2 +- docs/guides/offtheshelf/index.html | 2 +- docs/guides/plugins/builtins/index.html | 2 +- .../plugins/execpluginguidedexample/index.html | 2 +- docs/guides/plugins/goplugincaveats/index.html | 2 +- .../plugins/gopluginguidedexample/index.html | 2 +- docs/guides/plugins/index.html | 8 +++----- docs/index.html | 2 +- docs/index.json | 2 +- docs/installation/binaries/index.html | 6 +++--- docs/installation/chocolatey/index.html | 2 +- docs/installation/homebrew/index.html | 2 +- docs/installation/index.html | 2 +- docs/installation/source/index.html | 2 +- docs/search/index.html | 2 +- docs/sitemap.xml | 2 +- docs/zh/api-reference/glossary/index.html | 2 +- docs/zh/api-reference/index.html | 2 +- .../kustomization/bases/index.html | 2 +- .../kustomization/commonannotations/index.html | 2 +- .../kustomization/commonlabels/index.html | 2 +- .../kustomization/components/index.html | 2 +- .../configmapgenerator/index.html | 16 +++++++++++++--- .../kustomization/crds/index.html | 2 +- .../kustomization/generatoroptions/index.html | 2 +- .../kustomization/images/index.html | 2 +- docs/zh/api-reference/kustomization/index.html | 2 +- docs/zh/api-reference/kustomization/index.xml | 14 ++++++++++++-- .../kustomization/nameprefix/index.html | 2 +- .../kustomization/namespace/index.html | 2 +- .../kustomization/namesuffix/index.html | 2 +- .../kustomization/patches/index.html | 10 +++++----- .../kustomization/patchesjson6902/index.html | 6 +++--- .../patchesstrategicmerge/index.html | 6 +++--- .../kustomization/replicas/index.html | 2 +- .../kustomization/resources/index.html | 2 +- .../kustomization/secretegenerator/index.html | 2 +- .../kustomization/vars/index.html | 2 +- docs/zh/blog/2018/05/21/v1.0.1/index.html | 2 +- docs/zh/blog/2019/02/05/v2.0.0/index.html | 2 +- docs/zh/blog/2019/06/18/v2.1.0/index.html | 2 +- docs/zh/blog/2019/07/03/v3.0.0/index.html | 2 +- docs/zh/blog/2019/07/26/v3.1.0/index.html | 2 +- docs/zh/blog/2019/09/17/v3.2.0/index.html | 2 +- docs/zh/blog/2019/09/26/v3.2.1/index.html | 2 +- docs/zh/blog/2019/10/24/v3.3.0/index.html | 2 +- docs/zh/blog/index.html | 2 +- docs/zh/blog/releases/index.html | 2 +- docs/zh/contributing/bugs/index.html | 2 +- docs/zh/contributing/community/index.html | 2 +- docs/zh/contributing/docs/index.html | 2 +- docs/zh/contributing/features/index.html | 2 +- docs/zh/contributing/howitworks/index.html | 2 +- docs/zh/contributing/index.html | 2 +- docs/zh/contributing/mac/index.html | 2 +- docs/zh/contributing/windows/index.html | 2 +- docs/zh/faq/eschewedfeatures/index.html | 2 +- docs/zh/faq/index.html | 2 +- docs/zh/faq/versioningpolicy/index.html | 2 +- docs/zh/guides/bespoke/index.html | 2 +- docs/zh/guides/index.html | 2 +- docs/zh/guides/offtheshelf/index.html | 2 +- docs/zh/guides/plugins/builtins/index.html | 2 +- .../plugins/execpluginguidedexample/index.html | 2 +- .../guides/plugins/goplugincaveats/index.html | 2 +- .../plugins/gopluginguidedexample/index.html | 2 +- docs/zh/guides/plugins/index.html | 2 +- docs/zh/index.html | 2 +- docs/zh/index.json | 2 +- docs/zh/installation/binaries/index.html | 2 +- docs/zh/installation/chocolatey/index.html | 2 +- docs/zh/installation/homebrew/index.html | 2 +- docs/zh/installation/index.html | 2 +- docs/zh/installation/source/index.html | 2 +- docs/zh/search/index.html | 2 +- docs/zh/sitemap.xml | 2 +- .../kustomization/configmapgenerator/_index.md | 14 ++++++++++---- .../kustomization/configmapgenerator/_index.md | 12 ++++++++++-- 123 files changed, 212 insertions(+), 164 deletions(-) diff --git a/docs/api-reference/glossary/index.html b/docs/api-reference/glossary/index.html index 352d7039f..a741f9b70 100644 --- a/docs/api-reference/glossary/index.html +++ b/docs/api-reference/glossary/index.html @@ -3,7 +3,7 @@ - + @@ -911,8 +911,8 @@ absolute path, or by relative path.

  • B may not depend on A, even transitively.

    • A may contain B, but in this case it might be -simplest to have A directly depend on B‘s -resources and eliminate B‘s kustomization.yaml file +simplest to have A directly depend on B’s +resources and eliminate B’s kustomization.yaml file (i.e. absorb B into A).

    Conventionally, B is in a directory that’s sibling to A, or B is off in a completely independent diff --git a/docs/api-reference/index.html b/docs/api-reference/index.html index 9a6c56f21..02023eb3e 100644 --- a/docs/api-reference/index.html +++ b/docs/api-reference/index.html @@ -3,7 +3,7 @@ - + diff --git a/docs/api-reference/kustomization/bases/index.html b/docs/api-reference/kustomization/bases/index.html index 506c65f08..d0d63ebe0 100644 --- a/docs/api-reference/kustomization/bases/index.html +++ b/docs/api-reference/kustomization/bases/index.html @@ -3,7 +3,7 @@ - + diff --git a/docs/api-reference/kustomization/commonannotations/index.html b/docs/api-reference/kustomization/commonannotations/index.html index aa289a555..4d9307aab 100644 --- a/docs/api-reference/kustomization/commonannotations/index.html +++ b/docs/api-reference/kustomization/commonannotations/index.html @@ -3,7 +3,7 @@ - + diff --git a/docs/api-reference/kustomization/commonlabels/index.html b/docs/api-reference/kustomization/commonlabels/index.html index 0b9a8b751..a6d1c0903 100644 --- a/docs/api-reference/kustomization/commonlabels/index.html +++ b/docs/api-reference/kustomization/commonlabels/index.html @@ -3,7 +3,7 @@ - + diff --git a/docs/api-reference/kustomization/components/index.html b/docs/api-reference/kustomization/components/index.html index 50b2a9df4..7f39afaf8 100644 --- a/docs/api-reference/kustomization/components/index.html +++ b/docs/api-reference/kustomization/components/index.html @@ -3,7 +3,7 @@ - + diff --git a/docs/api-reference/kustomization/configmapgenerator/index.html b/docs/api-reference/kustomization/configmapgenerator/index.html index dbc695dbc..b59c45e3a 100644 --- a/docs/api-reference/kustomization/configmapgenerator/index.html +++ b/docs/api-reference/kustomization/configmapgenerator/index.html @@ -3,7 +3,7 @@ - + @@ -748,9 +748,13 @@

    Generate ConfigMap resources.

    Each entry in this list results in the creation of one ConfigMap resource (it’s a generator of n maps).

    -

    The example below creates three ConfigMaps. One with the names and contents of -the given files, one with key/value as data, and a third which sets an -annotation and label via options for that single ConfigMap.

    +

    The example below creates four ConfigMaps:

    +

    Each configMapGenerator item accepts a parameter of behavior: [create|replace|merge]. This allows an overlay to modify or @@ -780,8 +784,12 @@ trump any attempt to locally override it.

    files: - application.properties - more.properties +- name: my-java-server-env-file-vars + envs: + - my-server-env.properties + - more-server-props.env - name: my-java-server-env-vars - literals: + literals: - JAVA_HOME=/opt/java/jdk - JAVA_TOOL_OPTIONS=-agentlib:hprof options: diff --git a/docs/api-reference/kustomization/crds/index.html b/docs/api-reference/kustomization/crds/index.html index bd8b7d090..d45b3768c 100644 --- a/docs/api-reference/kustomization/crds/index.html +++ b/docs/api-reference/kustomization/crds/index.html @@ -3,7 +3,7 @@ - + diff --git a/docs/api-reference/kustomization/generatoroptions/index.html b/docs/api-reference/kustomization/generatoroptions/index.html index 32fff010c..e9eb38507 100644 --- a/docs/api-reference/kustomization/generatoroptions/index.html +++ b/docs/api-reference/kustomization/generatoroptions/index.html @@ -3,7 +3,7 @@ - + diff --git a/docs/api-reference/kustomization/images/index.html b/docs/api-reference/kustomization/images/index.html index 9473f2599..80308c4a7 100644 --- a/docs/api-reference/kustomization/images/index.html +++ b/docs/api-reference/kustomization/images/index.html @@ -3,7 +3,7 @@ - + diff --git a/docs/api-reference/kustomization/index.html b/docs/api-reference/kustomization/index.html index 6778097a7..28c657e5f 100644 --- a/docs/api-reference/kustomization/index.html +++ b/docs/api-reference/kustomization/index.html @@ -3,7 +3,7 @@ - + diff --git a/docs/api-reference/kustomization/index.xml b/docs/api-reference/kustomization/index.xml index 735cc0c4a..c8f276610 100644 --- a/docs/api-reference/kustomization/index.xml +++ b/docs/api-reference/kustomization/index.xml @@ -199,9 +199,13 @@ resource has been applied to a cluster.</p> <p>Each entry in this list results in the creation of one ConfigMap resource (it&rsquo;s a generator of n maps).</p> -<p>The example below creates three ConfigMaps. One with the names and contents of -the given files, one with key/value as data, and a third which sets an -annotation and label via <code>options</code> for that single ConfigMap.</p> +<p>The example below creates four ConfigMaps:</p> +<ul> +<li>first, with the names and contents of the given files</li> +<li>second, with key/value as data using key/value pairs from files</li> +<li>third, also with key/value as data, directly specified using <code>literals</code></li> +<li>and a fourth, which sets an annotation and label via <code>options</code> for that single ConfigMap</li> +</ul> <p>Each configMapGenerator item accepts a parameter of <code>behavior: [create|replace|merge]</code>. This allows an overlay to modify or @@ -231,8 +235,12 @@ trump any attempt to locally override it.</p> </span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">files</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#f8f8f8;text-decoration:underline"> </span>- application.properties<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#f8f8f8;text-decoration:underline"> </span>- more.properties<span style="color:#f8f8f8;text-decoration:underline"> +</span><span style="color:#f8f8f8;text-decoration:underline"></span>- <span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>my-java-server-env-file-vars<span style="color:#f8f8f8;text-decoration:underline"> +</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">envs</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> +</span><span style="color:#f8f8f8;text-decoration:underline"> </span>- my-server-env.properties<span style="color:#f8f8f8;text-decoration:underline"> +</span><span style="color:#f8f8f8;text-decoration:underline"> </span>- more-server-props.env<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#f8f8f8;text-decoration:underline"></span>- <span style="color:#204a87;font-weight:bold">name</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span>my-java-server-env-vars<span style="color:#f8f8f8;text-decoration:underline"> -</span><span style="color:#f8f8f8;text-decoration:underline"> </span>literals<span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> +</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">literals</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#f8f8f8;text-decoration:underline"> </span>- JAVA_HOME=/opt/java/jdk<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#f8f8f8;text-decoration:underline"> </span>- JAVA_TOOL_OPTIONS=-agentlib<span style="color:#000;font-weight:bold">:</span>hprof<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">options</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> @@ -774,7 +782,7 @@ resources.</p> supported. No ints, bools, arrays etc. It&rsquo;s not possible to, say, extract the name of the image in container number 2 of some pod template.</p> -<p>A variable reference, i.e. the string &lsquo;$(FOO)', +<p>A variable reference, i.e. the string &lsquo;$(FOO)&rsquo;, can only be placed in particular fields of particular objects as specified by kustomize&rsquo;s configuration data.</p> diff --git a/docs/api-reference/kustomization/nameprefix/index.html b/docs/api-reference/kustomization/nameprefix/index.html index 6d9998cdb..862446fcb 100644 --- a/docs/api-reference/kustomization/nameprefix/index.html +++ b/docs/api-reference/kustomization/nameprefix/index.html @@ -3,7 +3,7 @@ - + diff --git a/docs/api-reference/kustomization/namespace/index.html b/docs/api-reference/kustomization/namespace/index.html index bf821e85c..5f7e4d0a5 100644 --- a/docs/api-reference/kustomization/namespace/index.html +++ b/docs/api-reference/kustomization/namespace/index.html @@ -3,7 +3,7 @@ - + diff --git a/docs/api-reference/kustomization/namesuffix/index.html b/docs/api-reference/kustomization/namesuffix/index.html index ab0243d46..c3b02e04b 100644 --- a/docs/api-reference/kustomization/namesuffix/index.html +++ b/docs/api-reference/kustomization/namesuffix/index.html @@ -3,7 +3,7 @@ - + diff --git a/docs/api-reference/kustomization/patches/index.html b/docs/api-reference/kustomization/patches/index.html index 7d23674cd..b13b13921 100644 --- a/docs/api-reference/kustomization/patches/index.html +++ b/docs/api-reference/kustomization/patches/index.html @@ -3,7 +3,7 @@ - + @@ -506,10 +506,10 @@