mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
95 lines
5.6 KiB
Plaintext
95 lines
5.6 KiB
Plaintext
:_mod-docs-content-type: ASSEMBLY
|
|
[id="working-with-volume-snapshots-microshift"]
|
|
= Working with volume snapshots
|
|
include::_attributes/attributes-microshift.adoc[]
|
|
:context: volume-snapshots-microshift
|
|
|
|
toc::[]
|
|
|
|
{microshift-short} administrators can use volume snapshots to help protect against data loss by using the supported {microshift-short} logical volume manager storage (LVMS) Container Storage Interface (CSI) provider. Familiarity with xref:../microshift_storage/using-persistent-storage-microshift.adoc#persistent-volumes_using-persistent-storage-microshift[persistent volumes] is required.
|
|
|
|
A snapshot represents the state of the storage volume in a node at a particular point in time. Volume snapshots can also be used to provision new volumes. Snapshots are created as read-only logical volumes (LVs) located on the same device as the original data.
|
|
|
|
A {microshift-short} administrator can complete the following tasks using CSI volume snapshots:
|
|
|
|
* Create a snapshot of an existing persistent volume claim (PVC).
|
|
* Back up a volume snapshot to a secure location.
|
|
* Restore a volume snapshot as a different PVC.
|
|
* Delete an existing volume snapshot.
|
|
|
|
[IMPORTANT]
|
|
====
|
|
Only the logical volume manager storage (LVMS) plugin CSI driver is supported by {microshift-short}.
|
|
====
|
|
|
|
//additional resources for assembly intro; trailing because 1) relevant here, 2) TOC levels, and 2) last called module has addt'l resources
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../microshift_storage/using-persistent-storage-microshift.adoc#persistent-volumes_using-persistent-storage-microshift[Using persistent volumes]
|
|
|
|
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/managing-lvm-volume-groups_configuring-and-managing-logical-volumes[Managing LVM volume groups] ({op-system-base} documentation)
|
|
|
|
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-version}/html/storage/using-container-storage-interface-csi#persistent-storage-csi-snapshots[CSI snapshots: `VolumeSnapshot` APIs] ({OCP} documentation)
|
|
|
|
* link:https://docs.openshift.com/container-platform/{ocp-version}/rest_api/storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.html[VolumeSnapshot API specification] ({OCP} documentation)
|
|
|
|
include::modules/microshift-lvm-thin-volumes.adoc[leveloffset=+1]
|
|
|
|
//additional resources for thin volumes module
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* To create a thin pool on the host, see link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/basic-logical-volume-management_configuring-and-managing-logical-volumes#creating-thin-logical-volume_creating-logical-volumes[Creating a thin logical volume] ({op-system-base} documentation)
|
|
|
|
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/creating-and-managing-thin-provisioned-volumes_configuring-and-managing-logical-volumes[Configuring and managing thin provisioned volumes]
|
|
|
|
* xref:../microshift_storage/volume-snapshots-microshift.adoc#microshift-storage-classes_volume-snapshots-microshift[Storage classes]
|
|
|
|
* xref:../microshift_storage/microshift-storage-plugin-overview.adoc#microshift-storage-device-classes_microshift-storage-plugin-overview[Storage device classes]
|
|
|
|
include::modules/microshift-storage-classes.adoc[leveloffset=+2]
|
|
|
|
//additional resources for storage classes module
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/storage/dynamic-provisioning#defining-storage-classes_dynamic-provisioning[Defining storage classes]
|
|
|
|
* xref:../microshift_storage/microshift-storage-plugin-overview.adoc#microshift-storage-device-classes_microshift-storage-plugin-overview[Storage device classes]
|
|
|
|
include::modules/microshift-storage-vol-snapshot-class.adoc[leveloffset=+1]
|
|
|
|
//additional resources for volume snapshot classes module
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/storage/using-container-storage-interface-csi#persistent-storage-csi-snapshots-overview_persistent-storage-csi-snapshots[OpenShift CSI volume snapshots]
|
|
|
|
include::modules/microshift-storage-about-vol-snapshots.adoc[leveloffset=+1]
|
|
|
|
include::modules/microshift-storage-creating-vol-snapshot.adoc[leveloffset=+2]
|
|
|
|
include::modules/microshift-storage-backup-volume-snapshots.adoc[leveloffset=+2]
|
|
|
|
include::modules/microshift-storage-vol-snapshot-restore.adoc[leveloffset=+2]
|
|
|
|
//additional resources for volume snapshot restore module
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/storage/using-container-storage-interface-csi#persistent-storage-csi-snapshots-restore_persistent-storage-csi-snapshots[Restoring a volume snapshot]
|
|
|
|
//this module is reused from OCP; take care in editing for MicroShift
|
|
include::modules/persistent-storage-csi-snapshots-delete.adoc[leveloffset=+2]
|
|
|
|
include::modules/microshift-storage-volume-cloning.adoc[leveloffset=+1]
|
|
|
|
//additional resources for volume cloning module
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/storage/using-container-storage-interface-csi#persistent-storage-csi-cloning[CSI volume cloning]
|
|
|
|
* To configure the host to enable cloning, see xref:../microshift_storage/volume-snapshots-microshift.adoc#microshift-lvm-thin-volumes_volume-snapshots-microshift[About LVM thin volumes]
|