summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff Peeler <jpeeler@redhat.com>2017-06-16 17:45:09 -0400
committerJeff Peeler <jpeeler@redhat.com>2017-06-19 13:34:50 -0400
commit86bf0c2e97e38d9bc565eddc518e9ff7f6e96e4f (patch)
tree48b78a42ad7679da63103d0df8e09f7d5ceeb444
parent37eaace5ddd4e20148d71ac4179c47be6cb43a98 (diff)
Add additional documentation for opt-out annotation
This is a follow up to #716.
-rw-r--r--contributors/design-proposals/pod-preset.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/contributors/design-proposals/pod-preset.md b/contributors/design-proposals/pod-preset.md
index 094bc7bc..53da4dd9 100644
--- a/contributors/design-proposals/pod-preset.md
+++ b/contributors/design-proposals/pod-preset.md
@@ -12,6 +12,7 @@
* [Validations](#validations)
* [AdmissionControl Plug-in: PodPreset](#admissioncontrol-plug-in-podpreset)
* [Behavior](#behavior)
+ * [PodPreset Exclude Annotation](#podpreset-exclude-annotation)
* [Examples](#examples)
* [Simple Pod Spec Example](#simple-pod-spec-example)
* [Pod Spec with `ConfigMap` Example](#pod-spec-with-`configmap`-example)
@@ -192,7 +193,8 @@ injection. These are as follows:
The **PodPreset** plug-in introspects all incoming pod creation
requests and injects the pod based off a `Selector` with the desired
-attributes.
+attributes, except when the [PodPreset Exclude Annotation](#podpreset-exclude-annotation)
+is set to true.
For the initial alpha, the order of precedence for applying multiple
`PodPreset` specs is from oldest to newest. All Pod Injection
@@ -210,6 +212,10 @@ This will be first implemented as an AdmissionControl plug-in then can be
converted to an Initializer once that is fully ready. The proposal for
Initializers can be found at [kubernetes/community#132](https://github.com/kubernetes/community/pull/132).
+#### PodPreset Exclude Annotation
+There may be instances where you wish for a pod to not be altered by any pod
+preset mutations. For these events, one can add an annotation in the pod spec
+of the form: `podpreset.admission.kubernetes.io/exclude: "true"`.
#### Behavior