1145 lines
22 KiB
Markdown
1145 lines
22 KiB
Markdown
<h1>Kustomize API reference v1</h1>
|
|
<p>Packages:</p>
|
|
<ul class="simple">
|
|
<li>
|
|
<a href="#kustomize.toolkit.fluxcd.io%2fv1">kustomize.toolkit.fluxcd.io/v1</a>
|
|
</li>
|
|
</ul>
|
|
<h2 id="kustomize.toolkit.fluxcd.io/v1">kustomize.toolkit.fluxcd.io/v1</h2>
|
|
<p>Package v1 contains API Schema definitions for the kustomize.toolkit.fluxcd.io
|
|
v1 API group.</p>
|
|
Resource Types:
|
|
<ul class="simple"><li>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.Kustomization">Kustomization</a>
|
|
</li></ul>
|
|
<h3 id="kustomize.toolkit.fluxcd.io/v1.Kustomization">Kustomization
|
|
</h3>
|
|
<p>Kustomization is the Schema for the kustomizations API.</p>
|
|
<div class="md-typeset__scrollwrap">
|
|
<div class="md-typeset__table">
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>apiVersion</code><br>
|
|
string</td>
|
|
<td>
|
|
<code>kustomize.toolkit.fluxcd.io/v1</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>kind</code><br>
|
|
string
|
|
</td>
|
|
<td>
|
|
<code>Kustomization</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>metadata</code><br>
|
|
<em>
|
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta">
|
|
Kubernetes meta/v1.ObjectMeta
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
Refer to the Kubernetes API documentation for the fields of the
|
|
<code>metadata</code> field.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>spec</code><br>
|
|
<em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.KustomizationSpec">
|
|
KustomizationSpec
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<br/>
|
|
<br/>
|
|
<table>
|
|
<tr>
|
|
<td>
|
|
<code>commonMetadata</code><br>
|
|
<em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.CommonMetadata">
|
|
CommonMetadata
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>CommonMetadata specifies the common labels and annotations that are
|
|
applied to all resources. Any existing label or annotation will be
|
|
overridden if its key matches a common one.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>dependsOn</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#NamespacedObjectReference">
|
|
[]github.com/fluxcd/pkg/apis/meta.NamespacedObjectReference
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>DependsOn may contain a meta.NamespacedObjectReference slice
|
|
with references to Kustomization resources that must be ready before this
|
|
Kustomization can be reconciled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>decryption</code><br>
|
|
<em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.Decryption">
|
|
Decryption
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Decrypt Kubernetes secrets before applying them on the cluster.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>interval</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
|
|
Kubernetes meta/v1.Duration
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<p>The interval at which to reconcile the Kustomization.
|
|
This interval is approximate and may be subject to jitter to ensure
|
|
efficient use of resources.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>retryInterval</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
|
|
Kubernetes meta/v1.Duration
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>The interval at which to retry a previously failed reconciliation.
|
|
When not specified, the controller uses the KustomizationSpec.Interval
|
|
value to retry failures.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>kubeConfig</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#KubeConfigReference">
|
|
github.com/fluxcd/pkg/apis/meta.KubeConfigReference
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>The KubeConfig for reconciling the Kustomization on a remote cluster.
|
|
When used in combination with KustomizationSpec.ServiceAccountName,
|
|
forces the controller to act on behalf of that Service Account at the
|
|
target cluster.
|
|
If the –default-service-account flag is set, its value will be used as
|
|
a controller level fallback for when KustomizationSpec.ServiceAccountName
|
|
is empty.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>path</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Path to the directory containing the kustomization.yaml file, or the
|
|
set of plain YAMLs a kustomization.yaml should be generated for.
|
|
Defaults to ‘None’, which translates to the root path of the SourceRef.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>postBuild</code><br>
|
|
<em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.PostBuild">
|
|
PostBuild
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>PostBuild describes which actions to perform on the YAML manifest
|
|
generated by building the kustomize overlay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>prune</code><br>
|
|
<em>
|
|
bool
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<p>Prune enables garbage collection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>healthChecks</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#NamespacedObjectKindReference">
|
|
[]github.com/fluxcd/pkg/apis/meta.NamespacedObjectKindReference
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>A list of resources to be included in the health assessment.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>patches</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/github.com/fluxcd/pkg/apis/kustomize#Patch">
|
|
[]github.com/fluxcd/pkg/apis/kustomize.Patch
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Strategic merge and JSON patches, defined as inline YAML objects,
|
|
capable of targeting objects based on kind, label and annotation selectors.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>images</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/github.com/fluxcd/pkg/apis/kustomize#Image">
|
|
[]github.com/fluxcd/pkg/apis/kustomize.Image
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Images is a list of (image name, new name, new tag or digest)
|
|
for changing image names, tags or digests. This can also be achieved with a
|
|
patch, but this operator is simpler to specify.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>serviceAccountName</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>The name of the Kubernetes service account to impersonate
|
|
when reconciling this Kustomization.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>sourceRef</code><br>
|
|
<em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.CrossNamespaceSourceReference">
|
|
CrossNamespaceSourceReference
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<p>Reference of the source where the kustomization file is.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>suspend</code><br>
|
|
<em>
|
|
bool
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>This flag tells the controller to suspend subsequent kustomize executions,
|
|
it does not apply to already started executions. Defaults to false.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>targetNamespace</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>TargetNamespace sets or overrides the namespace in the
|
|
kustomization.yaml file.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>timeout</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
|
|
Kubernetes meta/v1.Duration
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Timeout for validation, apply and health checking operations.
|
|
Defaults to ‘Interval’ duration.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>force</code><br>
|
|
<em>
|
|
bool
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Force instructs the controller to recreate resources
|
|
when patching fails due to an immutable field change.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>wait</code><br>
|
|
<em>
|
|
bool
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Wait instructs the controller to check the health of all the reconciled
|
|
resources. When enabled, the HealthChecks are ignored. Defaults to false.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>components</code><br>
|
|
<em>
|
|
[]string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Components specifies relative paths to specifications of other Components.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>status</code><br>
|
|
<em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.KustomizationStatus">
|
|
KustomizationStatus
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<h3 id="kustomize.toolkit.fluxcd.io/v1.CommonMetadata">CommonMetadata
|
|
</h3>
|
|
<p>
|
|
(<em>Appears on:</em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.KustomizationSpec">KustomizationSpec</a>)
|
|
</p>
|
|
<p>CommonMetadata defines the common labels and annotations.</p>
|
|
<div class="md-typeset__scrollwrap">
|
|
<div class="md-typeset__table">
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>annotations</code><br>
|
|
<em>
|
|
map[string]string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Annotations to be added to the object’s metadata.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>labels</code><br>
|
|
<em>
|
|
map[string]string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Labels to be added to the object’s metadata.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<h3 id="kustomize.toolkit.fluxcd.io/v1.CrossNamespaceSourceReference">CrossNamespaceSourceReference
|
|
</h3>
|
|
<p>
|
|
(<em>Appears on:</em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.KustomizationSpec">KustomizationSpec</a>)
|
|
</p>
|
|
<p>CrossNamespaceSourceReference contains enough information to let you locate the
|
|
typed Kubernetes resource object at cluster level.</p>
|
|
<div class="md-typeset__scrollwrap">
|
|
<div class="md-typeset__table">
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>apiVersion</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>API version of the referent.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>kind</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<p>Kind of the referent.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>name</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<p>Name of the referent.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>namespace</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Namespace of the referent, defaults to the namespace of the Kubernetes
|
|
resource object that contains the reference.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<h3 id="kustomize.toolkit.fluxcd.io/v1.Decryption">Decryption
|
|
</h3>
|
|
<p>
|
|
(<em>Appears on:</em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.KustomizationSpec">KustomizationSpec</a>)
|
|
</p>
|
|
<p>Decryption defines how decryption is handled for Kubernetes manifests.</p>
|
|
<div class="md-typeset__scrollwrap">
|
|
<div class="md-typeset__table">
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>provider</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<p>Provider is the name of the decryption engine.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>secretRef</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#LocalObjectReference">
|
|
github.com/fluxcd/pkg/apis/meta.LocalObjectReference
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>The secret name containing the private OpenPGP keys used for decryption.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<h3 id="kustomize.toolkit.fluxcd.io/v1.KustomizationSpec">KustomizationSpec
|
|
</h3>
|
|
<p>
|
|
(<em>Appears on:</em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.Kustomization">Kustomization</a>)
|
|
</p>
|
|
<p>KustomizationSpec defines the configuration to calculate the desired state
|
|
from a Source using Kustomize.</p>
|
|
<div class="md-typeset__scrollwrap">
|
|
<div class="md-typeset__table">
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>commonMetadata</code><br>
|
|
<em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.CommonMetadata">
|
|
CommonMetadata
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>CommonMetadata specifies the common labels and annotations that are
|
|
applied to all resources. Any existing label or annotation will be
|
|
overridden if its key matches a common one.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>dependsOn</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#NamespacedObjectReference">
|
|
[]github.com/fluxcd/pkg/apis/meta.NamespacedObjectReference
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>DependsOn may contain a meta.NamespacedObjectReference slice
|
|
with references to Kustomization resources that must be ready before this
|
|
Kustomization can be reconciled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>decryption</code><br>
|
|
<em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.Decryption">
|
|
Decryption
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Decrypt Kubernetes secrets before applying them on the cluster.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>interval</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
|
|
Kubernetes meta/v1.Duration
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<p>The interval at which to reconcile the Kustomization.
|
|
This interval is approximate and may be subject to jitter to ensure
|
|
efficient use of resources.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>retryInterval</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
|
|
Kubernetes meta/v1.Duration
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>The interval at which to retry a previously failed reconciliation.
|
|
When not specified, the controller uses the KustomizationSpec.Interval
|
|
value to retry failures.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>kubeConfig</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#KubeConfigReference">
|
|
github.com/fluxcd/pkg/apis/meta.KubeConfigReference
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>The KubeConfig for reconciling the Kustomization on a remote cluster.
|
|
When used in combination with KustomizationSpec.ServiceAccountName,
|
|
forces the controller to act on behalf of that Service Account at the
|
|
target cluster.
|
|
If the –default-service-account flag is set, its value will be used as
|
|
a controller level fallback for when KustomizationSpec.ServiceAccountName
|
|
is empty.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>path</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Path to the directory containing the kustomization.yaml file, or the
|
|
set of plain YAMLs a kustomization.yaml should be generated for.
|
|
Defaults to ‘None’, which translates to the root path of the SourceRef.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>postBuild</code><br>
|
|
<em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.PostBuild">
|
|
PostBuild
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>PostBuild describes which actions to perform on the YAML manifest
|
|
generated by building the kustomize overlay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>prune</code><br>
|
|
<em>
|
|
bool
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<p>Prune enables garbage collection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>healthChecks</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#NamespacedObjectKindReference">
|
|
[]github.com/fluxcd/pkg/apis/meta.NamespacedObjectKindReference
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>A list of resources to be included in the health assessment.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>patches</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/github.com/fluxcd/pkg/apis/kustomize#Patch">
|
|
[]github.com/fluxcd/pkg/apis/kustomize.Patch
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Strategic merge and JSON patches, defined as inline YAML objects,
|
|
capable of targeting objects based on kind, label and annotation selectors.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>images</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/github.com/fluxcd/pkg/apis/kustomize#Image">
|
|
[]github.com/fluxcd/pkg/apis/kustomize.Image
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Images is a list of (image name, new name, new tag or digest)
|
|
for changing image names, tags or digests. This can also be achieved with a
|
|
patch, but this operator is simpler to specify.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>serviceAccountName</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>The name of the Kubernetes service account to impersonate
|
|
when reconciling this Kustomization.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>sourceRef</code><br>
|
|
<em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.CrossNamespaceSourceReference">
|
|
CrossNamespaceSourceReference
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<p>Reference of the source where the kustomization file is.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>suspend</code><br>
|
|
<em>
|
|
bool
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>This flag tells the controller to suspend subsequent kustomize executions,
|
|
it does not apply to already started executions. Defaults to false.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>targetNamespace</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>TargetNamespace sets or overrides the namespace in the
|
|
kustomization.yaml file.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>timeout</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
|
|
Kubernetes meta/v1.Duration
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Timeout for validation, apply and health checking operations.
|
|
Defaults to ‘Interval’ duration.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>force</code><br>
|
|
<em>
|
|
bool
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Force instructs the controller to recreate resources
|
|
when patching fails due to an immutable field change.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>wait</code><br>
|
|
<em>
|
|
bool
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Wait instructs the controller to check the health of all the reconciled
|
|
resources. When enabled, the HealthChecks are ignored. Defaults to false.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>components</code><br>
|
|
<em>
|
|
[]string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Components specifies relative paths to specifications of other Components.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<h3 id="kustomize.toolkit.fluxcd.io/v1.KustomizationStatus">KustomizationStatus
|
|
</h3>
|
|
<p>
|
|
(<em>Appears on:</em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.Kustomization">Kustomization</a>)
|
|
</p>
|
|
<p>KustomizationStatus defines the observed state of a kustomization.</p>
|
|
<div class="md-typeset__scrollwrap">
|
|
<div class="md-typeset__table">
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>ReconcileRequestStatus</code><br>
|
|
<em>
|
|
<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#ReconcileRequestStatus">
|
|
github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<p>
|
|
(Members of <code>ReconcileRequestStatus</code> are embedded into this type.)
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>observedGeneration</code><br>
|
|
<em>
|
|
int64
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>ObservedGeneration is the last reconciled generation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>conditions</code><br>
|
|
<em>
|
|
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#condition-v1-meta">
|
|
[]Kubernetes meta/v1.Condition
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>lastAppliedRevision</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>The last successfully applied revision.
|
|
Equals the Revision of the applied Artifact from the referenced Source.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>lastAttemptedRevision</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>LastAttemptedRevision is the revision of the last reconciliation attempt.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>inventory</code><br>
|
|
<em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.ResourceInventory">
|
|
ResourceInventory
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Inventory contains the list of Kubernetes resource object references that
|
|
have been successfully applied.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<h3 id="kustomize.toolkit.fluxcd.io/v1.PostBuild">PostBuild
|
|
</h3>
|
|
<p>
|
|
(<em>Appears on:</em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.KustomizationSpec">KustomizationSpec</a>)
|
|
</p>
|
|
<p>PostBuild describes which actions to perform on the YAML manifest
|
|
generated by building the kustomize overlay.</p>
|
|
<div class="md-typeset__scrollwrap">
|
|
<div class="md-typeset__table">
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>substitute</code><br>
|
|
<em>
|
|
map[string]string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Substitute holds a map of key/value pairs.
|
|
The variables defined in your YAML manifests that match any of the keys
|
|
defined in the map will be substituted with the set value.
|
|
Includes support for bash string replacement functions
|
|
e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>substituteFrom</code><br>
|
|
<em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.SubstituteReference">
|
|
[]SubstituteReference
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>SubstituteFrom holds references to ConfigMaps and Secrets containing
|
|
the variables and their values to be substituted in the YAML manifests.
|
|
The ConfigMap and the Secret data keys represent the var names, and they
|
|
must match the vars declared in the manifests for the substitution to
|
|
happen.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<h3 id="kustomize.toolkit.fluxcd.io/v1.ResourceInventory">ResourceInventory
|
|
</h3>
|
|
<p>
|
|
(<em>Appears on:</em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.KustomizationStatus">KustomizationStatus</a>)
|
|
</p>
|
|
<p>ResourceInventory contains a list of Kubernetes resource object references
|
|
that have been applied by a Kustomization.</p>
|
|
<div class="md-typeset__scrollwrap">
|
|
<div class="md-typeset__table">
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>entries</code><br>
|
|
<em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.ResourceRef">
|
|
[]ResourceRef
|
|
</a>
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<p>Entries of Kubernetes resource object references.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<h3 id="kustomize.toolkit.fluxcd.io/v1.ResourceRef">ResourceRef
|
|
</h3>
|
|
<p>
|
|
(<em>Appears on:</em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.ResourceInventory">ResourceInventory</a>)
|
|
</p>
|
|
<p>ResourceRef contains the information necessary to locate a resource within a cluster.</p>
|
|
<div class="md-typeset__scrollwrap">
|
|
<div class="md-typeset__table">
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>id</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<p>ID is the string representation of the Kubernetes resource object’s metadata,
|
|
in the format ‘<namespace><em><name></em><group>_<kind>’.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>v</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<p>Version is the API version of the Kubernetes resource object’s kind.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<h3 id="kustomize.toolkit.fluxcd.io/v1.SubstituteReference">SubstituteReference
|
|
</h3>
|
|
<p>
|
|
(<em>Appears on:</em>
|
|
<a href="#kustomize.toolkit.fluxcd.io/v1.PostBuild">PostBuild</a>)
|
|
</p>
|
|
<p>SubstituteReference contains a reference to a resource containing
|
|
the variables name and value.</p>
|
|
<div class="md-typeset__scrollwrap">
|
|
<div class="md-typeset__table">
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>kind</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<p>Kind of the values referent, valid values are (‘Secret’, ‘ConfigMap’).</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>name</code><br>
|
|
<em>
|
|
string
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<p>Name of the values referent. Should reside in the same namespace as the
|
|
referring resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>optional</code><br>
|
|
<em>
|
|
bool
|
|
</em>
|
|
</td>
|
|
<td>
|
|
<em>(Optional)</em>
|
|
<p>Optional indicates whether the referenced resource must exist, or whether to
|
|
tolerate its absence. If true and the referenced resource is absent, proceed
|
|
as if the resource was present but empty, without any variables defined.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="admonition note">
|
|
<p class="last">This page was automatically generated with <code>gen-crd-api-reference-docs</code></p>
|
|
</div>
|