mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-07-17 09:49:13 +00:00
generate site
This commit is contained in:
Syam Sundar K
@@ -3,7 +3,7 @@
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
|
||||
<meta name="generator" content="Hugo 0.76.5" />
|
||||
<meta name="generator" content="Hugo 0.74.3" />
|
||||
|
||||
<META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">
|
||||
|
||||
@@ -39,8 +39,8 @@
|
||||
|
||||
|
||||
|
||||
<link rel="preload" href="/kustomize/scss/main.min.0084926537b5667d9dea1d1fd692923ad85f8bcab133e53e7ec8af9ce8dd2ca5.css" as="style">
|
||||
<link href="/kustomize/scss/main.min.0084926537b5667d9dea1d1fd692923ad85f8bcab133e53e7ec8af9ce8dd2ca5.css" rel="stylesheet" integrity="">
|
||||
<link rel="preload" href="/kustomize/scss/main.min.818a933df0186c907f1faea6730835dd5fa01c3b53af36bb68396dc80a2d3c45.css" as="style">
|
||||
<link href="/kustomize/scss/main.min.818a933df0186c907f1faea6730835dd5fa01c3b53af36bb68396dc80a2d3c45.css" rel="stylesheet" integrity="">
|
||||
|
||||
|
||||
<script
|
||||
@@ -335,25 +335,6 @@
|
||||
|
||||
|
||||
|
||||
<nav id="TableOfContents">
|
||||
<ul>
|
||||
<li><a href="#kustomizationyaml-的格式"><code>kustomization.yaml</code> 的格式</a></li>
|
||||
<li><a href="#配置">配置</a></li>
|
||||
<li><a href="#植入">植入</a></li>
|
||||
<li><a href="#执行情况">执行情况</a>
|
||||
<ul>
|
||||
<li></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#编写插件">编写插件</a>
|
||||
<ul>
|
||||
<li><a href="#exec-插件">Exec 插件</a></li>
|
||||
<li><a href="#go-插件">Go 插件</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
@@ -389,162 +370,9 @@
|
||||
<div class="td-content">
|
||||
<h1>Kustomize 插件</h1>
|
||||
<div class="lead">Kustomize 插件指南</div>
|
||||
<p>Kustomize 提供一个插件框架，允许用户开发自己的 <em>生成器</em> 和 <em>转化器</em>。</p>
|
||||
<p>通过插件，实现 [generatorOptions] 和 [transformerconfigs] 无法满足的需求。</p>
|
||||
<ul>
|
||||
<li><em>generator</em> 插件生成 k8s 资源，比如 <a href="https://github.com/kubernetes-sigs/kustomize/tree/master/plugin/someteam.example.com/v1/chartinflator">helm chart inflator</a> 是一个 generator 插件，基于少量自由变量生成一个 <a href="https://12factor.net">12-factor</a> 应用所包含的全部组件 deployment，service，scaler，ingress 等）也是一个 generator 插件。</li>
|
||||
<li><em>transformer</em> 插件转化（修改）k8s 资源，比如可能会执行对特殊容器命令行的编辑，或为其他内置转换器（<code>namePrefix</code>、<code>commonLabels</code> 等）无法转换的内容提供转换。</li>
|
||||
</ul>
|
||||
<h2 id="kustomizationyaml-的格式"><code>kustomization.yaml</code> 的格式</h2>
|
||||
<p>从为添加 <code>generators</code> 或 <code>transformers</code> 字段开始。</p>
|
||||
<p>字段内容为一个 string list：</p>
|
||||
<blockquote>
|
||||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">generators</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>- <span style="color:#000">relative/path/to/some/file.yaml</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>- <span style="color:#000">relative/path/to/some/kustomization</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>- <span style="color:#000">/absolute/path/to/some/kustomization</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline"></span>- <span style="color:#000">https://github.com/org/repo/some/kustomization</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">transformers</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>- {<span style="color:#000">as above}</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span></code></pre></div></blockquote>
|
||||
<p>格式要求与 <code>resources</code> 字段相同，<code>generators</code> 或 <code>transformers</code> 列表的每一列内容都必须是一个 YAML 文件的相对路径或者指向 <a href="/kustomize/zh/api-reference/glossary#kustomization">kustomization</a> 的 URL。</p>
|
||||
<p>从磁盘上读取 YAML 文件，kustomization 的路径或 URL 会触发 kustomization 的运行。由此产生的每个的对象都会被 kustomize 进一步解析为 <em>plugin configuration</em> 对象。</p>
|
||||
<h2 id="配置">配置</h2>
|
||||
<p>kustomization 文件可以包含如下内容：</p>
|
||||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">generators</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>- <span style="color:#000">chartInflator.yaml</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span></code></pre></div><p>像这样，kustomization 进程将在 <a href="glossary.md#kustomization-root">kustomization root</a> 下寻找到一个名为 <code>chartInflator.yaml</code> 的文件。</p>
|
||||
<p><code>chartInflator.yaml</code> 为插件配置文件，该文件包含 YAML 配置对象，内容如下：</p>
|
||||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">someteam.example.com/v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">ChartInflator</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">metadata</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><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><span style="color:#000">notImportantHere</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">chartName</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">minecraft</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span></code></pre></div><p><strong><code>apiVersion</code> 和 <code>kind</code> 字段用于定位插件。</strong></p>
|
||||
<p>同时由于 kustomize 插件配置对象也是一个 <a href="/kustomize/zh/api-reference/glossary#Kubernetes-%E9%A3%8E%E6%A0%BC%E7%9A%84%E5%AF%B9%E8%B1%A1">k8s 对象</a>，因此这些字段是必要的。</p>
|
||||
<p>为了让插件准备好生成或转换，它包含了配置文件的全部内容。</p>
|
||||
<p>更多关于插件配置 YAML 的例子，请浏览根目录下 <a href="https://github.com/kubernetes-sigs/kustomize/tree/master/plugin/builtin">plugins</a> 中的单元测试，例如 <a href="https://github.com/kubernetes-sigs/kustomize/tree/master/plugin/someteam.example.com/v1/chartinflator/ChartInflator_test.go">ChartInflator</a> 或 <a href="https://github.com/kubernetes-sigs/kustomize/tree/master/plugin/builtin/prefixsuffixtransformer/PrefixSuffixTransformer_test.go">NameTransformer</a>。</p>
|
||||
<h2 id="植入">植入</h2>
|
||||
<p>每个插件都有自己的专用目录，名为：</p>
|
||||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash"><span style="color:#000">$XDG_CONFIG_HOME</span>/kustomize/plugin
|
||||
/<span style="color:#4e9a06">${</span><span style="color:#000">apiVersion</span><span style="color:#4e9a06">}</span>/LOWERCASE<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">${</span><span style="color:#000">kind</span><span style="color:#4e9a06">}</span><span style="color:#ce5c00;font-weight:bold">)</span>
|
||||
</code></pre></div><p>The default value of <a href="https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html"><code>XDG_CONFIG_HOME</code></a> is
|
||||
<code>$HOME/.config</code>.</p>
|
||||
<p><a href="https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html"><code>XDG_CONFIG_HOME</code></a> 的默认值为 <code>$HOME/.config</code>。</p>
|
||||
<p>为了便于插件包（源码、测试、插件数据文件等）的共享，要求每个目录存放一个插件。</p>
|
||||
<p>在 <a href="#go-%E6%8F%92%E4%BB%B6">Go 插件</a>中，还可以为单个插件提供一个 <code>go.mod</code> 文件，可以缓解包版本依赖性偏移的问题。</p>
|
||||
<p>加载时，kustomize 首先会寻找一个 <em>可执行</em> 文件，名为：</p>
|
||||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash"><span style="color:#000">$XDG_CONFIG_HOME</span>/kustomize/plugin
|
||||
/<span style="color:#4e9a06">${</span><span style="color:#000">apiVersion</span><span style="color:#4e9a06">}</span>/LOWERCASE<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">${</span><span style="color:#000">kind</span><span style="color:#4e9a06">}</span><span style="color:#ce5c00;font-weight:bold">)</span>/<span style="color:#4e9a06">${</span><span style="color:#000">kind</span><span style="color:#4e9a06">}</span>
|
||||
</code></pre></div><p>如果没有找到这个文件，或者这个文件不是可执行的，kustomize 会在同一目录下寻找一个名为 <code>${kind}.so</code> 的文件，并尝试将其作为 <a href="#go-%E6%8F%92%E4%BB%B6">Go插件</a> 加载。</p>
|
||||
<p>如果这两项检查都失败，则插件加载失败，<code>kustomize build</code> 失败。</p>
|
||||
<h2 id="执行情况">执行情况</h2>
|
||||
<p>插件只有在运行 <code>kustomize build</code> 命令时使用。</p>
|
||||
<p>生成器插件是在处理完 <code>resources</code> 字段后运行的（<code>resources</code> 字段本身也可以看成是一个简单地从磁盘上读取对象的生成器）。</p>
|
||||
<p>之后所有资源将被传递到转换管道中，由其中内置的转换器，如 <code>namePrefix</code> 和 <code>commonLabel</code> 等先转换应用（如果 kustomization 文件中指定了他们），然后再转换用户指定的 <code>transformers</code> 字段。</p>
|
||||
<p>由于无法指定转化的顺序，所以需要遵守 <code>transformers</code> 字段中指定的顺序。</p>
|
||||
<h4 id="no-security">No Security</h4>
|
||||
<p>Kustomize 插件不会在任何形式的 kustomize 提供的沙盒中运行。不存在 <em>“plugin security”</em> 的概念。</p>
|
||||
<p><code>kustomize build</code> 会尝试使用插件，但如果省略了 <code>--enable_alpha_plugins</code>，将导致插件无法加载，并且会有一个关于插件使用的警告。</p>
|
||||
<p>使用这个 flag 就是承认使用不稳定的插件 API（alpha）、承认使用缺少出处插件，以及插件不属于 kustomize 的事实。</p>
|
||||
<p>简单的说，一些从网上下载的 kustomize 插件可能会奇妙地将 k8s 的配置以理想的方式进行改造，同时也会悄悄地对运行 <code>kustomize build</code> 的系统做任何用户可以做的事情。</p>
|
||||
<h2 id="编写插件">编写插件</h2>
|
||||
<p>插件有 <a href="#exec-%E6%8F%92%E4%BB%B6">exec</a> 和 <a href="#go-%E6%8F%92%E4%BB%B6">Go</a> 两种.</p>
|
||||
<h3 id="exec-插件">Exec 插件</h3>
|
||||
<p><em>exec 插件</em> 是一个可以在命令行中接收参数可执行文件，该参数指向包含 kustomization 配置的 YAML 文件。</p>
|
||||
<blockquote>
|
||||
<p>TODO: 对插件的限制，允许同一个 <em>exec 插件</em> 同时被 <code>generators</code> 和 <code>transformers</code> 字段所触发。</p>
|
||||
<ul>
|
||||
<li>第一个参数可以是固定的字符串 <code>generate</code> 或 <code>transform</code>，（配置文件的名称移动到第2个参数）</li>
|
||||
<li>默认情况下，exec plugin 会作为一个转化器,除非提供了标志 <code>-g</code>，将 exec 插件切换为生成器。</li>
|
||||
</ul>
|
||||
</blockquote>
|
||||
<h4 id="示例">示例</h4>
|
||||
<ul>
|
||||
<li><a href="https://github.com/kubernetes-sigs/kustomize/tree/master/plugin/someteam.example.com/v1/chartinflator">helm chart inflator</a> - helm chart inflates 生成器。</li>
|
||||
<li><a href="https://github.com/kubernetes-sigs/kustomize/tree/master/plugin/someteam.example.com/v1/bashedconfigmap">bashed config map</a> - 使用 bash 生成十分简单的 configMap。</li>
|
||||
<li><a href="https://github.com/kubernetes-sigs/kustomize/tree/master/plugin/someteam.example.com/v1/sedtransformer">sed transformer</a> - 使用插件来定义非结构化的编辑。</li>
|
||||
<li><a href="https://github.com/kubernetes-sigs/kustomize/tree/master/plugin/someteam.example.com/v1/gogetter">hashicorp go-getter</a> - 下载 kustomize layes 并通过构建它来生成资源。</li>
|
||||
</ul>
|
||||
<p>生成器插件无需在 <code>stdin</code> 上输入任何东西，就会将生成的资源输出到 <code>stdout</code>。</p>
|
||||
<p>转化器插件需要在 <code>stdin</code> 上输入资源的 YAML，并转化后的资源输出到 <code>stdout</code>。</p>
|
||||
<p>kustomize 会使用 exec 插件适配器，为 <code>stdin</code> 提供的资源，并获取 <code>stdout</code> 以进行下一步的处理。</p>
|
||||
<h4 id="generator-选项">Generator 选项</h4>
|
||||
<p>生成器 exec 插件可以通过设置以下内部注释中的一个来调整生成器选项。</p>
|
||||
<blockquote>
|
||||
<p>注意：这些注释只会在本地的 kustomize 中，不会出现在最终输出中。</p>
|
||||
</blockquote>
|
||||
<p><strong><code>kustomize.config.k8s.io/needs-hash</code></strong></p>
|
||||
<p>通过包含 <code>needs-hash</code> 注释，可以将资源标记为需要由内部哈希转换器处理的资源。当设置注释的有效值为 <code>"true"</code> 和 <code>"false"</code> 时，分别启用或禁用资源的哈希后缀。忽略该注解相当于将值设置为 <code>"false"</code>。</p>
|
||||
<p>如果此注释被设置在不受哈希转换器支持的资源上，将导致构建将失败。</p>
|
||||
<p>示例：</p>
|
||||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">ConfigMap</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">metadata</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><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><span style="color:#000">cm-test</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">annotations</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><span style="color:#204a87;font-weight:bold">kustomize.config.k8s.io/needs-hash</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">"true"</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">data</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><span style="color:#204a87;font-weight:bold">foo</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">bar</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span></code></pre></div><p><strong><code>kustomize.config.k8s.io/behavior</code></strong></p>
|
||||
<p><code>behavior</code> 注释为当资源发生冲突时插件的处理方式，有效值包括：“create”、“merge “和 “replace”，默认为 “create”。</p>
|
||||
<p>示例：</p>
|
||||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#204a87;font-weight:bold">apiVersion</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">v1</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">kind</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">ConfigMap</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">metadata</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><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><span style="color:#000">cm-test</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">annotations</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><span style="color:#204a87;font-weight:bold">kustomize.config.k8s.io/behavior</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">"merge"</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:bold">data</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><span style="color:#204a87;font-weight:bold">foo</span><span style="color:#000;font-weight:bold">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">bar</span><span style="color:#f8f8f8;text-decoration:underline">
|
||||
</span></code></pre></div><h3 id="go-插件">Go 插件</h3>
|
||||
<p>请务必阅读 <a href="goPluginCaveats.md">Go 插件注意事项</a>。</p>
|
||||
<p>如果一个 <code>.go</code> 文件声明 <code>package main</code>，并附加了有用的功能标志，那么它就可以成为一个 <a href="https://golang.org/pkg/plugin/">Go 插件</a>。</p>
|
||||
<p>如果标志被命名为 “KustomizePlugin”，并且附加的函数实现了 <code>Configurable</code>、<code>Generator</code> 和 <code>Transformer</code> 接口，那么它可以进一步作为 <em>kustomize</em> 插件使用。</p>
|
||||
<p>kustomize 的一个 Go 插件看起来是这样的：</p>
|
||||
<blockquote>
|
||||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-go" data-lang="go"><span style="color:#204a87;font-weight:bold">package</span> <span style="color:#000">main</span>
|
||||
<meta http-equiv="refresh" content="0; url=https://kubectl.docs.kubernetes.io/zh/guides/plugins/" />
|
||||
<p>Moved to <a href="https://github.com/kubernetes-sigs/cli-experimental">https://github.com/kubernetes-sigs/cli-experimental</a></p>
|
||||
|
||||
<span style="color:#204a87;font-weight:bold">import</span> <span style="color:#000;font-weight:bold">(</span>
|
||||
<span style="color:#4e9a06">"sigs.k8s.io/kustomize/api/ifc"</span>
|
||||
<span style="color:#4e9a06">"sigs.k8s.io/kustomize/api/resmap"</span>
|
||||
<span style="color:#ce5c00;font-weight:bold">...</span>
|
||||
<span style="color:#000;font-weight:bold">)</span>
|
||||
|
||||
<span style="color:#204a87;font-weight:bold">type</span> <span style="color:#000">plugin</span> <span style="color:#204a87;font-weight:bold">struct</span> <span style="color:#000;font-weight:bold">{</span><span style="color:#ce5c00;font-weight:bold">...</span><span style="color:#000;font-weight:bold">}</span>
|
||||
|
||||
<span style="color:#204a87;font-weight:bold">var</span> <span style="color:#000">KustomizePlugin</span> <span style="color:#000">plugin</span>
|
||||
|
||||
<span style="color:#204a87;font-weight:bold">func</span> <span style="color:#000;font-weight:bold">(</span><span style="color:#000">p</span> <span style="color:#ce5c00;font-weight:bold">*</span><span style="color:#000">plugin</span><span style="color:#000;font-weight:bold">)</span> <span style="color:#000">Config</span><span style="color:#000;font-weight:bold">(</span>
|
||||
<span style="color:#000">ldr</span> <span style="color:#000">ifc</span><span style="color:#000;font-weight:bold">.</span><span style="color:#000">Loader</span><span style="color:#000;font-weight:bold">,</span>
|
||||
<span style="color:#000">rf</span> <span style="color:#ce5c00;font-weight:bold">*</span><span style="color:#000">resmap</span><span style="color:#000;font-weight:bold">.</span><span style="color:#000">Factory</span><span style="color:#000;font-weight:bold">,</span>
|
||||
<span style="color:#000">c</span> <span style="color:#000;font-weight:bold">[]</span><span style="color:#204a87;font-weight:bold">byte</span><span style="color:#000;font-weight:bold">)</span> <span style="color:#204a87;font-weight:bold">error</span> <span style="color:#000;font-weight:bold">{</span><span style="color:#ce5c00;font-weight:bold">...</span><span style="color:#000;font-weight:bold">}</span>
|
||||
|
||||
<span style="color:#204a87;font-weight:bold">func</span> <span style="color:#000;font-weight:bold">(</span><span style="color:#000">p</span> <span style="color:#ce5c00;font-weight:bold">*</span><span style="color:#000">plugin</span><span style="color:#000;font-weight:bold">)</span> <span style="color:#000">Generate</span><span style="color:#000;font-weight:bold">()</span> <span style="color:#000;font-weight:bold">(</span><span style="color:#000">resmap</span><span style="color:#000;font-weight:bold">.</span><span style="color:#000">ResMap</span><span style="color:#000;font-weight:bold">,</span> <span style="color:#204a87;font-weight:bold">error</span><span style="color:#000;font-weight:bold">)</span> <span style="color:#000;font-weight:bold">{</span><span style="color:#ce5c00;font-weight:bold">...</span><span style="color:#000;font-weight:bold">}</span>
|
||||
|
||||
<span style="color:#204a87;font-weight:bold">func</span> <span style="color:#000;font-weight:bold">(</span><span style="color:#000">p</span> <span style="color:#ce5c00;font-weight:bold">*</span><span style="color:#000">plugin</span><span style="color:#000;font-weight:bold">)</span> <span style="color:#000">Transform</span><span style="color:#000;font-weight:bold">(</span><span style="color:#000">m</span> <span style="color:#000">resmap</span><span style="color:#000;font-weight:bold">.</span><span style="color:#000">ResMap</span><span style="color:#000;font-weight:bold">)</span> <span style="color:#204a87;font-weight:bold">error</span> <span style="color:#000;font-weight:bold">{</span><span style="color:#ce5c00;font-weight:bold">...</span><span style="color:#000;font-weight:bold">}</span>
|
||||
</code></pre></div></blockquote>
|
||||
<p>需要使用标识符 <code>plugin</code>，<code>KustomizePlugin</code> 并且需要实现方法签名 <code>Config</code>。</p>
|
||||
<p>实现 <code>Generatoror</code> 或 <code>Transformer</code> 方法允许（分别）将插件的配置文件添加到 kustomization 文件的 <code>generatorsor</code> 或 <code>transformers</code> 字段中，并根据需要执行。</p>
|
||||
<h4 id="示例-1">示例</h4>
|
||||
<ul>
|
||||
<li><a href="https://github.com/kubernetes-sigs/kustomize/tree/master/plugin/someteam.example.com/v1/someservicegenerator">service generator</a> - 使用 name 和 port 参数生成一个 service。</li>
|
||||
<li><a href="https://github.com/kubernetes-sigs/kustomize/tree/master/plugin/someteam.example.com/v1/stringprefixer">string prefixer</a> - 使用 <code>metadata/name</code> 值作为前缀。这个特殊的示例是为了展示插件的转化行为。详见 <code>target</code> 包中的 <code>TestTransformedTransformers</code> 测试。</li>
|
||||
<li><a href="https://github.com/kubernetes-sigs/kustomize/tree/master/plugin/someteam.example.com/v1/dateprefixer">date prefixer</a> - 将当前日期作为前缀添加到资源名称上，这是一个用于修改刚才提到的字符串前缀插件的简单示例。</li>
|
||||
<li><a href="https://github.com/kubernetes-sigs/kustomize/tree/master/plugin/someteam.example.com/v1/secretsfromdatabase">secret generator</a> - 从 toy 数据库生成 secret。</li>
|
||||
<li><a href="https://github.com/monopole/sopsencodedsecrets">sops encoded secrets</a> - 一个更复杂的 secret 生成器。</li>
|
||||
<li><a href="https://github.com/kubernetes-sigs/kustomize/tree/master/plugin/builtin">All the builtin plugins</a>.
|
||||
用户自制的插件与内置插件是一样的。</li>
|
||||
</ul>
|
||||
<p>Go 插件既可以是生成器，也可以是转化器。<code>Generate</code> 方法将在 <code>Transform</code> 方法运行之前与所有其他生成器一起运行。</p>
|
||||
<p>如下的构建命令，假设插件源代码位于 kustomize 期望查找 <code>.so</code> 文件的目录中：</p>
|
||||
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash"><span style="color:#000">d</span><span style="color:#ce5c00;font-weight:bold">=</span><span style="color:#000">$XDG_CONFIG_HOME</span>/kustomize/plugin<span style="color:#4e9a06">\
|
||||
</span><span style="color:#4e9a06"></span>/<span style="color:#4e9a06">${</span><span style="color:#000">apiVersion</span><span style="color:#4e9a06">}</span>/LOWERCASE<span style="color:#ce5c00;font-weight:bold">(</span><span style="color:#4e9a06">${</span><span style="color:#000">kind</span><span style="color:#4e9a06">}</span><span style="color:#ce5c00;font-weight:bold">)</span>
|
||||
|
||||
go build -buildmode plugin <span style="color:#4e9a06">\
|
||||
</span><span style="color:#4e9a06"></span> -o <span style="color:#000">$d</span>/<span style="color:#4e9a06">${</span><span style="color:#000">kind</span><span style="color:#4e9a06">}</span>.so <span style="color:#000">$d</span>/<span style="color:#4e9a06">${</span><span style="color:#000">kind</span><span style="color:#4e9a06">}</span>.go
|
||||
</code></pre></div>
|
||||
<div class="section-index">
|
||||
|
||||
|
||||
@@ -601,7 +429,7 @@ go build -buildmode plugin <span style="color:#4e9a06">\
|
||||
|
||||
|
||||
|
||||
<div class="text-muted mt-5 pt-3 border-top">最后修改 2020年07月16日: <a href="https://github.com/kubernetes-sigs/kustomize/commit/f9ee578aed600136133c3232fff03029cdfc526e">Docs: Auto-fix markdownlint issues (f9ee578a)</a>
|
||||
<div class="text-muted mt-5 pt-3 border-top">最后修改 2020年11月25日: <a href="https://github.com/kubernetes-sigs/kustomize/commit/14eac6020f43cd07a86722f5e937ae8c75873e43">remove duplicate contents and redirect (14eac602)</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user