Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 64efca4

Browse files
pospispazacharysarah
authored and
zacharysarah
committedApr 16, 2018
Bring PVC Protection Feature to Beta (#7165)
* Bring PVC Protection Feature to Beta The PR: kubernetes/kubernetes#59052 brought PVC Protection feature to beta. That's why the documentation is updated accordingly. * The PVC Protection feature was renamed to Storage Protection. That's why the documentation is updated.
1 parent b7bced3 commit 64efca4

File tree

3 files changed

+32
-9
lines changed

3 files changed

+32
-9
lines changed
 

‎docs/admin/admission-controllers.md

+10
Original file line numberDiff line numberDiff line change
@@ -416,6 +416,7 @@ This admission controller also protects the access to `metadata.ownerReferences[
416416
of an object, so that only users with "update" permission to the `finalizers`
417417
subresource of the referenced *owner* can change it.
418418

419+
<<<<<<< HEAD
419420
<<<<<<< HEAD
420421
### PersistentVolumeLabel (DEPRECATED)
421422
||||||| merged common ancestors
@@ -428,6 +429,15 @@ The `PVCProtection` plugin adds the `kubernetes.io/pvc-protection` finalizer to
428429
### Persistent Volume Claim Protection (alpha)
429430
{% assign for_k8s_version="v1.9" %}{% include feature-state-alpha.md %}
430431
The `PVCProtection` plugin adds the `kubernetes.io/pvc-protection` finalizer to newly created Persistent Volume Claims (PVCs). In case a user deletes a PVC the PVC is not removed until the finalizer is removed from the PVC by PVC Protection Controller. Refer to the [PVC Protection](/docs/concepts/storage/persistent-volumes/#persistent-volume-claim-protection) for more detailed information.
432+
||||||| merged common ancestors
433+
### Persistent Volume Claim Protection (alpha)
434+
{% assign for_k8s_version="v1.9" %}{% include feature-state-alpha.md %}
435+
The `PVCProtection` plugin adds the `kubernetes.io/pvc-protection` finalizer to newly created Persistent Volume Claims (PVCs). In case a user deletes a PVC the PVC is not removed until the finalizer is removed from the PVC by PVC Protection Controller. Refer to the [PVC Protection](/docs/concepts/storage/persistent-volumes/#persistent-volume-claim-protection) for more detailed information.
436+
=======
437+
### Storage Protection (beta)
438+
{% assign for_k8s_version="v1.10" %}{% include feature-state-beta.md %}
439+
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.
440+
>>>>>>> Bring PVC Protection Feature to Beta (#7165)
431441

432442
### PersistentVolumeLabel (DEPRECATED)
433443
>>>>>>> deprecate three admission controller (#7363)

‎docs/concepts/storage/persistent-volumes.md

+16
Original file line numberDiff line numberDiff line change
@@ -70,14 +70,30 @@ Pods use claims as volumes. The cluster inspects the claim to find the bound vol
7070

7171
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).
7272

73+
<<<<<<< HEAD
7374
### Storage Object in Use Protection
7475
{% assign for_k8s_version="v1.10" %}{% include feature-state-beta.md %}
7576
The purpose of the Storage Object in Use Protection feature is to ensure that Persistent Volume Claims (PVCs) in active use by a pod and Persistent Volume (PVs) that are bound to PVCs are not removed from the system as this may result in data loss.
77+
||||||| merged common ancestors
78+
### Persistent Volume Claim Protection
79+
{% assign for_k8s_version="v1.9" %}{% include feature-state-alpha.md %}
80+
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.
81+
=======
82+
### Storage Protection
83+
{% assign for_k8s_version="v1.10" %}{% include feature-state-beta.md %}
84+
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.
85+
>>>>>>> Bring PVC Protection Feature to Beta (#7165)
7686
7787
**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`.
7888
{: .note}
7989

90+
<<<<<<< HEAD
8091
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.
92+
||||||| merged common ancestors
93+
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.
94+
=======
95+
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.
96+
>>>>>>> Bring PVC Protection Feature to Beta (#7165)
8197
8298
You can see that a PVC is protected when the PVC's status is `Terminating` and the `Finalizers` list includes `kubernetes.io/pvc-protection`:
8399

‎docs/tasks/administer-cluster/pvc-protection.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,25 @@
22
reviewers:
33
- msau42
44
- jsafrane
5-
title: Persistent Volume Claim Protection
5+
title: Storage Protection
66
---
77

88
{% capture overview %}
9-
{% assign for_k8s_version="v1.9" %}{% include feature-state-alpha.md %}
9+
{% assign for_k8s_version="v1.10" %}{% include feature-state-beta.md %}
1010

11-
As of Kubernetes 1.9, persistent volume claims (PVCs) that are in active use by a pod can be protected from pre-mature removal.
11+
Persistent volume claims (PVCs) that are in active use by a pod can be protected from pre-mature removal.
1212

1313
{% endcapture %}
1414

1515
{% capture prerequisites %}
1616

17-
- A v1.9 or higher Kubernetes must be installed.
18-
- As PVC Protection is a Kubernetes v1.9 alpha feature it must be enabled:
19-
1. [Admission controller](/docs/admin/admission-controllers/) must be started with the [PVC Protection plugin](/docs/admin/admission-controllers/#persistent-volume-claim-protection-alpha).
20-
2. All Kubernetes components must be started with the `PVCProtection` alpha features enabled.
17+
- The Storage Protection feature is enabled in a version of Kubernetes in which it is supported.
2118

2219
{% endcapture %}
2320

2421
{% capture steps %}
2522

26-
## PVC Protection Verification
23+
## Storage Protection feature used for PVC Protection
2724

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

@@ -216,7 +213,7 @@ spec:
216213
Warning FailedScheduling 18s (x4 over 21s) default-scheduler persistentvolumeclaim "slzc" is being deleted
217214
```
218215

219-
- Wait until the pod status of both pods is `Terminated` (either delete the pods or wait until they finish). Afterwards, check that the PVC is removed.
216+
- Wait until the pod status of both pods is `Terminated` or `Completed` (either delete the pods or wait until they finish). Afterwards, check that the PVC is removed.
220217

221218
{% endcapture %}
222219

0 commit comments

Comments
 (0)
Please sign in to comment.