Pod Preset
This page provides an overview of PodPresets, which are objects for injecting certain information into pods at creation time. The information can include secrets, volumes, volume mounts, and environment variables.
Understanding Pod Presets
A Pod Preset is an API resource for injecting additional runtime requirements
into a Pod at creation time.
You use label selectors
to specify the Pods to which a given Pod Preset applies.
Using a Pod Preset allows pod template authors to not have to explicitly provide all information for every pod. This way, authors of pod templates consuming a specific service do not need to know all the details about that service.
For more information about the background, see the design proposal for PodPreset.
How It Works
Kubernetes provides an admission controller (PodPreset) which, when enabled,
applies Pod Presets to incoming pod creation requests.
When a pod creation request occurs, the system does the following:
- Retrieve all
PodPresetsavailable for use. - Check if the label selectors of any
PodPresetmatches the labels on the pod being created. - Attempt to merge the various resources defined by the
PodPresetinto the Pod being created. - On error, throw an event documenting the merge error on the pod, and create
the pod without any injected resources from the
PodPreset. - Annotate the resulting modified Pod spec to indicate that it has been
modified by a
PodPreset. The annotation is of the formpodpreset.admission.kubernetes.io/podpreset-<pod-preset name>: "<resource version>".
Each Pod can be matched zero or more Pod Presets; and each PodPreset can be
applied to zero or more pods. When a PodPreset is applied to one or more
Pods, Kubernetes modifies the Pod Spec. For changes to Env, EnvFrom, and
VolumeMounts, Kubernetes modifies the container spec for all containers in
the Pod; for changes to Volume, Kubernetes modifies the Pod Spec.
Note: A Pod Preset is capable of modifying the spec.containers field in a
Pod spec when appropriate. No resource definition from the Pod Preset will be
applied to the initContainers field.
Disable Pod Preset for a Specific Pod
There may be instances where you wish for a Pod to not be altered by any Pod
Preset mutations. In these cases, you can add an annotation in the Pod Spec
of the form: podpreset.admission.kubernetes.io/exclude: "true".
Enable Pod Preset
In order to use Pod Presets in your cluster you must ensure the following:
- You have enabled the API type
settings.k8s.io/v1alpha1/podpreset. For example, this can be done by includingsettings.k8s.io/v1alpha1=truein the--runtime-configoption for the API server. - You have enabled the admission controller
PodPreset. One way to doing this is to includePodPresetin the--admission-controloption value specified for the API server. - You have defined your Pod Presets by creating
PodPresetobjects in the namespace you will use.