Mariyan Dimitrov
b70d434b36
* Add kubectl patch example with quotes on Windows When running the `kubectl patch` example, on Windows systems you get an error when passing the patch request in single quotes. Passing it in double quotes with the inner ones escaped produced the desired behavior as is in the example given for Linux systems. I've added a small note for Windows users to have that in mind. Signed-off-by: Mariyan Dimitrov <mariyan.dimitrov@gmail.com> * Use Hugo note shortcode Windows note is placed inside a [shortcode](https://kubernetes.io/docs/contribute/style/style-guide/#shortcodes) to be consistent with the style guide. Signed-off-by: Mariyan Dimitrov <mariyan.dimitrov@gmail.com> * Remove shell Markdown syntax I've removed the shell syntax from the Windows example and have changed the description to be the same as the one used in [jsonpath](https://kubernetes.io/docs/reference/kubectl/jsonpath/) document to be more consistent. The jsonpath example uses cmd syntax, though it is note inside a note shortcode, therefore I've opted out of using any syntax as it seems to break rendering inside the shortcode. Signed-off-by: Mariyan Dimitrov <mariyan.dimitrov@gmail.com> * Add cmd markdown syntax and fix order list I've tested this locally with `make docker-serve` on my Linux machine and finally things are looking better, I've managed to address these two issues: - the Windows example is now inside `note` shortcode and also the cmd syntax renders correctly on the page - the list of steps broke after the first one, I've indented a paragraph and now the steps are in the expected order Signed-off-by: Mariyan Dimitrov <mariyan.dimitrov@gmail.com> * Remove command prompt from example According to the [style guide](https://kubernetes.io/docs/contribute/style/style-guide/#don-t-include-the-command-prompt), the command prompt should not be included when showing an example. This commit removes it for consistency with the style guide. Signed-off-by: Mariyan Dimitrov <mariyan.dimitrov@gmail.com>
97 lines
4.2 KiB
Markdown
97 lines
4.2 KiB
Markdown
---
|
|
title: Change the Reclaim Policy of a PersistentVolume
|
|
content_template: templates/task
|
|
---
|
|
|
|
{{% capture overview %}}
|
|
This page shows how to change the reclaim policy of a Kubernetes
|
|
PersistentVolume.
|
|
{{% /capture %}}
|
|
|
|
{{% capture prerequisites %}}
|
|
|
|
{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}}
|
|
|
|
{{% /capture %}}
|
|
|
|
{{% capture steps %}}
|
|
|
|
## Why change reclaim policy of a PersistentVolume
|
|
|
|
`PersistentVolumes` can have various reclaim policies, including "Retain",
|
|
"Recycle", and "Delete". For dynamically provisioned `PersistentVolumes`,
|
|
the default reclaim policy is "Delete". This means that a dynamically provisioned
|
|
volume is automatically deleted when a user deletes the corresponding
|
|
`PersistentVolumeClaim`. This automatic behavior might be inappropriate if the volume
|
|
contains precious data. In that case, it is more appropriate to use the "Retain"
|
|
policy. With the "Retain" policy, if a user deletes a `PersistentVolumeClaim`,
|
|
the corresponding `PersistentVolume` is not be deleted. Instead, it is moved to the
|
|
`Released` phase, where all of its data can be manually recovered.
|
|
|
|
## Changing the reclaim policy of a PersistentVolume
|
|
|
|
1. List the PersistentVolumes in your cluster:
|
|
|
|
```shell
|
|
kubectl get pv
|
|
```
|
|
|
|
The output is similar to this:
|
|
|
|
NAME CAPACITY ACCESSMODES RECLAIMPOLICY STATUS CLAIM STORAGECLASS REASON AGE
|
|
pvc-b6efd8da-b7b5-11e6-9d58-0ed433a7dd94 4Gi RWO Delete Bound default/claim1 manual 10s
|
|
pvc-b95650f8-b7b5-11e6-9d58-0ed433a7dd94 4Gi RWO Delete Bound default/claim2 manual 6s
|
|
pvc-bb3ca71d-b7b5-11e6-9d58-0ed433a7dd94 4Gi RWO Delete Bound default/claim3 manual 3s
|
|
|
|
This list also includes the name of the claims that are bound to each volume
|
|
for easier identification of dynamically provisioned volumes.
|
|
|
|
1. Choose one of your PersistentVolumes and change its reclaim policy:
|
|
|
|
```shell
|
|
kubectl patch pv <your-pv-name> -p '{"spec":{"persistentVolumeReclaimPolicy":"Retain"}}'
|
|
```
|
|
|
|
where `<your-pv-name>` is the name of your chosen PersistentVolume.
|
|
|
|
{{< note >}}
|
|
On Windows, you must _double_ quote any JSONPath template that contains spaces (not single quote as shown above for bash). This in turn means that you must use a single quote or escaped double quote around any literals in the template. For example:
|
|
|
|
```cmd
|
|
kubectl patch pv <your-pv-name> -p "{\"spec\":{\"persistentVolumeReclaimPolicy\":\"Retain\"}}"
|
|
```
|
|
|
|
{{< /note >}}
|
|
|
|
1. Verify that your chosen PersistentVolume has the right policy:
|
|
|
|
```shell
|
|
kubectl get pv
|
|
```
|
|
|
|
The output is similar to this:
|
|
|
|
NAME CAPACITY ACCESSMODES RECLAIMPOLICY STATUS CLAIM STORAGECLASS REASON AGE
|
|
pvc-b6efd8da-b7b5-11e6-9d58-0ed433a7dd94 4Gi RWO Delete Bound default/claim1 manual 40s
|
|
pvc-b95650f8-b7b5-11e6-9d58-0ed433a7dd94 4Gi RWO Delete Bound default/claim2 manual 36s
|
|
pvc-bb3ca71d-b7b5-11e6-9d58-0ed433a7dd94 4Gi RWO Retain Bound default/claim3 manual 33s
|
|
|
|
In the preceding output, you can see that the volume bound to claim
|
|
`default/claim3` has reclaim policy `Retain`. It will not be automatically
|
|
deleted when a user deletes claim `default/claim3`.
|
|
|
|
{{% /capture %}}
|
|
|
|
{{% capture whatsnext %}}
|
|
* Learn more about [PersistentVolumes](/docs/concepts/storage/persistent-volumes/).
|
|
* Learn more about [PersistentVolumeClaims](/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims).
|
|
|
|
### Reference
|
|
|
|
* [PersistentVolume](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#persistentvolume-v1-core)
|
|
* [PersistentVolumeClaim](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#persistentvolumeclaim-v1-core)
|
|
* See the `persistentVolumeReclaimPolicy` field of [PersistentVolumeSpec](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#persistentvolumeclaim-v1-core).
|
|
{{% /capture %}}
|
|
|
|
|