Skip to content

Commit

Permalink
Add documentation for podpreset opt-out annotation
Browse files Browse the repository at this point in the history
This adds the annotation for having the podpreset admission controller
to skip (opt-out) manipulating the pod spec.

Also, the annotation format for what presets have acted on a pod has
been modified to add a prefix of "podpreset-". The new naming makes it such
that there is no chance of collision with the newly introduced opt-out
annotation (or future ones yet to be added).

Opt-out annotation PR:
kubernetes/kubernetes#44965
  • Loading branch information
jpeeler committed Jun 16, 2017
1 parent ccd2b46 commit a666143
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/tasks/inject-data-application/podpreset.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Kubernetes modifies the Pod Spec.

Kubernetes annotates the resulting modified pod spec to show that it was
modified by a `PodPreset`. The annotation is of the form
`podpreset.admission.kubernetes.io/<pod-preset name>": "<resource version>"`.
`podpreset.admission.kubernetes.io/podpreset-<pod-preset name>": "<resource version>"`.


## Enabling Pod Preset
Expand All @@ -63,6 +63,12 @@ following
1. You have enabled the admission controller `PodPreset`
1. You have defined your pod presets

## Disabling Pod Preset for a pod

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/PodPresetOptOut: "true"`.

## Creating a Pod Preset

### Simple Pod Spec Example
Expand Down

0 comments on commit a666143

Please sign in to comment.