-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document AnnotationsTransformer on site
Dcoument AnnotationsTransformer API under Reference on site.
- Loading branch information
1 parent
10cdfa7
commit 95b41df
Showing
5 changed files
with
74 additions
and
1 deletion.
There are no files selected for viewing
32 changes: 32 additions & 0 deletions
32
site/content/en/docs/Reference/API/Common Definitions/FieldSpec.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
title: "FieldSpec" | ||
linkTitle: "FieldSpec" | ||
weight: 1 | ||
date: 2023-07-28 | ||
description: > | ||
FieldSpec specifies a field for Kustomize to target. | ||
--- | ||
|
||
* **group** (string) | ||
|
||
Kubernetes group that this FieldSpec applies to. If empty, this FieldSpec | ||
applies to all groups. Currently, there is no way to specify only the core | ||
group, which is also represented by the empty string. | ||
|
||
* **version** (string) | ||
|
||
Kubernetes version that this FieldSpec applies to. If empty, this FieldSpec | ||
applies to all versions. | ||
|
||
* **kind** (string) | ||
|
||
Kubernetes kind that this FieldSpec applies to. If empty, this FieldSpec | ||
applies to all kinds. | ||
|
||
* **path** (string) | ||
|
||
Path to target field. Fields in path are delimited by forward slashes "/". | ||
|
||
* **create** (bool) | ||
|
||
If true, creates fields in **path** not already present. |
8 changes: 8 additions & 0 deletions
8
site/content/en/docs/Reference/API/Common Definitions/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: "Common Definitions" | ||
linkTitle: "Common Definitions" | ||
weight: 10 | ||
date: 2023-07-28 | ||
description: > | ||
Common definitions are fields used across the Kustomize API. | ||
--- |
25 changes: 25 additions & 0 deletions
25
site/content/en/docs/Reference/API/Transformers/AnnotationsTransformer.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
title: "AnnotationsTransformer" | ||
linkTitle: "AnnotationsTransformer" | ||
weight: 1 | ||
date: 2023-07-28 | ||
description: > | ||
AnnotationsTransformer adds annotations to user-input resources. | ||
--- | ||
|
||
* **apiVersion**: builtin | ||
* **kind**: AnnotationsTransformer | ||
* **metadata** ([ObjectMeta](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/object-meta/#ObjectMeta)) | ||
* **annotations** (map[string]string) | ||
|
||
Map of annotations that AnnotationsTransformer will add to resources. | ||
|
||
* fieldSpecs (\[\][FieldSpec](../Common%20Definitions/FieldSpec.md)) | ||
|
||
fieldSpecs specifies the field on each resource that AnnotationsTransformer | ||
should add the annotations to. It essentially allows the user to re-define | ||
the field path of the Kubernetes annotations field from `metadata/annotations` | ||
for different resources. | ||
|
||
If not specified, AnnotationsTransformer applies the annotations to the | ||
`metadata/annotations` field of all resources. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: "Transformers" | ||
linkTitle: "Transformers" | ||
weight: 3 | ||
date: 2023-07-28 | ||
description: > | ||
Transformers have the ability to modify user-input resources. | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters