Skip to content

Commit

Permalink
Added Documents for various annotation
Browse files Browse the repository at this point in the history
Signed-off-by: afzal442 <afzal442@gmail.com>
  • Loading branch information
afzal442 committed Sep 2, 2022
1 parent cf2ecb7 commit 7597df3
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions content/en/docs/reference/labels-annotations-taints/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,34 @@ Used on: PersistentVolumeClaim

This annotation will be added to dynamic provisioning required PVC.

### volume.kubernetes.io/selected-node

Used on: PersistentVolumeClaim

This annotation is added to a PVC that has been triggered by scheduler to be dynamically provisioned. Its value is the name of the selected node.

### pv.kubernetes.io/bind-completed
Example: `pv.kubernetes.io/bind-completed: "true"`

Used on: PersistentVolumeClaim

The value for this annotation must be true to take effect. This annotation indicates that {{< glossary_tooltip text="PersistentVolumeClaim" term_id="persistent-volume-claim" >}} was successfully bound to a PersistentVolume.

### pv.kubernetes.io/bound-by-controller
Example: `pv.kubernetes.io/bound-by-controller: "true"`

Used on: PersistentVolume or PersistentVolumeClaim

Value can either be `true` or `false`.
This annotation applies to PVs and PVCs. It indicates that the binding (PV->PVC or PVC->PV) was installed by the controller. The absence of this annotation means the binding was done by the user (i.e. pre-bound). Value of this annotation does not matter. External PV binders must bind PV the same way as PV controller, otherwise PV controller may not handle it correctly.

### pv.kubernetes.io/provisioned-by
Example: `pv.kubernetes.io/provisioned-by: "flexVolume"`

Used on: PersistentVolume

This annotation is added to a PV that has been dynamically provisioned by Kubernetes. Its value is name of volume plugin that created the volume. It serves both user (to show where a PV comes from) and Kubernetes (to recognize dynamically provisioned PVs in its decisions).

### node.kubernetes.io/windows-build {#nodekubernetesiowindows-build}

Example: `node.kubernetes.io/windows-build: "10.0.17763"`
Expand All @@ -335,6 +363,14 @@ When the kubelet is running on Microsoft Windows, it automatically labels its no

The label's value is in the format "MajorVersion.MinorVersion.BuildNumber".

### storage.alpha.kubernetes.io/migrated-plugins

Example: `storage.alpha.kubernetes.io/migrated-plugins: kubernetes.io/gce-pd`

Used on: CSINode

This annotation is used by the Attach Detach Controller to determine whether to use the in-tree or CSI Drivers for a volume plugin on a specific node. They key is set for CSINode objects, that is a comma-separated list of in-tree plugins that will be serviced by the CSI Drivers on the Node represented by CSINode.

### service.kubernetes.io/headless {#servicekubernetesioheadless}

Example: `service.kubernetes.io/headless: ""`
Expand Down Expand Up @@ -414,6 +450,14 @@ Used on: IngressClass

When a single IngressClass resource has this annotation set to `"true"`, new Ingress resource without a class specified will be assigned this default class.

### ingress.kubernetes.io/whitelist-source-range

Example: `ingress.kubernetes.io/whitelist-source-range: "10.0.0.0/24,172.10.0.1"`

Used on: Ingress

The value is a comma separated list of CIDRs. The allowed client IP source ranges can be specified through the annotation.

### kubernetes.io/ingress.class (deprecated)

{{< note >}}
Expand Down

0 comments on commit 7597df3

Please sign in to comment.