diff --git a/docs/guides/volume-populator/deployment/index.md b/docs/guides/volume-populator/deployment/index.md index 473b038..c7ffe3d 100644 --- a/docs/guides/volume-populator/deployment/index.md +++ b/docs/guides/volume-populator/deployment/index.md @@ -14,7 +14,7 @@ section_menu_id: guides # Populating volumes of a Deployment -This guide will show you how to use KubeStash to populate the volumes of a `Deployment`. Within this guide, we will demonstrate the process of backing up volumes of a `Deployment` and subsequently restoring it using Kubernetes native approach, facilitated by KubeStash. +This guide will show you how to use KubeStash to populate the volumes of a `Deployment`. We'll walk through backing up the volumes of a Deployment and then restoring the backed up data to new PVCs in a Kubernetes-native way with KubeStash. ## Before You Begin - At first, you need to have a Kubernetes cluster, and the `kubectl` command-line tool must be configured to communicate with your cluster. If you do not already have a cluster, you can create one by using [kind](https://kind.sigs.k8s.io/docs/user/quick-start/). diff --git a/docs/guides/volume-populator/overview/index.md b/docs/guides/volume-populator/overview/index.md index b5e6e8f..d04a7c1 100644 --- a/docs/guides/volume-populator/overview/index.md +++ b/docs/guides/volume-populator/overview/index.md @@ -17,8 +17,7 @@ section_menu_id: guides This guide will give you an overview of how volume populator process works in KubeStash. ## How Volume Populator Process Works? - -The following diagram shows how KubeStash restores backup data into a specific volume and attaching it to user-provided Persistent Volume Claims (PVCs) for usage of various workload applications. +The following diagram shows how KubeStash populates a Persistent Volume Claim with data sourced from a KubeStash Snapshot.
  KubeStash Volume Populator Process Flow @@ -29,9 +28,9 @@ The `Volume Populator` process consists of the following steps: 1. KubeStash operator watches for `PVCs`. -2. When the operator finds a `PVC` with `spec.dataSourceRef` set and refers to a KubeStash `Snapshot` object, it starts populating this `PVC` by creating a volume populator `Job` that mounts a temporary `PVC`. +2. When the operator finds a `PVC` with `spec.dataSourceRef` set and refers to a KubeStash `Snapshot` object, it creates a volume populator `Job` that mounts a temporary `PVC`. -3. Then the populator Job restores the referred `Snapshot` into this temporary PVC. +3. Then the populator Job restores the referred `Snapshot` into the temporary PVC. 4. Once the restoration process is complete, the KubeStash operator deletes this populator `Job` and temporary `PVC`, and binds the `PV` containing the restored data with the desired `PVC`. diff --git a/docs/guides/volume-populator/pvc/index.md b/docs/guides/volume-populator/pvc/index.md index d6f3c2c..e4cb03d 100644 --- a/docs/guides/volume-populator/pvc/index.md +++ b/docs/guides/volume-populator/pvc/index.md @@ -14,7 +14,7 @@ section_menu_id: guides # Populating a volume of a Standalone PVC -This guide will show you how to use KubeStash to populate volume of a Stand-alone PersistentVolumeClaims (PVCs). Within this guide, we will demonstrate the process of backing up a Stand-alone `PVC` and subsequently restoring it using Kubernetes native approach, facilitated by KubeStash. +This guide will show you how to use KubeStash to populate the volume of a Stand-alone PersistentVolumeClaim (PVC). We'll walk through backing up a Stand-alone PVC and then restoring the backed up data to a new PVC in a Kubernetes-native way with KubeStash. ## Before You Begin diff --git a/docs/guides/volume-populator/statefulset/index.md b/docs/guides/volume-populator/statefulset/index.md index 9f1897d..13825ba 100644 --- a/docs/guides/volume-populator/statefulset/index.md +++ b/docs/guides/volume-populator/statefulset/index.md @@ -14,8 +14,7 @@ section_menu_id: guides # Populating volumes of a StatefulSet -This guide will show you how to use KubeStash to populate the volumes of a `StatefulSet`. Within this guide, we will demonstrate the process of backing up volumes of a `StatefulSet` and subsequently restoring it using Kubernetes native approach, facilitated by KubeStash. - +This guide will show you how to use KubeStash to populate the volumes of a `StatefulSet`. We'll walk through backing up the volumes of a Statefulset and then restoring the backed up data to a new StatefulSet in a Kubernetes-native way with KubeStash. ## Before You Begin - At first, you need to have a Kubernetes cluster, and the `kubectl` command-line tool must be configured to communicate with your cluster. If you do not already have a cluster, you can create one by using [kind](https://kind.sigs.k8s.io/docs/user/quick-start/). - Install `KubeStash` in your cluster following the steps [here](/docs/setup/README.md). diff --git a/docs/guides/volumesnapshot/deployment/index.md b/docs/guides/volumesnapshot/deployment/index.md index cf5e063..7c2e664 100644 --- a/docs/guides/volumesnapshot/deployment/index.md +++ b/docs/guides/volumesnapshot/deployment/index.md @@ -468,7 +468,7 @@ Here, KubeStash keeps the backup for Snapshot YAMLs. If we navigate to the GCS bucket, we will see the Snapshot YAML stored in the `` directory. -**Verify Volume Snapshot :** +**Verify VolumeSnapshot:** Once a `BackupSession` CR is created, KubeStash operator creates a volume snapshotter `Job`. Then the `Job` creates a `VolumeSnapshot` CR for the targeted PVC. @@ -512,7 +512,7 @@ status: ``` -Here, `spec.status.boundVolumeSnapshotContentName` field specifies the name of the `VolumeSnapshotContent` object. It also represents the actual snapshot name that has been saved in Google Cloud. If we navigate to the `Snapshots` tab in the GCP console, we are going to see snapshot `snapcontent-f4a199c2-eed5-4438-aa09-e9c9683556ef` has been stored successfully. +Here, `status.boundVolumeSnapshotContentName` field specifies the name of the `VolumeSnapshotContent` object. It also represents the actual snapshot name that has been saved in Google Cloud. If we navigate to the `Snapshots` tab in the GCP console, we are going to see snapshot `snapcontent-f4a199c2-eed5-4438-aa09-e9c9683556ef` has been stored successfully.
  Snapshots in GCP diff --git a/docs/guides/volumesnapshot/overview/index.md b/docs/guides/volumesnapshot/overview/index.md index ad0a2cb..619f0ef 100644 --- a/docs/guides/volumesnapshot/overview/index.md +++ b/docs/guides/volumesnapshot/overview/index.md @@ -53,7 +53,7 @@ The `VolumeSnapshot` process consists of the following steps: 13. Then, It creates a volume snapshotter `Job` to capture snapshots of the targeted volumes. -14. The volume snapshotter `Job` creates a `VolumeSnapshot`(s) object for each Persistent Volume Claims (PVC) associated the target and waits for the Container Storage Interface (CSI) driver to complete snapshotting. The VolumeSnapshot(s) are created with the following naming format: +14. The volume snapshotter `Job` creates a `VolumeSnapshot` object for each Persistent Volume Claim (PVC) associated the target and waits for the Container Storage Interface (CSI) driver to complete snapshotting. The VolumeSnapshot(s) are created with the following naming format: ```bash - ``` @@ -84,7 +84,7 @@ The restore process consists of the following steps: 4. Then, it creates a Restore `Job` to restore `PVC` from the `volumeSnapshot`. -5. The restore job retrieves `VolumeSnapshot` information from the Snapshot. It starts by creating PVCs based on `volumeClaimTemplates` and assigns the corresponding `VolumeSnapshot` name to the `spec.dataSourceRef` of each PVC. +5. The restore job retrieves `VolumeSnapshot` information from the Snapshot. Then it creates PVCs based on the `volumeClaimTemplates` with `spec.dataSourceRef` field set to the respective `VolumeSnapshot` name. 6. Container Storage Interface (CSI) `external-snapshotter` controller watches for `PVCs`. diff --git a/docs/guides/volumesnapshot/pvc/index.md b/docs/guides/volumesnapshot/pvc/index.md index 5c3d17d..ba97d5f 100644 --- a/docs/guides/volumesnapshot/pvc/index.md +++ b/docs/guides/volumesnapshot/pvc/index.md @@ -429,7 +429,7 @@ Here, KubeStash keeps the backup for Snapshot YAMLs. If we navigate to the GCS bucket, we will see the Snapshot YAML stored in the `` directory. -**Verify Volume Snapshot :** +**Verify VolumeSnapshot:** Once a `BackupSession` CR is created, KubeStash operator creates a volume snapshotter `Job`. Then the `Job` creates a `VolumeSnapshot` CR for the targeted PVC. @@ -471,7 +471,7 @@ status: restoreSize: 1Gi ``` -Here, `spec.status.boundVolumeSnapshotContentName` field specifies the name of the `VolumeSnapshotContent` object. It also represents the actual snapshot name that has been saved in Google Cloud. If we navigate to the `Snapshots` tab in the GCP console, we are going to see snapshot `snapcontent-1fa0a06c-80bb-4e7c-b584-579ddceb649d` has been stored successfully. +Here, `status.boundVolumeSnapshotContentName` field specifies the name of the `VolumeSnapshotContent` object. It also represents the actual snapshot name that has been saved in Google Cloud. If we navigate to the `Snapshots` tab in the GCP console, we are going to see snapshot `snapcontent-1fa0a06c-80bb-4e7c-b584-579ddceb649d` has been stored successfully.
  Snapshots in GCP console diff --git a/docs/guides/volumesnapshot/statefulset/index.md b/docs/guides/volumesnapshot/statefulset/index.md index 4050ff5..c056e31 100644 --- a/docs/guides/volumesnapshot/statefulset/index.md +++ b/docs/guides/volumesnapshot/statefulset/index.md @@ -483,7 +483,7 @@ Here, KubeStash keeps the backup for Snapshot YAMLs. If we navigate to the GCS bucket, we will see the Snapshot YAML stored in the `` directory. -**Verify Volume Snapshot :** +**Verify VolumeSnapshot:** Once a `BackupSession` CR is created, KubeStash operator creates a volume snapshotter `Job`. Then the `Job` creates a `VolumeSnapshot` CR for the targeted PVC. @@ -527,7 +527,7 @@ status: restoreSize: 1Gi ``` -Here, `spec.status.boundVolumeSnapshotContentName` field specifies the name of the `VolumeSnapshotContent` object. It also represents the actual snapshot name that has been saved in Google Cloud. If we navigate to the `Snapshots` tab in the GCP console, we are going to see snapshot `snapcontent-f4a199c2-eed5-4438-aa09-e9c9683556ef` has been stored successfully. +Here, `status.boundVolumeSnapshotContentName` field specifies the name of the `VolumeSnapshotContent` object. It also represents the actual snapshot name that has been saved in Google Cloud. If we navigate to the `Snapshots` tab in the GCP console, we are going to see snapshot `snapcontent-f4a199c2-eed5-4438-aa09-e9c9683556ef` has been stored successfully.
  Snapshots in GCP