update doc

Signed-off-by: Shovan Maity <[email protected]>

Author: shovanmaity

docs/demo/01_pv_populator.md

@@ -1,12 +1,11 @@
-PV Populator is a `Volume Populator` that helps to rename a PVC. It does a patch on `PersistentVolume` of older `Claim` with new `Claim`.
+PV Populator is a volume populator that does a patch on PV of older PVC with new PVC. Here source of the volume is the PV of any older PVC. Both the PVC(new and source) should be from same storageclass. It is like mentioning PVC as a data source for a PVC. There one clone volume will be created and here PV of the mentioned PVC will be patched with new PVC. In this way we will be able to rename a PVC and it will refer to the PV of older PVC.
 
 NOTE -
 1. `AnyVolumeDataSource` feature gate should be enabled in the kubernetes cluster.
-2. Default storageclass should be configured for this demo.
-3. Namespace `volume-copy` is reserved for volume populator. Don't create any application or pvc in that namespace.
-4. Before rename volume should not be used by any application.
+2. Namespace `volume-copy` is reserved for volume populator. Don't create any application or pvc in that namespace.
+3. Before rename volume should not be used by any application.
 
-Here are the steps to rename a pvc using PV Populator.
+Here are the steps of how to use persistent volume populator -
 1. Install volume populator.
    ```bash
    kubectl create ns volume-copy
@@ -32,7 +31,7 @@ Here are the steps to rename a pvc using PV Populator.
    /data # cat file
    hello!
    ```
-3. After writing some data delete the pod.
+3. After writing some data delete the Pod.
    ```bash
    kubectl delete -f yaml/populator/pv/app/pod.yaml
    ```
@@ -48,7 +47,7 @@ Here are the steps to rename a pvc using PV Populator.
    spec:
      pvcName: my-pvc
    ```
-5. Create a new pvc pointing to the claim-cpopulator.
+5. Create a new pvc pointing to pv-cpopulator.
    ```bash
    # Please edit the storageclass accordingly
    kubectl apply -f yaml/populator/pv/app/pvc-d.yaml
@@ -71,7 +70,7 @@ Here are the steps to rename a pvc using PV Populator.
        requests:
          storage: 2Gi
    ```
-6. Create a new pod and check the older data is present or not.
+6. Create a new Pod and check the older data is present or not in the new PVC.
    ```bash
    kubectl apply -f yaml/populator/pv/app/pod-d.yaml
    ```

docs/demo/02_rsync_populator.md

@@ -1,10 +1,11 @@
-Rsync Populator is a `Volume Populator` that helps to create volume using rsync source. In this project we are creating rsync daemon on source volume and then populator will use that source to create a volume.
+Rsync Populator is a volume populator that helps to create volume from any rsync source. Rsync client is used as volume populator plugin. `RsyncPopulator` CR contains the information of source location and how to access the source.
 
 NOTE -
 1. `AnyVolumeDataSource` feature gate should be enabled in the kubernetes cluster.
 2. Namespace `volume-copy` is reserved for volume populator. Don't create any application or pvc in that namespace.
+3. Before rename volume should not be used by any application.
 
-Here are the steps to create a volume using rsync source.
+Here are the steps of how to use rsync populator -
 1. Install volume populator
    ```bash
    kubectl create ns volume-copy
@@ -34,11 +35,11 @@ Here are the steps to create a volume using rsync source.
    ```bash
    kubectl delete -f yaml/populator/rsync/app/pod.yaml
    ```
-4. Install rsync daemon as a source, it will mount source volume.
+4. Setup rsync source, install rsync daemon pod, configmap and service it will mount source volume.
    ```bash
    kubectl apply -f yaml/server/rsync/deploy.yaml
    ```
-5. Create a rsyncpopulator cr. It has all the details of source rsyncd.
+5. Create a rsyncpopulator cr. It has all the details of rsync source.
    ```bash
    kubectl apply -f yaml/populator/rsync/cr.yaml
    ```
@@ -53,7 +54,7 @@ Here are the steps to create a volume using rsync source.
      url: rsync-daemon.default:873
      path: /data
    ```
-6. Create a new pvc pointing to the rsync-populator.
+6. Create a new pvc pointing to rsync-populator.
    ```bash
    # Please edit the storageclass accordingly
    kubectl apply -f yaml/populator/rsync/app/pvc-d.yaml
