Add kustomization and transformer references (#5523)

* Add fields to kustomization file ref

* Address grammar feedback.

* labels.fields
This commit is contained in:
Nick
2024-02-26 10:25:24 -08:00
committed by GitHub
parent 6ffcc08591
commit d3329453a2
10 changed files with 219 additions and 10 deletions

View File

@@ -0,0 +1,29 @@
---
title: "LabelTransformer"
linkTitle: "LabelTransformer"
weight: 2
date: 2024-02-12
description: >
LabelTransformer adds labels to user-input resources.
---
See [Transformers]({{< relref "../Transformers" >}}) for common required fields.
* **apiVersion**: builtin
* **kind**: LabelTransformer
* **metadata** ([ObjectMeta](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/object-meta/#ObjectMeta))
Standard object's metadata.
* **labels** (map[string]string)
Map of labels that LabelTransformer will add to resources.
If not specified, LabelTransformer leaves the resources unchanged.
* **fieldSpecs** (\[\][FieldSpec]({{< relref "../Common%20Definitions/FieldSpec.md" >}}))
fieldSpecs specifies the field on each resource that LabelTransformer should add the labels to.
It essentially allows the user to re-define the field path of the Kubernetes labels field from `metadata/labels` for different resources.
If not specified, LabelTransformer applies the labels to the `metadata/labels` field of all resources.

View File

@@ -0,0 +1,36 @@
---
title: "NamespaceTransformer"
linkTitle: "NamespaceTransformer"
weight: 3
date: 2024-02-12
description: >
NamespaceTransformer sets the Namespace of user-input namespaced resources.
---
See [Transformers]({{< relref "../Transformers" >}}) for common required fields.
* **apiVersion**: builtin
* **kind**: NamespaceTransformer
* **metadata** ([ObjectMeta](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/object-meta/#ObjectMeta))
Standard object's metadata.
* **fieldSpecs** (\[\][FieldSpec]({{< relref "../Common%20Definitions/FieldSpec.md" >}})), optional
fieldSpecs allows the user to re-define the field path of the Kubernetes Namespace field from `metadata/namespace` for different resources.
If not specified, NamespaceTransformer applies the namespace to the `metadata/namespace` field of all resources.
* **unsetOnly** (bool), optional
UnsetOnly indicates whether the NamespaceTransformer will only set namespace fields that are currently unset. Defaults to false.
* **setRoleBindingSubjects** (RoleBindingSubjectMode), optional
SetRoleBindingSubjects determines which subject fields in RoleBinding and ClusterRoleBinding objects will have their namespace fields set. Overrides field specs provided for these types.
_RoleBindingSubjectMode specifies which subjects will be set. It can be one of three possible values:_
- `defaultOnly` (default): namespace will be set only on subjects named "default".
- `allServiceAccounts`: Namespace will be set on all subjects with `kind: ServiceAccount`.
- `none`: All subjects will be skipped.

View File

@@ -0,0 +1,29 @@
---
title: "PrefixTransformer"
linkTitle: "PrefixTransformer"
weight: 4
date: 2024-02-12
description: >
PrefixTransformer adds prefixes to the names of user-input resources.
---
See [Transformers]({{< relref "../Transformers" >}}) for common required fields.
* **apiVersion**: builtin
* **kind**: PrefixTransformer
* **metadata** ([ObjectMeta](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/object-meta/#ObjectMeta))
Standard object's metadata.
* **prefix** (string)
Prefix is the value that PrefixTransformer will prepend to the names of resources.
If not specified, PrefixTransformer leaves the names of resources unchanged.
* **fieldSpecs** (\[\][FieldSpec]({{< relref "../Common%20Definitions/FieldSpec.md" >}}))
fieldSpecs specifies the field on each resource that PrefixTransformer should add the prefix to.
It essentially allows the user to re-define the field path of the Kubernetes name field from `metadata/name` for different resources.
If not specified, PrefixTransformer applies the prefix to the `metadata/name` field of all resources.

View File

@@ -0,0 +1,29 @@
---
title: "SuffixTransformer"
linkTitle: "SuffixTransformer"
weight: 5
date: 2024-02-12
description: >
SuffixTransformer adds suffixes to the names of user-input resources.
---
See [Transformers]({{< relref "../Transformers" >}}) for common required fields.
* **apiVersion**: builtin
* **kind**: SuffixTransformer
* **metadata** ([ObjectMeta](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/object-meta/#ObjectMeta))
Standard object's metadata.
* **suffix** (string)
Suffix is the value that SuffixTransformer will postfix to the names of resources.
If not specified, SuffixTransformer leaves the names of resources unchanged.
* **fieldSpecs** (\[\][FieldSpec]({{< relref "../Common%20Definitions/FieldSpec.md" >}}))
fieldSpecs specifies the field on each resource that SuffixTransformer should add the suffix to.
It essentially allows the user to re-define the field path of the Kubernetes name field from `metadata/name` for different resources.
If not specified, SuffixTransformer applies the suffix to the `metadata/name` field of all resources.