Skip to content

Commit 3cc1b1b

Browse files
committed
Add disclaimers before reorganizing this reference page between API groups
1 parent 167ddd3 commit 3cc1b1b

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

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

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -452,20 +452,30 @@ for more information.
452452

453453
## pod-security.kubernetes.io/exempt
454454

455+
455456
Example: `pod-security.kubernetes.io/exempt: namespace`
456457

457-
Used on: Event
458+
Used on: `audit.k8s.io/Event`
458459

459460
Value **must** be one of `user`, `namespace`, or `runtimeClass` which correspond to
460461
[Pod Security Exemption](/docs/concepts/security/pod-security-admission/#exemptions)
461462
dimensions. This annotation indicates on which dimension was based the exemption
462463
from the PodSecurity enforcement.
463464

465+
{{< caution >}}
466+
This annotation is not used within the Kubernetes API. When you
467+
[enable auditing](/docs/tasks/debug-application-cluster/audit/) in your cluster,
468+
audit event data is written using `Event` from API group `audit.k8s.io`.
469+
The annotation applies to audit events. Audit events are different from objects in the
470+
[Event API](/docs/reference/kubernetes-api/cluster-resources/event-v1/) (API group
471+
`events.k8s.io`).
472+
{{< /caution >}}
473+
464474
## pod-security.kubernetes.io/enforce-policy
465475

466476
Example: `pod-security.kubernetes.io/enforce-policy: restricted:latest`
467477

468-
Used on: Event
478+
Used on: `audit.k8s.io/Event`
469479

470480
Value **must** be `privileged:<version>`, `baseline:<version>`,
471481
`restricted:<version>` which correspond to [Pod Security
@@ -477,13 +487,22 @@ allowed or denied the pod during PodSecurity admission.
477487
See [Pod Security Standards](/docs/concepts/security/pod-security-standards/)
478488
for more information.
479489

490+
{{< caution >}}
491+
This annotation is not used within the Kubernetes API. When you
492+
[enable auditing](/docs/tasks/debug-application-cluster/audit/) in your cluster,
493+
audit event data is written using `Event` from API group `audit.k8s.io`.
494+
The annotation applies to audit events. Audit events are different from objects in the
495+
[Event API](/docs/reference/kubernetes-api/cluster-resources/event-v1/) (API group
496+
`events.k8s.io`).
497+
{{< /caution >}}
498+
480499
## pod-security.kubernetes.io/audit-violations
481500

482501
Example: `pod-security.kubernetes.io/audit-violations: would violate
483502
PodSecurity "restricted:latest": allowPrivilegeEscalation != false (container
484503
"example" must set securityContext.allowPrivilegeEscalation=false), ...`
485504

486-
Used on: Event
505+
Used on: `audit.k8s.io/Event`
487506

488507
Value details an audit policy violation, it contains the
489508
[Pod Security Standard](/docs/concepts/security/pod-security-standards/) level
@@ -493,6 +512,15 @@ violated from the PodSecurity enforcement.
493512
See [Pod Security Standards](/docs/concepts/security/pod-security-standards/)
494513
for more information.
495514

515+
{{< caution >}}
516+
This annotation is not used within the Kubernetes API. When you
517+
[enable auditing](/docs/tasks/debug-application-cluster/audit/) in your cluster,
518+
audit event data is written using `Event` from API group `audit.k8s.io`.
519+
The annotation applies to audit events. Audit events are different from objects in the
520+
[Event API](/docs/reference/kubernetes-api/cluster-resources/event-v1/) (API group
521+
`events.k8s.io`).
522+
{{< /caution >}}
523+
496524
## seccomp.security.alpha.kubernetes.io/pod (deprecated) {#seccomp-security-alpha-kubernetes-io-pod}
497525

498526
This annotation has been deprecated since Kubernetes v1.19 and will become non-functional in v1.25.

0 commit comments

Comments
 (0)