Skip to content

Commit

Permalink
Storage Protection was renamed to Storage Object in Use Protection (#…
Browse files Browse the repository at this point in the history
…7576)

* Storage Protection was renamed to Storage Object in Use Protection

The K8s PR: kubernetes/kubernetes#59901
renamed Storage Protection to Storage Object in Use Protection.

That's why the same is also renamed in the documentation.

* Moved Storage Object in Use Protection admission plugin description down according to alphabetic order.
  • Loading branch information
pospispa authored and zacharysarah committed Apr 16, 2018
1 parent 614d47c commit b4ccb71
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 3 deletions.
8 changes: 8 additions & 0 deletions docs/admin/admission-controllers.md
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,7 @@ This admission controller also protects the access to `metadata.ownerReferences[
of an object, so that only users with "update" permission to the `finalizers`
subresource of the referenced *owner* can change it.

<<<<<<< HEAD
<<<<<<< HEAD
<<<<<<< HEAD
### PersistentVolumeLabel (DEPRECATED)
Expand All @@ -439,6 +440,13 @@ The `PVCProtection` plugin adds the `kubernetes.io/pvc-protection` finalizer to
The `StorageProtection` plugin adds the `kubernetes.io/pvc-protection` or `kubernetes.io/pv-protection` finalizers to newly created Persistent Volume Claims (PVCs) or Persistent Volumes (PV). In case a user deletes a PVC or PV the PVC or PV is not removed until the finalizer is removed from the PVC or PV by PVC or PV Protection Controller. Refer to the [PVC Protection](/docs/concepts/storage/persistent-volumes/#persistent-volume-claim-protection) for more detailed information.
>>>>>>> Bring PVC Protection Feature to Beta (#7165)

||||||| merged common ancestors
### Storage Protection (beta)
{% assign for_k8s_version="v1.10" %}{% include feature-state-beta.md %}
The `StorageProtection` plugin adds the `kubernetes.io/pvc-protection` or `kubernetes.io/pv-protection` finalizers to newly created Persistent Volume Claims (PVCs) or Persistent Volumes (PV). In case a user deletes a PVC or PV the PVC or PV is not removed until the finalizer is removed from the PVC or PV by PVC or PV Protection Controller. Refer to the [PVC Protection](/docs/concepts/storage/persistent-volumes/#persistent-volume-claim-protection) for more detailed information.

=======
>>>>>>> Storage Protection was renamed to Storage Object in Use Protection (#7576)
### PersistentVolumeLabel (DEPRECATED)
>>>>>>> deprecate three admission controller (#7363)

Expand Down
18 changes: 18 additions & 0 deletions docs/concepts/storage/persistent-volumes.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ Pods use claims as volumes. The cluster inspects the claim to find the bound vol

Once a user has a claim and that claim is bound, the bound PV belongs to the user for as long as they need it. Users schedule Pods and access their claimed PVs by including a `persistentVolumeClaim` in their Pod's volumes block. [See below for syntax details](#claims-as-volumes).

<<<<<<< HEAD
<<<<<<< HEAD
### Storage Object in Use Protection
{% assign for_k8s_version="v1.10" %}{% include feature-state-beta.md %}
Expand All @@ -80,20 +81,37 @@ The purpose of the Storage Object in Use Protection feature is to ensure that Pe
The purpose of the PVC protection is to ensure that PVCs in active use by a pod are not removed from the system as this may result in data loss.
=======
### Storage Protection
||||||| merged common ancestors
### Storage Protection
=======
### Storage Object in Use Protection
>>>>>>> Storage Protection was renamed to Storage Object in Use Protection (#7576)
{% assign for_k8s_version="v1.10" %}{% include feature-state-beta.md %}
<<<<<<< HEAD
The purpose of the Storage Protection feature is to ensure that Persistent Volume Claims (PVCs) in active use by a pod are not removed from the system as this may result in data loss.
>>>>>>> Bring PVC Protection Feature to Beta (#7165)
||||||| merged common ancestors
The purpose of the Storage Protection feature is to ensure that Persistent Volume Claims (PVCs) in active use by a pod are not removed from the system as this may result in data loss.
=======
The purpose of the Storage Object in Use Protection feature is to ensure that Persistent Volume Claims (PVCs) in active use by a pod are not removed from the system as this may result in data loss.
>>>>>>> Storage Protection was renamed to Storage Object in Use Protection (#7576)
**Note:** PVC is in active use by a pod when the pod status is `Pending` and the pod is assigned to a node or the pod status is `Running`.
{: .note}

<<<<<<< HEAD
<<<<<<< HEAD
When the [Storage Object in Use Protection beta feature](/docs/tasks/administer-cluster/storage-object-in-use-protection/) is enabled, if a user deletes a PVC in active use by a pod, the PVC is not removed immediately. PVC removal is postponed until the PVC is no longer actively used by any pods, and also if admin deletes a PV that is bound to a PVC, the PV is not removed immediately. PV removal is postponed until the PV is not bound to a PVC any more.
||||||| merged common ancestors
When the [PVC protection alpha feature](/docs/tasks/administer-cluster/pvc-protection/) is enabled, if a user deletes a PVC in active use by a pod, the PVC is not removed immediately. PVC removal is postponed until the PVC is no longer actively used by any pods.
=======
When the [Storage Protection beta feature](/docs/tasks/administer-cluster/pvc-protection/) is enabled, if a user deletes a PVC in active use by a pod, the PVC is not removed immediately. PVC removal is postponed until the PVC is no longer actively used by any pods.
>>>>>>> Bring PVC Protection Feature to Beta (#7165)
||||||| merged common ancestors
When the [Storage Protection beta feature](/docs/tasks/administer-cluster/pvc-protection/) is enabled, if a user deletes a PVC in active use by a pod, the PVC is not removed immediately. PVC removal is postponed until the PVC is no longer actively used by any pods.
=======
When the [Storage Object in Use Protection beta feature](/docs/tasks/administer-cluster/pvc-protection/) is enabled, if a user deletes a PVC in active use by a pod, the PVC is not removed immediately. PVC removal is postponed until the PVC is no longer actively used by any pods.
>>>>>>> Storage Protection was renamed to Storage Object in Use Protection (#7576)
You can see that a PVC is protected when the PVC's status is `Terminating` and the `Finalizers` list includes `kubernetes.io/pvc-protection`:

Expand Down
6 changes: 3 additions & 3 deletions docs/tasks/administer-cluster/pvc-protection.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
reviewers:
- msau42
- jsafrane
title: Storage Protection
title: Storage Object in Use Protection
---

{% capture overview %}
Expand All @@ -14,13 +14,13 @@ Persistent volume claims (PVCs) that are in active use by a pod can be protected

{% capture prerequisites %}

- The Storage Protection feature is enabled in a version of Kubernetes in which it is supported.
- The Storage Object in Use Protection feature is enabled in a version of Kubernetes in which it is supported.

{% endcapture %}

{% capture steps %}

## Storage Protection feature used for PVC Protection
## Storage Object in Use Protection feature used for PVC Protection

The example below uses a GCE PD `StorageClass`, however, similar steps can be performed for any volume type.

Expand Down

0 comments on commit b4ccb71

Please sign in to comment.