@@ -76,7 +77,7 @@ Here are the steps to create a volume using rsync source.
        requests:
          storage: 2Gi
    ```
-7. Create a new pod and check the older data is present or not.
+7. Create a new pod and check the older data is present or not in the new PVC.
    ```bash
    kubectl apply -f yaml/populator/rsync/app/pod-d.yaml
    ```

docs/demo/03_rename_volume.md

@@ -1,12 +1,11 @@
-[PV Populator](https://github.com/shovanmaity/k8s-volume-copy/blob/main/docs/demo/01_pv_populator.md) is a `Volume Populator` that helps to rename a PVC. It does a patch on `PersistentVolume` of older `Claim` with new `Claim`. Volume Rename control loop use this to rename a volume. We can rename a pvc using PV Populator there we need to create populator and pvc. Volume Rename takes care of these 2 steps. We just need to create `VolumeRename` CR.
+PersistentVolume Populator is a volume populator that does a patch on the PV of given PVC with new PVC. Volume Rename control loop, it makes use of PersistentVolume Populator to rename a volume. When a `VolumeRename` CR is created it creates a PersistentVolumePopulator CR and a new PVC pointing to that volume populator CR as a data source.
 
 NOTE -
 1. `AnyVolumeDataSource` feature gate should be enabled in the kubernetes cluster.
-2. Default storageclass should be configured for this demo.
-3. Namespace `volume-copy` is reserved for volume populator. Don't create any application or pvc in that namespace.
-4. Before rename volume should not be used by any application.
+2. Namespace `volume-copy` is reserved for volume populator. Don't create any application or pvc in that namespace.
+3. Before rename volume should not be used by any application.
 
-Here are the steps to rename a pvc.
+Here are the steps to rename a pvc -
 1. Install volume populator and volume rename controller.
    ```bash
    kubectl create ns volume-copy
@@ -38,7 +37,7 @@ Here are the steps to rename a pvc.
    ```bash
    kubectl delete -f yaml/volume-rename/app/pod.yaml
    ```
-4. Create a volume rename cr. It has old and new pvc details.
+4. Create a `VolumeRename` cr. It contains old and new pvc details.
    ```bash
    kubectl apply -f yaml/volume-rename/cr.yaml
    ```
@@ -55,7 +54,7 @@ Here are the steps to rename a pvc.
    ```bash
    kubectl get volumerename.demo.io/volume-rename -o=jsonpath="{.status.state}{'\n'}"
    ```
-6. Create a new pod and check the older data is present or not.
+6. Create a new pod and check the older data is present or not in the new PVC.
    ```bash
    kubectl apply -f yaml/volume-rename/app/pod-d.yaml
    ```

docs/demo/04_copy_volume.md

