Skip to content

Commit 7f30711

Browse files
committed
added contains-group-kinds annotation and updated contains-group-resources annotation
1 parent a038063 commit 7f30711

File tree

1 file changed

+27
-2
lines changed
  • content/en/docs/reference/labels-annotations-taints

1 file changed

+27
-2
lines changed

content/en/docs/reference/labels-annotations-taints/_index.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,11 +155,11 @@ the ApplySet beyond the parent object's own namespace (if any).
155155
The value is a comma-separated list of the names of namespaces other than the parent's namespace
156156
in which objects are found.
157157

158-
### applyset.kubernetes.io/contains-group-resources (alpha) {#applyset-kubernetes-io-contains-group-resources}
158+
### applyset.kubernetes.io/contains-group-kinds (alpha) {#applyset-kubernetes-io-contains-group-kinds}
159159

160160
Type: Annotation
161161

162-
Example: `applyset.kubernetes.io/contains-group-resources: "certificates.cert-manager.io,configmaps,deployments.apps,secrets,services"`
162+
Example: `applyset.kubernetes.io/contains-group-kinds: "certificates.cert-manager.io,configmaps,deployments.apps,secrets,services"`
163163

164164
Used on: Objects being used as ApplySet parents.
165165

@@ -176,6 +176,31 @@ or use a different optimization. However, as of Kubernetes version {{< skew curr
176176
it is required by kubectl. When present, the value of this annotation must be a comma separated list
177177
of the group-kinds, in the fully-qualified name format, i.e. `<resource>.<group>`.
178178

179+
### applyset.kubernetes.io/contains-group-resources (deprecated) {#applyset-kubernetes-io-contains-group-resources}
180+
181+
Type: Annotation
182+
183+
Example: `applyset.kubernetes.io/contains-group-resources: "certificates.cert-manager.io,configmaps,deployments.apps,secrets,services"`
184+
185+
Used on: Objects being used as ApplySet parents.
186+
187+
For Kubernetes version {{< skew currentVersion >}}, you can use this annotation on Secrets, ConfigMaps,
188+
or custom resources if the CustomResourceDefinition
189+
defining them has the `applyset.kubernetes.io/is-parent-type` label.
190+
191+
Part of the specification used to implement
192+
[ApplySet-based pruning in kubectl](/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune).
193+
This annotation is applied to the parent object used to track an ApplySet to optimize listing of
194+
ApplySet member objects. It is optional in the ApplySet specification, as tools can perform discovery
195+
or use a different optimization. However, as of Kubernetes version {{< skew currentVersion >}},
196+
it is required by kubectl. When present, the value of this annotation must be a comma separated list
197+
of the group-kinds, in the fully-qualified name format, i.e. `<resource>.<group>`.
198+
199+
{{< note >}}
200+
This annotation is currently deprecated and replaced by [`applyset.kubernetes.io/contains-group-kinds`](#applyset-kubernetes-io-contains-group-kinds),
201+
support for this will be removed in applyset beta or GA.
202+
{{< /note >}}
203+
179204
### applyset.kubernetes.io/id (alpha) {#applyset-kubernetes-io-id}
180205

181206
Type: Label

0 commit comments

Comments
 (0)