kubernetes-sigs/kustomize
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/kustomize.git synced 2026-06-30 01:46:23 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Build kustomize docs site with redirects to new unified at cli-experimental

Browse Source
This commit is contained in:
Phillip Wittrock
2020-11-04 11:18:56 -08:00
parent 0834e152b2
commit 4d99217a7c
154 changed files with 13057 additions and 2414 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
docs/guides/plugins/index.xml
View File

@@ -22,7 +22,8 @@
<description>
&lt;h1 id=&#34;builtin-plugins&#34;&gt;Builtin Plugins&lt;/h1&gt;
&lt;meta http-equiv=&#34;refresh&#34; content=&#34;0; url=https://kubectl.docs.kubernetes.io/guides/extending_kustomize/builtins&#34; /&gt;
&lt;h1 id=&#34;builtin-plugins&#34;&gt;Builtin Plugins&lt;/h1&gt;
&lt;p&gt;A list of kustomize&amp;rsquo;s builtin plugins - both
generators and transformers.&lt;/p&gt;
&lt;p&gt;For each plugin, an example is given for&lt;/p&gt;
@@ -42,7 +43,7 @@ plugin).&lt;/p&gt;
&lt;/ul&gt;
&lt;p&gt;The former method is convenient but limited in
power as most of the plugins arguments must
be defaulted. The latter method allows for
be defaulted. The latter method allows for
complete plugin argument specification.&lt;/p&gt;
&lt;h2 id=&#34;_annotationtransformer_&#34;&gt;&lt;em&gt;AnnotationTransformer&lt;/em&gt;&lt;/h2&gt;
&lt;h3 id=&#34;usage-via-kustomizationyaml&#34;&gt;Usage via &lt;code&gt;kustomization.yaml&lt;/code&gt;&lt;/h3&gt;
@@ -56,7 +57,7 @@ pairs.&lt;/p&gt;
&lt;h4 id=&#34;arguments&#34;&gt;Arguments&lt;/h4&gt;
&lt;blockquote&gt;
&lt;p&gt;Annotations map[string]string&lt;/p&gt;
&lt;p&gt;FieldSpecs []&lt;a href=&#34;https://github.com/kubernetes-sigs/kustomize/tree/master/api/types/fieldspec.go&#34;&gt;config.FieldSpec&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;FieldSpecs []&lt;a href=&#34;https://github.com/kubernetes-sigs/kustomize/tree/master/api/types/fieldspec.go&#34;&gt;config.FieldSpec&lt;/a&gt;&lt;/p&gt;
&lt;/blockquote&gt;
&lt;h4 id=&#34;example&#34;&gt;Example&lt;/h4&gt;
&lt;blockquote&gt;
@@ -90,7 +91,7 @@ annotations to the generated instance, or to individually
disable the name suffix hash for that instance.
Labels and annotations added here will not be overwritten
by the global options associated with the kustomization
file &lt;code&gt;generatorOptions&lt;/code&gt; field. However, due to how
file &lt;code&gt;generatorOptions&lt;/code&gt; field. However, due to how
booleans behave, if the global &lt;code&gt;generatorOptions&lt;/code&gt; field
specifies &lt;code&gt;disableNameSuffixHash: true&lt;/code&gt;, this will
trump any attempt to locally override it.&lt;/p&gt;
@@ -106,7 +107,7 @@ configMapGenerator:
- application.properties
- more.properties
- name: my-java-server-env-vars
literals:
literals:
- JAVA_HOME=/opt/java/jdk
- JAVA_TOOL_OPTIONS=-agentlib:hprof
options:
@@ -154,7 +155,7 @@ literals:
&lt;h3 id=&#34;usage-via-kustomizationyaml-2&#34;&gt;Usage via &lt;code&gt;kustomization.yaml&lt;/code&gt;&lt;/h3&gt;
&lt;h4 id=&#34;field-name-images&#34;&gt;field name: &lt;code&gt;images&lt;/code&gt;&lt;/h4&gt;
&lt;p&gt;Images modify the name, tags and/or digest for images
without creating patches. E.g. Given this
without creating patches. E.g. Given this
kubernetes Deployment fragment:&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;containers:
- name: mypostgresdb
@@ -186,7 +187,7 @@ kubernetes Deployment fragment:&lt;/p&gt;
&lt;/code&gt;&lt;/pre&gt;&lt;h3 id=&#34;usage-via-plugin-2&#34;&gt;Usage via plugin&lt;/h3&gt;
&lt;h4 id=&#34;arguments-2&#34;&gt;Arguments&lt;/h4&gt;
&lt;blockquote&gt;
&lt;p&gt;ImageTag &lt;a href=&#34;https://github.com/kubernetes-sigs/kustomize/tree/master/api/types/image.go&#34;&gt;image.Image&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;ImageTag &lt;a href=&#34;https://github.com/kubernetes-sigs/kustomize/tree/master/api/types/image.go&#34;&gt;image.Image&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;FieldSpecs []&lt;a href=&#34;https://github.com/kubernetes-sigs/kustomize/tree/master/api/types/fieldspec.go&#34;&gt;config.FieldSpec&lt;/a&gt;&lt;/p&gt;
&lt;/blockquote&gt;
&lt;h4 id=&#34;example-2&#34;&gt;Example&lt;/h4&gt;
@@ -210,7 +211,7 @@ imageTag:
&lt;/code&gt;&lt;/pre&gt;&lt;h3 id=&#34;usage-via-plugin-3&#34;&gt;Usage via plugin&lt;/h3&gt;
&lt;h4 id=&#34;arguments-3&#34;&gt;Arguments&lt;/h4&gt;
&lt;blockquote&gt;
&lt;p&gt;Labels map[string]string&lt;/p&gt;
&lt;p&gt;Labels map[string]string&lt;/p&gt;
&lt;p&gt;FieldSpecs []&lt;a href=&#34;https://github.com/kubernetes-sigs/kustomize/tree/master/api/types/fieldspec.go&#34;&gt;config.FieldSpec&lt;/a&gt;&lt;/p&gt;
&lt;/blockquote&gt;
&lt;h4 id=&#34;example-3&#34;&gt;Example&lt;/h4&gt;
@@ -304,7 +305,7 @@ The content in this patch file can be either in JSON format as&lt;/p&gt;
&lt;h4 id=&#34;arguments-5&#34;&gt;Arguments&lt;/h4&gt;
&lt;blockquote&gt;
&lt;p&gt;Target &lt;a href=&#34;https://github.com/kubernetes-sigs/kustomize/tree/master/api/types/patchtarget.go&#34;&gt;types.PatchTarget&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;Path string&lt;/p&gt;
&lt;p&gt;Path string&lt;/p&gt;
&lt;p&gt;JsonOp string&lt;/p&gt;
&lt;/blockquote&gt;
&lt;h4 id=&#34;example-5&#34;&gt;Example&lt;/h4&gt;
@@ -329,11 +330,11 @@ resolving to a partial or complete resource
definition.&lt;/p&gt;
&lt;p&gt;The names in these (possibly partial) resource
files must match names already loaded via the
&lt;code&gt;resources&lt;/code&gt; field. These entries are used to
&lt;code&gt;resources&lt;/code&gt; field. These entries are used to
&lt;em&gt;patch&lt;/em&gt; (modify) the known resources.&lt;/p&gt;
&lt;p&gt;Small patches that do one thing are best, e.g. modify
a memory request/limit, change an env var in a
ConfigMap, etc. Small patches are easy to review and
ConfigMap, etc. Small patches are easy to review and
easy to mix together in overlays.&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;patchesStrategicMerge:
- service_port_8888.yaml
@@ -426,7 +427,7 @@ target:
&lt;p&gt;Prepends or postfixes the value to the names
of all resources.&lt;/p&gt;
&lt;p&gt;E.g. a deployment named &lt;code&gt;wordpress&lt;/code&gt; could
become &lt;code&gt;alices-wordpress&lt;/code&gt; or &lt;code&gt;wordpress-v2&lt;/code&gt;
become &lt;code&gt;alices-wordpress&lt;/code&gt; or &lt;code&gt;wordpress-v2&lt;/code&gt;
or &lt;code&gt;alices-wordpress-v2&lt;/code&gt;.&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;namePrefix: alices-
nameSuffix: -v2
@@ -435,8 +436,8 @@ the resource type is ConfigMap or Secret.&lt;/p&gt;
&lt;h3 id=&#34;usage-via-plugin-8&#34;&gt;Usage via plugin&lt;/h3&gt;
&lt;h4 id=&#34;arguments-8&#34;&gt;Arguments&lt;/h4&gt;
&lt;blockquote&gt;
&lt;p&gt;Prefix string&lt;/p&gt;
&lt;p&gt;Suffix string&lt;/p&gt;
&lt;p&gt;Prefix string&lt;/p&gt;
&lt;p&gt;Suffix string&lt;/p&gt;
&lt;p&gt;FieldSpecs []&lt;a href=&#34;https://github.com/kubernetes-sigs/kustomize/tree/master/api/types/fieldspec.go&#34;&gt;config.FieldSpec&lt;/a&gt;&lt;/p&gt;
&lt;/blockquote&gt;
&lt;h4 id=&#34;example-8&#34;&gt;Example&lt;/h4&gt;
@@ -558,6 +559,63 @@ files:
literals:
- FRUIT=apple
- VEGETABLE=carrot
&lt;/code&gt;&lt;/pre&gt;&lt;/blockquote&gt;
&lt;h2 id=&#34;_helmchartinflationgenerator_&#34;&gt;&lt;em&gt;HelmChartInflationGenerator&lt;/em&gt;&lt;/h2&gt;
&lt;h3 id=&#34;usage-via-kustomizationyaml-11&#34;&gt;Usage via &lt;code&gt;kustomization.yaml&lt;/code&gt;&lt;/h3&gt;
&lt;h4 id=&#34;field-name-helmchartinflationgenerator&#34;&gt;field name: &lt;code&gt;helmChartInflationGenerator&lt;/code&gt;&lt;/h4&gt;
&lt;p&gt;Each entry in the argument list results in the pulling
and rendering of a helm chart.&lt;/p&gt;
&lt;p&gt;Each entry can have following fields:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;chartName&lt;/code&gt;: The name of the chart that you want to use.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;chartRepoUrl&lt;/code&gt;: [Optional] The URL of the repository which contains the chart. If
this is provided, the plugin will try to fetch remote charts. Otherwise it will
try to load local chart in &lt;code&gt;chartHome&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;chartVersion&lt;/code&gt;: [Optional] Version of the chart. Will use latest version
if this is omitted.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;chartHome&lt;/code&gt;: [Optional] Provide the path to the parent directory for local chart.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;chartRelease&lt;/code&gt;: [Optional] The name of the repo where to find the chart.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;values&lt;/code&gt;: [Optional] A path to the values file.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;releaseName&lt;/code&gt;: [Optional] The release name that will be set in the chart.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;releaseNamespace&lt;/code&gt;: [Optional] The namespace which will be used by &lt;code&gt;--namespace&lt;/code&gt;
flag in &lt;code&gt;helm template&lt;/code&gt; command.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;helmBin&lt;/code&gt;: [Optional] Path to helm binary. Default is &lt;code&gt;helm&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;&lt;code&gt;helmHome&lt;/code&gt;: [Optional] Path to helm home directory.&lt;/li&gt;
&lt;/ul&gt;
&lt;pre&gt;&lt;code&gt;helmChartInflationGenerator:
- chartName: minecraft
chartRepoUrl: https://kubernetes-charts.storage.googleapis.com
chartVersion: v1.2.0
releaseName: test
releaseNamespace: testNamespace
&lt;/code&gt;&lt;/pre&gt;&lt;h3 id=&#34;usage-via-plugin-11&#34;&gt;Usage via plugin&lt;/h3&gt;
&lt;h4 id=&#34;arguments-11&#34;&gt;Arguments&lt;/h4&gt;
&lt;blockquote&gt;
&lt;p&gt;ChartName string&lt;/p&gt;
&lt;p&gt;ChartVersion string&lt;/p&gt;
&lt;p&gt;ChartRepoURL string&lt;/p&gt;
&lt;p&gt;ChartHome string&lt;/p&gt;
&lt;p&gt;ChartRepoName string&lt;/p&gt;
&lt;p&gt;HelmBin string&lt;/p&gt;
&lt;p&gt;HelmHome string&lt;/p&gt;
&lt;p&gt;Values string&lt;/p&gt;
&lt;p&gt;ReleaseName string&lt;/p&gt;
&lt;p&gt;ReleaseNamespace string&lt;/p&gt;
&lt;/blockquote&gt;
&lt;h4 id=&#34;example-11&#34;&gt;Example&lt;/h4&gt;
&lt;blockquote&gt;
&lt;pre&gt;&lt;code&gt;apiVersion: builtin
kind: HelmChartInflationGenerator
metadata:
name: myMap
chartName: minecraft
chartRepoUrl: https://kubernetes-charts.storage.googleapis.com
chartVersion: v1.2.0
helmBin: /usr/bin/helm
helmHome: /tmp/helmHome
releaseName: test
releaseNamespace: testNamespace
values: values.yaml
&lt;/code&gt;&lt;/pre&gt;&lt;/blockquote&gt;
</description>
@@ -572,7 +630,8 @@ literals:
<description>
&lt;p&gt;This is a (no reading allowed!) 60 second copy/paste guided
&lt;meta http-equiv=&#34;refresh&#34; content=&#34;0; url=https://kubectl.docs.kubernetes.io/guides/extending_kustomize/execpluginguidedexample&#34; /&gt;
&lt;p&gt;This is a (no reading allowed!) 60 second copy/paste guided
example. Full plugin docs &lt;a href=&#34;..&#34;&gt;here&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;This demo writes and uses a somewhat ridiculous
&lt;em&gt;exec&lt;/em&gt; plugin (written in bash) that generates a
@@ -739,7 +798,8 @@ mv kustomize $DEMO/bin
<description>
&lt;p&gt;A &lt;em&gt;Go plugin&lt;/em&gt; is a compilation artifact described
&lt;meta http-equiv=&#34;refresh&#34; content=&#34;0; url=https://kubectl.docs.kubernetes.io/guides/extending_kustomize/goplugincaveats&#34; /&gt;
&lt;p&gt;A &lt;em&gt;Go plugin&lt;/em&gt; is a compilation artifact described
by the Go &lt;a href=&#34;https://golang.org/pkg/plugin&#34;&gt;plugin package&lt;/a&gt;. It is built with
special flags and cannot run on its own.
It must be loaded into a running Go program.&lt;/p&gt;
@@ -836,7 +896,8 @@ plugin vs host dependencies.&lt;/p&gt;
<description>
&lt;h1 id=&#34;go-plugin-guided-example-for-linux&#34;&gt;Go Plugin Guided Example for Linux&lt;/h1&gt;
&lt;meta http-equiv=&#34;refresh&#34; content=&#34;0; url=https://kubectl.docs.kubernetes.io/guides/extending_kustomize/gopluginguidedexample&#34; /&gt;
&lt;h1 id=&#34;go-plugin-guided-example-for-linux&#34;&gt;Go Plugin Guided Example for Linux&lt;/h1&gt;
&lt;p&gt;This is a (no reading allowed!) 60 second copy/paste guided
example.&lt;/p&gt;
&lt;p&gt;Full plugin docs &lt;a href=&#34;README.md&#34;&gt;here&lt;/a&gt;.