@@ -1,12 +1,11 @@
-[Rsync Populator](https://github.com/shovanmaity/k8s-volume-copy/blob/main/docs/demo/02_rsync_populator.md) is a `Volume Populator` that helps to create a volume from any rsync source. This module use it to copy any filesystem PVC. It creates rsync server on source PVC and rsync client is used as populator to create a new volume copy.
+Rsync Populator is a volume populator that helps to create a volume from any rsync source. Volume Copy control loop, it makes use of Rsync Populator to rename a volume. When a `VolumeCopy` CR is created it sets up rsync source on the source PVC and creates a RsyncPopulator and a new PVC pointing to that volume populator as a data source. 
 
 NOTE -
 1. `AnyVolumeDataSource` feature gate should be enabled in the kubernetes cluster.
-2. Default storageclass should be configured for this demo.
-3. Namespace `volume-copy` is reserved for volume populator. Don't create any application or pvc in that namespace.
-4. Before copying volume should not be used by any application.
+2. Namespace `volume-copy` is reserved for volume populator. Don't create any application or pvc in that namespace.
+3. Before copying volume should not be used by any application.
 
-Here are the steps to copy a pvc.
+Here are the steps to copy a pvc -
 1. Install volume populator and volume copy controller.
    ```bash
    kubectl create ns volume-copy
@@ -38,7 +37,7 @@ Here are the steps to copy a pvc.
    ```bash
    kubectl delete -f yaml/volume-copy/app/pod.yaml
    ```
-4. Create a  VolumeCopy cr. It has old and new pvc details in the spec.
+4. Create a  `VolumeCopy` cr. It has old and new pvc details in the spec.
    ```bash
    kubectl apply -f yaml/volume-copy/cr.yaml
    ```
@@ -57,7 +56,7 @@ Here are the steps to copy a pvc.
    ```bash
    kubectl get volumecopy.demo.io/volume-copy -o=jsonpath="{.status.state}{'\n'}"
    ```
-6. Create a new pod and check the older data is present or not.
+6. Create a new pod and check the older data is present or not in the new PVC.
    ```bash
    kubectl apply -f yaml/volume-rename/app/pod-d.yaml
    ```

docs/demo/05_move_volume.md

@@ -1,12 +1,11 @@
-In this demo we will move PVC from one storageclass to another storageclass. In these yaml storage class `hp-node-1` and `hp-node-2` are hard coded, if you want you can change it. In this demo we will use `VolumeRename` and `VolumeCopy`. Flow is `scale down` -> `rename volume(s)` -> `copy volume(s)` -> `scale up`.
+In this demo we will move PVC from one storageclass to another storageclass. In these yaml storage class `hp-node-1` and `hp-node-2` are hard coded, if you want you can change it. In this demo we will use `VolumeRename` and `VolumeCopy`.
 
 NOTE -
 1. `AnyVolumeDataSource` feature gate should be enabled in the kubernetes cluster.
-2. Storageclass should be configured for this demo.
-3. Namespace `volume-copy` is reserved for volume populator. Don't create any application or pvc in that namespace.
-4. Before moving volume should not be used by any application.
+2. Namespace `volume-copy` is reserved for volume populator. Don't create any application or pvc in that namespace.
+3. Before moving volume should not be used by any application.
 
-Here are steps -
+Here are steps to move a volume from one storageclass to another storageclass -
 1. Install PV and Rsync volume populator and volume rename and copy controller.
    ```bash
    kubectl create ns volume-copy
@@ -25,7 +24,7 @@ Here are steps -
    ```bash
    kubectl apply -f yaml/volume-move/app.yaml
    ```
-3. After adding some file in minio scale it down.
+3. After adding some data in minio scale it down.
    ```bash
    kubectl scale sts minio --replicas=0
    ```

docs/demo/readme.md

@@ -2,14 +2,14 @@ We have 2 volume Populators
 1. Rsync populator
 2. Persistentvolume populator
 
-In the demo section we have main 3 functionalities. In this 3 functionalities 2 populator are used.
+In the demo we have main 3 functionalities.
 1. Rename a PVC
 2. Make a copy of PVC
-3. Move data from one SC to another SC
+3. Move a PVC from one SC to another SC
 
 Here are demo or how to links -
-- [How to use Persistentvolume populator](https://github.com/shovanmaity/k8s-volume-copy/blob/main/docs/demo/01_pv_populator.md)
-- [How to use Rsync populator](https://github.com/shovanmaity/k8s-volume-copy/blob/main/docs/demo/02_rsync_populator.md)
+- [How to use PersistentVolume Populator](https://github.com/shovanmaity/k8s-volume-copy/blob/main/docs/demo/01_pv_populator.md)
+- [How to use Rsync Populator](https://github.com/shovanmaity/k8s-volume-copy/blob/main/docs/demo/02_rsync_populator.md)
 - [How to rename a PVC](https://github.com/shovanmaity/k8s-volume-copy/blob/main/docs/demo/03_rename_volume.md)
 - [How to make a copy of a PVC](https://github.com/shovanmaity/k8s-volume-copy/blob/main/docs/demo/04_copy_volume.md)
-- [How to move data from one SC to another SC](https://github.com/shovanmaity/k8s-volume-copy/blob/main/docs/demo/05_move_volume.md)
+- [How to move a PVC from one SC to another SC](https://github.com/shovanmaity/k8s-volume-copy/blob/main/docs/demo/05_move_volume.md)

docs/design/00_volume_populator.md

@@ -0,0 +1 @@
+TODO

docs/design/01_pv_populator.md

@@ -0,0 +1 @@
+TODO

docs/design/02_rsync_populator.md

@@ -0,0 +1 @@
+TODO

docs/design/03_rename_volume.md

@@ -0,0 +1 @@
+TODO

docs/design/04_copy_volume.md

@@ -0,0 +1 @@
+TODO

docs/design/readme.md

@@ -0,0 +1 @@
+TODO