VolSync

https://volsync.readthedocs.io/en/stable/
Admin
VolSync is a Kubernetes operator that performs asynchronous replication of persistent volumes...
Tokens:83,240
Snippets:869
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install from source using Go

Source: https://volsync.readthedocs.io/en/stable/usage/cli/index.html

Install the latest released version or the latest code from the main branch using Go.

```bash
$ go install github.com/backube/volsync/kubectl-volsync@latest
go: downloading github.com/backube/volsync v0.4.0

$ which kubectl-volsync
~/go/bin/kubectl-volsync
```

```bash
$ go install github.com/backube/volsync/kubectl-volsync@main
go: downloading github.com/backube/volsync v0.3.1-0.20220512205923-e33a7e4d88b6
```

--------------------------------

### Install VolSync plugin via Krew

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/cli/index.rst.txt

Use this command to install the VolSync plugin if you have Krew installed. Future upgrades are possible via `kubectl krew upgrade volsync`.

```console
# Install the VolSync plugin
$ kubectl krew install volsync
Updated the local copy of plugin index.
Installing plugin: volsync
Installed plugin: volsync
\
| Use this plugin:
| 	kubectl volsync
| Documentation:
| 	https://github.com/backube/volsync
/
WARNING: You installed plugin "volsync" from the krew-index plugin repository.
  These plugins are not audited for security by the Krew maintainers.
  Run them at your own risk.
```

--------------------------------

### Setup Destination Namespace

Source: https://volsync.readthedocs.io/en/stable/usage/rclone/database_example.html

Configure the destination namespace and deploy the ReplicationDestination resource.

```bash
$ kubectl create ns dest
$ kubectl annotate namespace dest volsync.backube/privileged-movers="true"
$ kubectl create secret generic rclone-secret --from-file=rclone.conf=./examples/rclone/rclone.conf -n dest
$ kubectl create -f examples/rclone/volsync_v1alpha1_replicationdestination.yaml -n dest
```

--------------------------------

### Deploy Source Namespace and Database

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/rsync/database_example.rst.txt

Creates the source namespace and deploys the example database application.

```console
$ kubectl create ns source
$ kubectl create -n source -f examples/source-database
```

--------------------------------

### Verify VolSync plugin installation (Krew)

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/cli/index.rst.txt

After installation via Krew, verify the installation by checking the plugin version.

```console
# Use it...
$ kubectl volsync --version
volsync version v0.4.0+b710c5f
```

--------------------------------

### Verify binary installation

Source: https://volsync.readthedocs.io/en/stable/usage/cli/index.html

Check the version of the manually installed binary.

```bash
$ kubectl volsync --version
volsync version v0.4.0+b710c5f
```

--------------------------------

### Install VolSync plugin from source (Main)

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/cli/index.rst.txt

Install the latest code from the main branch of the VolSync plugin directly from source using Go. This requires a working Go environment.

```console
$ go install github.com/backube/volsync/kubectl-volsync@main
go: downloading github.com/backube/volsync v0.3.1-0.20220512205923-e33a7e4d88b6
```

--------------------------------

### Add Helm Repository and Install VolSync

Source: https://volsync.readthedocs.io/en/stable/_sources/installation/index.rst.txt

Add the Backube Helm repository and install the VolSync chart in your cluster. Ensure you create the namespace if it doesn't exist.

```console
# Add the Backube Helm repo
$ helm repo add backube https://backube.github.io/helm-charts/

# Deploy the chart in your cluster
$ helm install --create-namespace -n volsync-system volsync backube/volsync
```

--------------------------------

### Install VolSync plugin from source (Released)

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/cli/index.rst.txt

Install the latest released version of the VolSync plugin directly from source using Go. This requires a working Go environment.

```console
$ go install github.com/backube/volsync/kubectl-volsync@latest
go: downloading github.com/backube/volsync v0.4.0

$ which kubectl-volsync
~/go/bin/kubectl-volsync
```

--------------------------------

### Run Local Minio

Source: https://volsync.readthedocs.io/en/stable/usage/rclone/database_example.html

Start a local Minio instance for object storage testing.

```bash
$ hack/run-minio.sh
```

--------------------------------

### Create Replication Relationship

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/cli/replication.rst.txt

Initializes a new replication relationship named 'example' using the VolSync CLI.

```console
$ kubectl volsync replication -r example create
```

--------------------------------

### Verify VolSync plugin installation (Binary)

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/cli/index.rst.txt

After installing the binary release, verify the installation by checking the plugin version.

```console
$ kubectl volsync --version
volsync version v0.4.0+b710c5f
```

--------------------------------

### Setup Kind Cluster

Source: https://volsync.readthedocs.io/en/stable/_sources/installation/development.rst.txt

Run this script to set up and configure a local kind cluster for VolSync development.

```console
./hack/setup-kind-cluster.sh
```

--------------------------------

### Start Minio Object Storage

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/rclone/database_example.rst.txt

Starts a Minio instance within the Kubernetes cluster for use as an S3 compatible object storage.

```bash
$ hack/run-minio.sh
```

--------------------------------

### Setup Source Namespace

Source: https://volsync.readthedocs.io/en/stable/usage/rclone/database_example.html

Create the source namespace and enable privileged movers for the Rclone data mover.

```bash
$ kubectl create ns source
$ kubectl annotate namespace source volsync.backube/privileged-movers="true"
```

--------------------------------

### Sample DokuWiki Page Content

Source: https://volsync.readthedocs.io/en/stable/usage/syncthing/syncthing_example.html

Example text to populate the DokuWiki instance for testing synchronization.

```text
Syncthing is a data mover that allows you to synchronize your data across multiple devices.
It's an awesome tool that you should try out if you haven't already.
```

--------------------------------

### Setup Local Kind Cluster

Source: https://volsync.readthedocs.io/en/stable/installation/development.html

Use this script to set up and configure a local kind cluster for VolSync development.

```bash
./hack/setup-kind-cluster.sh

```

--------------------------------

### Install MySQL Helm Chart

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/rsync-tls/mysql-migration.rst.txt

Installs the MySQL chart from the Bitnami repository into the 'mysql' namespace on the 'east2' cluster. It configures root password, disables pod/container security contexts, and sets the storage class.

```console
$ helm install --kube-context east2 --create-namespace --namespace mysql \
  --set auth.rootPassword=mypassword \
  --set primary.podSecurityContext.enabled=false \
  --set primary.containerSecurityContext.enabled=false \
  --set primary.persistence.storageClass=gp3-csi \
  mysql bitnami/mysql
NAME: mysql
LAST DEPLOYED: Thu Dec  1 11:46:59 2022
NAMESPACE: mysql
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
CHART NAME: mysql
CHART VERSION: 9.4.4
APP VERSION: 8.0.31

** Please be patient while the chart is being deployed **

Tip:

  Watch the deployment status using the command: kubectl get pods -w --namespace mysql

Services:

  echo Primary: mysql.mysql.svc.cluster.local:3306

Execute the following to get the administrator credentials:

  echo Username: root
  MYSQL_ROOT_PASSWORD=$(kubectl get secret --namespace mysql mysql -o jsonpath="{.data.mysql-root-password}" | base64 -d)

To connect to your database:

  1. Run a pod that you can use as a client:

      kubectl run mysql-client --rm --tty -i --restart='Never' --image  docker.io/bitnami/mysql:8.0.31-debian-11-r10 --namespace mysql --env MYSQL_ROOT_PASSWORD=$MYSQL_ROOT_PASSWORD --command -- bash

  2. To connect to primary service (read/write):

      mysql -h mysql.mysql.svc.cluster.local -uroot -p"$MYSQL_ROOT_PASSWORD"

```

--------------------------------

### Execute Manual Replication Sequence

Source: https://volsync.readthedocs.io/en/stable/usage/triggers.html

Example script demonstrating how to trigger multiple manual replications and wait for completion using kubectl.

```bash
MANUAL=first
SOURCE=source1

# create source replication with first manual trigger (will start immediately)
kubectl create -f - <<EOF
apiVersion: volsync.backube/v1alpha1
kind: ReplicationSource
metadata:
  name: $SOURCE
spec:
  trigger:
    manual: $MANUAL
  ...
EOF

# waiting for first trigger to complete...
while [ "$LAST_MANUAL_SYNC" != "$MANUAL" ]
  do
    sleep 1
    LAST_MANUAL_SYNC=$(kubectl get replicationsource $SOURCE --template={{.status.lastManualSync}})
    echo " - LAST_MANUAL_SYNC: $LAST_MANUAL_SYNC"
  done

# set a second manual trigger
MANUAL=second
kubectl patch replicationsources $SOURCE --type merge -p '{"spec":{"trigger":{"manual":"'$MANUAL'"}}}'

# waiting for second trigger to complete...
while [ "$LAST_MANUAL_SYNC" != "$MANUAL" ]
  do
    sleep 1
    LAST_MANUAL_SYNC=$(kubectl get replicationsource $SOURCE --template={{.status.lastManualSync}})
    echo " - LAST_MANUAL_SYNC: $LAST_MANUAL_SYNC"
  done

# after second trigger is done we delete the replication...
kubectl delete replicationsources $SOURCE
```

--------------------------------

### Deploy MySQL via Helm

Source: https://volsync.readthedocs.io/en/stable/usage/rsync-tls/mysql-migration.html

Install the MySQL database into the mysql namespace with specific security and storage configurations.

```bash
$ helm install --kube-context east2 --create-namespace --namespace mysql \
  --set auth.rootPassword=mypassword \
  --set primary.podSecurityContext.enabled=false \
  --set primary.containerSecurityContext.enabled=false \
  --set primary.persistence.storageClass=gp3-csi \
  mysql bitnami/mysql
NAME: mysql
LAST DEPLOYED: Thu Dec  1 11:46:59 2022
NAMESPACE: mysql
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
CHART NAME: mysql
CHART VERSION: 9.4.4
APP VERSION: 8.0.31

** Please be patient while the chart is being deployed **

Tip:

  Watch the deployment status using the command: kubectl get pods -w --namespace mysql

Services:

  echo Primary: mysql.mysql.svc.cluster.local:3306

Execute the following to get the administrator credentials:

  echo Username: root
  MYSQL_ROOT_PASSWORD=$(kubectl get secret --namespace mysql mysql -o jsonpath="{.data.mysql-root-password}" | base64 -d)

To connect to your database:

  1. Run a pod that you can use as a client:

      kubectl run mysql-client --rm --tty -i --restart='Never' --image  docker.io/bitnami/mysql:8.0.31-debian-11-r10 --namespace mysql --env MYSQL_ROOT_PASSWORD=$MYSQL_ROOT_PASSWORD --command -- bash

  2. To connect to primary service (read/write):

      mysql -h mysql.mysql.svc.cluster.local -uroot -p"$MYSQL_ROOT_PASSWORD"
```

--------------------------------

### Initialize Dokuwiki Namespace and Resources

Source: https://volsync.readthedocs.io/en/stable/usage/syncthing/syncthing_example.html

Creates the target namespace and deploys the Dokuwiki application resources.

```bash
kubectl create ns dokuwiki-east
kubectl apply -f examples/dokuwiki/ -n dokuwiki-east
```

--------------------------------

### Example ReplicationSource with restic

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/pvccopytriggers.rst.txt

This example demonstrates a ReplicationSource configured with restic, utilizing PVC copy triggers for snapshot coordination.

```yaml
apiVersion: volsync.backube/v1alpha1
kind: ReplicationSource
metadata:
  name: test-rs
  namespace: test-ns
spec:
  sourcePVC: data-pvc
  trigger:
    schedule: "*/30 * * * *"
  restic:
    pruneIntervalDays: 1
    repository: restic-secret
    retain:
      hourly: 3
      daily: 2
      monthly: 1
    copyMethod: Snapshot
    cacheCapacity: 1Gi
```

--------------------------------

### ReplicationSource with Syncthing Status Example

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/syncthing/index.rst.txt

An example of a ReplicationSource object showing the populated Syncthing status, including the device ID and address.

```yaml
---
apiVersion: volsync.backube/v1alpha1
kind: ReplicationSource
  name: sync-todo-database
spec:
  sourcePVC: todo-database
metadata:
  syncthing:
    serviceType: ClusterIP
    peers:
    - ID: 7NDBKMJ-XU2GWGG-4JJ5B5M-ONSDVAK-ZDXHKVM-6X7XYB7-ZG4NYDI-ZQ6FHQ4
      address: tcp://10.96.140.222:22000
      introducer: true
status:
  conditions:
  - lastTransitionTime: "2022-04-27T20:26:23Z"
    message: Synchronization in-progress
    reason: SyncInProgress
    status: "True"
    type: Synchronizing
  lastSyncStartTime: "2022-04-27T20:25:32Z"
  syncthing:
    # This ReplicationSource's Syncthing ID.
    ID: GVONGZX-6FVQPEY-4QWTVLK-TXNJUHA-5UGA625-UBC7HZQ-P5BG2XJ-EHJ4XQ3
    # This ReplicationSource's Syncthing address.
    address: tcp://10.96.55.168:22000
    # The Syncthing peers this ReplicationSource is connected to.
    peers:
    - # The Syncthing ID of the peer we're connected to.
      ID: JDKRGMR-HOX3QQ6-N4OLXBD-VRLS3D4-2DBFELP-6QKIFYB-4ZP3YSF-Q37KAQU
      # The connected peer's Syncthing address.
      address: tcp://10.96.168.12:22000
      # Whether or not we have an active connection with this peer.
      connected: true
      # The connected device's local name. Here this is another Pod's name.
      deviceName: volsync-syncthing-1-76dfbfb4d7-5fhc8
      # The Syncthing ID of the peer that introduced us to this peer
      introducedBy: 7NDBKMJ-XU2GWGG-4JJ5B5M-ONSDVAK-ZDXHKVM-6X7XYB7-ZG4NYDI-ZQ6FHQ4

```

--------------------------------

### Create Initial ReplicationSource

Source: https://volsync.readthedocs.io/en/stable/usage/syncthing/syncthing_example.html

Deploys the Syncthing-based ReplicationSource to the primary Dokuwiki namespace.

```bash
$ kubectl apply -f examples/syncthing/replicationsource_empty.yaml -n dokuwiki-east
replicationsource.volsync.backube/sync-dokuwiki created
```

--------------------------------

### Connect to MySQL and List Databases

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/rsync/database_example.rst.txt

Connect to the running MySQL pod and execute a command to list all databases, verifying the synced database.

```bash
$ kubectl exec --stdin --tty -n dest $(kubectl get pods -n dest | grep mysql | awk '{print $1}') -- /bin/bash
$ mysql -u root -p$MYSQL_ROOT_PASSWORD
> show databases;
+--------------------+
| Database           |
+--------------------+
| information_schema |
| mysql              |
| performance_schema |
| synced             |
| sys                |
+--------------------+
5 rows in set (0.00 sec)
```

--------------------------------

### Syncthing-based ReplicationSource using dokuwiki-east as Introducer

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/syncthing/syncthing_example.rst.txt

Creates a Syncthing-based ReplicationSource in 'dokuwiki-west' and 'dokuwiki-central' namespaces, configured to use 'dokuwiki-east' as an introducer node.

```bash
kubectl apply -f examples/syncthing/replicationsource_west.yaml -n dokuwiki-west
kubectl apply -f examples/syncthing/replicationsource_central.yaml -n dokuwiki-central
```

--------------------------------

### Deploy Dokuwiki in Secondary Namespaces

Source: https://volsync.readthedocs.io/en/stable/usage/syncthing/syncthing_example.html

Launches Dokuwiki instances in the newly created namespaces.

```bash
kubectl apply -f examples/dokuwiki/ -n dokuwiki-west
kubectl apply -f examples/dokuwiki/ -n dokuwiki-central
```

--------------------------------

### Install VolSync CRDs and Run Operator Locally

Source: https://volsync.readthedocs.io/en/stable/installation/development.html

Installs VolSync Custom Resource Definitions into the cluster and runs the operator binary locally. Mover containers are pulled from Quay.

```bash
# Install VolSync CRDs into the cluster
$ make install

# Run the operator locally
$ make run

```

--------------------------------

### ReplicationDestination Example with Rclone

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/rclone/index.rst.txt

An example of a ReplicationDestination configuration using Rclone to replicate data to an S3 bucket. It specifies the schedule, Rclone configuration details, and storage parameters for the destination volume.

```yaml
---
apiVersion: volsync.backube/v1alpha1
kind: ReplicationDestination
metadata:
  name: database-destination
  namespace: dest
spec:
  trigger:
    # Every 6 minutes, offset by 3 minutes
    schedule: "3,9,15,21,27,33,39,45,51,57 * * * *"
rclone:
  rcloneConfigSection: "aws-s3-bucket"
  rcloneDestPath: "volsync-test-bucket/mysql-pvc-claim"
  rcloneConfig: "rclone-secret"
  copyMethod: Snapshot
  accessModes: [ReadWriteOnce]
  capacity: 10Gi
  storageClassName: my-sc
  volumeSnapshotClassName: my-vsc

```

--------------------------------

### Create and Verify MySQL Database

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/rsync-tls/mysql-migration.rst.txt

Use the `create` command to add a new database and `show databases` to verify its creation. Log out using `quit`.

```console
mysql> create database newdb;
Query OK, 1 row affected (0.00 sec)

mysql> show databases;
+--------------------+
| Database           |
+--------------------+
| information_schema |
| my_database        |
| mysql              |
| newdb              |
| performance_schema |
| sys                |
+--------------------+
6 rows in set (0.00 sec)

mysql> quit;
Bye
```

--------------------------------

### Example rclone.conf for AWS S3

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/rclone/rclone-secret.rst.txt

This is an example rclone.conf file for configuring AWS S3 as the backend for intermediary storage. It includes essential parameters like access keys, region, and ACL settings.

```none
[aws-s3-bucket]
type = s3
provider = AWS
env_auth = false
access_key_id = *******
secret_access_key = ******
region = <region>
location_constraint = <region>
acl = private
```

--------------------------------

### Create Database in Source

Source: https://volsync.readthedocs.io/en/stable/usage/rclone/database_example.html

Access the MySQL pod to create a new database.

```bash
$ kubectl exec --stdin --tty -n source $(kubectl get pods -n source | grep mysql | awk '{print $1}') -- /bin/bash
$ mysql -u root -p$MYSQL_ROOT_PASSWORD
> show databases;
+--------------------+
| Database           |
+--------------------+
| information_schema |
| mysql              |
| performance_schema |
| sys                |
+--------------------+
4 rows in set (0.00 sec)


> create database synced;
> exit
$ exit
```

--------------------------------

### ReplicationDestination Status Example

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/rclone/index.rst.txt

An example of the status field for a ReplicationDestination object. It shows reconciliation status, last sync duration, and details about the latest data image, which can be a VolumeSnapshot or a PVC depending on the copy method.

```yaml
---
API Version:  volsync.backube/v1alpha1
Kind:         ReplicationDestination
#  ... omitted ...
Spec:
  Rclone:
    Access Modes:
      ReadWriteOnce
    Capacity:                    10Gi
    Copy Method:                 Snapshot
    Rclone Config:               rclone-secret
    Rclone Config Section:       aws-s3-bucket
    Rclone Dest Path:            volsync-test-bucket
    Storage Class Name:          my-sc
    Volume Snapshot Class Name:  my-vsc
Status:
  Conditions:
    Last Transition Time:  2021-01-19T22:16:02Z
    Message:               Reconcile complete
    Reason:                ReconcileComplete
    Status:                True
    Type:                  Reconciled
  Last Sync Duration:      7.066022293s
  Last Sync Time:          2021-01-19T22:16:02Z
  Latest Image:
    API Group:  snapshot.storage.k8s.io
    Kind:       VolumeSnapshot
    Name:       volsync-dest-database-destination-20210119221601

```

--------------------------------

### ReplicationSource Status Example

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/rsync-tls/index.rst.txt

An example of the status field for a ReplicationSource, showing synchronization details like last sync duration, last sync time, and next sync time. The rsyncTLS field is also present.

```yaml
---
aspiVersion: volsync.backube/v1alpha1
kind: ReplicationSource
metadata:
  name: mySource
  namespace: source
spec:
  sourcePVC: mysql-pv-claim
  trigger:
    schedule: "*/5 * * * *"
  rsync:
    # ... omitted ...
status:
status:
  conditions:
    - lastTransitionTime: "2022-11-29T17:25:13Z"
      message: Waiting for next scheduled synchronization
      reason: WaitingForSchedule
      status: "False"
      type: Synchronizing
  lastSyncDuration: 28.818695981s
  lastSyncTime: "2022-11-29T17:25:28Z"
  nextSyncTime: "2021-11-29T17:30:00Z"
  rsyncTLS: {}

```

--------------------------------

### VolSync CLI Migration Help

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/cli/migration.rst.txt

Displays the main help information for the VolSync migration commands, outlining available subcommands like create, delete, and rsync.

```console
$ kubectl volsync migration
Copy data from an external file system into a Kubernetes PersistentVolume.

This set of commands is designed to help provision a PV and copy data from a
directory tree into that newly provisioned volume.

Usage:
kubectl-volsync migration [command]

Available Commands:
create      Create a new migration destination
delete      Delete a new migration destination
rsync       Rsync data from source to destination
```

--------------------------------

### Create a migration namespace

Source: https://volsync.readthedocs.io/en/stable/usage/cli/migration.html

Initializes a namespace to host the destination PVC.

```bash
$ kubectl create ns destination
namespace/destination created
```

--------------------------------

### Install MySQL Helm Chart with Existing PVC

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/rsync-tls/mysql-migration.rst.txt

Installs the Bitnami MySQL Helm chart, configuring it to use a pre-existing PVC named 'restored' for database persistence. Ensure the PVC is correctly provisioned and available in the target namespace.

```console
helm install --kube-context west2 --namespace mysql \
  --set auth.rootPassword=mypassword \
  --set primary.podSecurityContext.enabled=false \
  --set primary.containerSecurityContext.enabled=false \
  --set primary.persistence.existingClaim=restored \
  mysql bitnami/mysql
```

--------------------------------

### Install VolSync CRDs and Run Operator Locally

Source: https://volsync.readthedocs.io/en/stable/_sources/installation/development.rst.txt

Installs the VolSync Custom Resource Definitions into the cluster and then runs the operator binary locally. This is ideal for developing operator code due to fast rebuilds and easy log access.

```console
# Install VolSync CRDs into the cluster
$ make install
```

```console
# Run the operator locally
$ make run
```

--------------------------------

### Install Prometheus Operator

Source: https://volsync.readthedocs.io/en/stable/usage/metrics/index.html

Apply the Prometheus operator bundle to the cluster.

```bash
$ kubectl apply -f https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/v0.46.0/bundle.yaml
```

--------------------------------

### PersistentVolumeClaim Configuration

Source: https://volsync.readthedocs.io/en/stable/usage/volume-populator/index.html

Example of a PVC configured to use a ReplicationDestination as its dataSourceRef.

```yaml
---
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: restored-pvc
  namespace: dest
spec:
  accessModes: [ReadWriteOnce]
  dataSourceRef:
    kind: ReplicationDestination
    apiGroup: volsync.backube
    name: rclone-replicationdestination
  resources:
    requests:
      storage: 10Gi
  storageClassName: my-sc
```

--------------------------------

### Create Additional Dokuwiki Namespaces

Source: https://volsync.readthedocs.io/en/stable/usage/syncthing/syncthing_example.html

Sets up the secondary namespaces for the synchronization demonstration.

```bash
kubectl create ns dokuwiki-west
kubectl create ns dokuwiki-central
```

--------------------------------

### Get ReplicationDestination YAML

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/cli/replication.rst.txt

Retrieves the YAML configuration of a ReplicationDestination resource from the destination cluster.

```bash
$ kubectl --context gcp -n destns get replicationdestination -oyaml
apiVersion: v1
items:
- apiVersion: volsync.backube/v1alpha1
  kind: ReplicationDestination
  metadata:
    creationTimestamp: "2022-02-16T20:06:10Z"
    generation: 1
    labels:
      volsync.backube/relationship: 90d56bef-551d-4ede-b6a7-0783cabdafb6
    name: datavol
    namespace: destns
    resourceVersion: "42743"
    uid: 040dc4ad-6f37-43f1-9da4-b28d956f2bb7
  spec:
    rsync:
      accessModes:
      - ReadWriteOnce
      capacity: 3Gi
      copyMethod: Snapshot
      serviceType: LoadBalancer
      storageClassName: standard-csi
      volumeSnapshotClassName: csi-gce-pd-vsc
  status:
    conditions:
    - lastTransitionTime: "2022-02-16T20:06:10Z"
      message: Reconcile complete
      reason: ReconcileComplete
      status: "True"
      type: Reconciled
    - lastTransitionTime: "2022-02-16T20:08:00Z"
      message: Synchronization in-progress
      reason: SyncInProgress
      status: "True"
      type: Synchronizing
    lastSyncDuration: 1m50.209297869s
    lastSyncStartTime: "2022-02-16T20:08:00Z"
    lastSyncTime: "2022-02-16T20:08:00Z"
    latestImage:
      apiGroup: snapshot.storage.k8s.io
      kind: VolumeSnapshot
      name: volsync-datavol-dst-20220216200800
    rsync:
      address: 34.121.93.205
      sshKeys: volsync-rsync-dst-src-datavol
kind: List
metadata:
  resourceVersion: ""
  selfLink: ""

```

--------------------------------

### Deploy Source MySQL Database

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/rclone/database_example.rst.txt

Deploys the sample MySQL database to the 'source' namespace.

```bash
$ kubectl create -f examples/source-database/ -n source
```

--------------------------------

### Get ReplicationSource YAML

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/cli/replication.rst.txt

Retrieves the YAML configuration of a ReplicationSource resource from the source cluster.

```bash
$ kubectl --context kind -n source get replicationsource -oyaml
apiVersion: v1
items:
- apiVersion: volsync.backube/v1alpha1
  kind: ReplicationSource
  metadata:
    creationTimestamp: "2022-02-16T20:07:30Z"
    generation: 1
    labels:
      volsync.backube/relationship: 90d56bef-551d-4ede-b6a7-0783cabdafb6
    name: datavol-87srf
    namespace: source
    resourceVersion: "13695"
    uid: 7511b291-b768-4a2e-96cf-2eafd3854469
  spec:
    rsync:
      address: 34.121.93.205
      copyMethod: Clone
      sshKeys: datavol-87srf
    sourcePVC: datavol
    trigger:
      schedule: '*/5 * * * *'
  status:
    conditions:
    - lastTransitionTime: "2022-02-16T20:07:58Z"
      message: Waiting for next scheduled synchronization
      reason: WaitingForSchedule
      status: "False"
      type: Synchronizing
    - lastTransitionTime: "2022-02-16T20:07:30Z"
      message: Reconcile complete
      reason: ReconcileComplete
      status: "True"
      type: Reconciled
    lastSyncDuration: 28.732770544s
    lastSyncTime: "2022-02-16T20:07:58Z"
    nextSyncTime: "2022-02-16T20:10:00Z"
    rsync: {}
kind: List
metadata:
  resourceVersion: ""
  selfLink: ""

```

--------------------------------

### Azure: List and View StorageClasses

Source: https://volsync.readthedocs.io/en/stable/_sources/installation/index.rst.txt

Shows how to list StorageClasses and inspect the configuration of the managed-csi StorageClass on Azure.

```console
# List StorageClasses
$ kubectl get storageclasses
NAME                        PROVISIONER                RECLAIMPOLICY   VOLUMEBINDINGMODE      ALLOWVOLUMEEXPANSION   AGE
managed-csi                 disk.csi.azure.com         Delete          WaitForFirstConsumer   true                   45m
managed-premium (default)   kubernetes.io/azure-disk   Delete          WaitForFirstConsumer   true                   46m

# View details of the managed-csi SC
$ kubectl get storageclass/managed-csi -oyaml
allowVolumeExpansion: true
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
   creationTimestamp: "2022-02-08T14:57:23Z"
   name: managed-csi
   resourceVersion: "5853"
   uid: 3aeba0d1-6c52-481c-9dc1-786ae84a2f7b
parameters:
   skuname: Premium_LRS
provisioner: disk.csi.azure.com
reclaimPolicy: Delete
volumeBindingMode: WaitForFirstConsumer
```

--------------------------------

### Initialize Destination Namespace

Source: https://volsync.readthedocs.io/en/stable/usage/rsync/database_example.html

Create the destination namespace and apply the ReplicationDestination configuration.

```bash
$ kubectl create ns dest
$ kubectl create -n dest -f dest.yaml
```

--------------------------------

### Populated PersistentVolumeClaim Status

Source: https://volsync.readthedocs.io/en/stable/usage/volume-populator/index.html

Example of the PVC object state after the volume population process has completed.

```yaml
---
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  annotations:
    pv.kubernetes.io/bind-completed: "yes"
    pv.kubernetes.io/bound-by-controller: "yes"
    volume.beta.kubernetes.io/storage-provisioner: hostpath.csi.k8s.io
    volume.kubernetes.io/storage-provisioner: hostpath.csi.k8s.io
  creationTimestamp: "2023-08-13T07:24:23Z"
  finalizers:
  - kubernetes.io/pvc-protection
  name: restored-pvc
  namespace: dest
  resourceVersion: "4520"
  uid: 55f748d8-538c-4457-b36f-ad1f956290d2
spec:
  accessModes: [ReadWriteOnce]
  dataSource:
    kind: ReplicationDestination
    apiGroup: volsync.backube
    name: rclone-replicationdestination
  dataSourceRef:
    kind: ReplicationDestination
    apiGroup: volsync.backube
    name: rclone-replicationdestination
  resources:
    requests:
      storage: 10Gi
  storageClassName: my-sc
  volumeMode: Filesystem
  volumeName: pvc-dec29e3a-6f21-4eb0-84b2-b9d9d875f486
status:
  accessModes:
  - ReadWriteOnce
  capacity:
    storage: 10Gi
  phase: Bound
```

--------------------------------

### ReplicationDestination Configuration

Source: https://volsync.readthedocs.io/en/stable/usage/volume-populator/index.html

Example of a ReplicationDestination object configured with the Rclone mover and Snapshot copy method.

```yaml
---
apiVersion: volsync.backube/v1alpha1
kind: ReplicationDestination
metadata:
  name: rclone-replicationdestination
  namespace: dest
spec:
  trigger:
    # Every 6 minutes, offset by 3 minutes
    schedule: "3,9,15,21,27,33,39,45,51,57 * * * *"
  rclone:
    rcloneConfigSection: "aws-s3-bucket"
    rcloneDestPath: "volsync-test-bucket/mysql-pvc-claim"
    rcloneConfig: "rclone-secret"
    copyMethod: Snapshot
    accessModes: [ReadWriteOnce]
    capacity: 10Gi
    storageClassName: my-sc
    volumeSnapshotClassName: my-vsc
status:
  lastSyncDuration: 30.038338887s
  lastSyncTime: "2023-08-13T07:29:36Z"
  latestImage:
    apiGroup: snapshot.storage.k8s.io
    kind: VolumeSnapshot
    name: volsync-rclone-replicationdestination-dest-20230813072935
```

--------------------------------

### Create Syncthing ReplicationSources

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/syncthing/syncthing_example.rst.txt

Creates Syncthing-based ReplicationSources in specified namespaces, configured to sync a PVC and use a designated introducer node.

```bash
for ns in dokuwiki-west dokuwiki-central; do
  cat <<EOF | kubectl apply -n "${ns}" -f -
  kind: ReplicationSource
  apiVersion: volsync.backube/v1alpha1
  metadata:
    name: sync-dokuwiki
  spec:
    sourcePVC: dokuwiki-pvc
    syncthing:
      serviceType: ClusterIP
      peers:
      - ID: ${SYNCTHING_EAST_ID}
        address: ${SYNCTHING_EAST_ADDRESS}
        introducer: true
  EOF
  done
```

--------------------------------

### Get PVC Status

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/cli/migration.rst.txt

Verifies the status and details of the created PersistentVolumeClaim after the migration destination is set up.

```console
$ kubectl get -n destination pvc/mydata
NAME     STATUS   VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS   AGE
mydata   Bound    pvc-c9040e1f-e3dd-49e4-aa5d-194079181f55   2Gi        RWO            standard-csi   3m6s
```

--------------------------------

### Prepare Destination for Restore

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/restic/database_example.rst.txt

Set up the destination namespace and apply necessary annotations and configurations before initiating a restore. This includes creating a namespace, annotating it for privileged movers, and applying a restic configuration.

```console
$ kubectl create ns dest
```

```console
$ kubectl annotate namespace dest volsync.backube/privileged-movers="true"
```

```console
$ kubectl -n dest create -f examples/restic/source-restic/
```

--------------------------------

### Configure a Syncthing ReplicationSource

Source: https://volsync.readthedocs.io/en/stable/usage/syncthing/index.html

Example YAML configuration for a ReplicationSource using the Syncthing mover to sync a PersistentVolumeClaim.

```yaml
---
apiVersion: volsync.backube/v1alpha1
kind: ReplicationSource
metadata:
  name: sync-todo-database
spec:
  sourcePVC: todo-database
  syncthing:
    serviceType: ClusterIP
    # List of peers that this ReplicationSource should connect to.
    peers:
      # The Syncthing ID of the peer.
    - ID: GVONGZX-6FVQPEY-4QWTVLK-TXNJUHA-5UGA625-UBC7HZQ-P5BG2XJ-EHJ4XQ3
      # The address of the peer - this will be used as a data connection.
      address: tcp://10.96.55.168:22000
      # Whether or not the peer should introduce this ReplicationSource to other peers.
      introducer: false
```

--------------------------------

### Configure ReplicationDestination Service Type

Source: https://volsync.readthedocs.io/en/stable/usage/rsync-tls/index.html

Example of a ReplicationDestination resource specifying the serviceType for Rsync-TLS network connectivity.

```yaml
apiVersion: volsync.backube/v1alpha1
kind: ReplicationDestination
metadata:
  name: database-destination
  namespace: dest
spec:
  rsyncTLS:
    accessModes:
    - ReadWriteOnce
    capacity: 2Gi
    copyMethod: Snapshot
    serviceType: ClusterIP
```

--------------------------------

### VolSync CLI Help

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/cli/replication.rst.txt

Displays the main help information for the VolSync replication commands, outlining available subcommands.

```console
$ kubectl volsync replication
Replicate the contents of one PersistentVolume to another.

This set of commands is designed to set up and manage a replication
relationship between two different PVCs in the same Namespace, across
Namespaces, or in different clusters. The contents of the volume can be
replicated either on-demand or based on a provided schedule.

Usage:
  kubectl-volsync replication [command]

Available Commands:
  create          Create a new replication relationship
  delete          Delete an existing replication relationship
  schedule        Set replication schedule for the relationship
  set-destination Set the destination of the replication
  set-source      Set the source of the replication
  sync            Run a single synchronization
```

--------------------------------

### Configure ReplicationSource for Rclone

Source: https://volsync.readthedocs.io/en/stable/usage/rclone/index.html

Example configuration for a ReplicationSource using Rclone to sync a PVC to an S3 bucket.

```yaml
---
apiVersion: volsync.backube/v1alpha1
kind: ReplicationSource
metadata:
  name: database-source
  namespace: source
spec:
  # The PVC to sync
  sourcePVC: mysql-pv-claim
  trigger:
    # Synchronize every 6 minutes
    schedule: "*/6 * * * *"
  rclone:
    # The configuration section of the rclone config file to use
    rcloneConfigSection: "aws-s3-bucket"
    # The path to the object bucket
    rcloneDestPath: "volsync-test-bucket/mysql-pv-claim"
    # Secret holding the rclone configuration
    rcloneConfig: "rclone-secret"
    # Method used to generate the PiT copy
    copyMethod: Snapshot
    # The StorageClass to use when creating the PiT copy (same as source PVC if omitted)
    storageClassName: my-sc-name
    # The VSC to use if the copy method is Snapshot (default if omitted)
    volumeSnapshotClassName: my-vsc-name
```

--------------------------------

### View VolSync replication command help

Source: https://volsync.readthedocs.io/en/stable/usage/cli/replication.html

Displays the available subcommands for the VolSync replication tool.

```bash
$ kubectl volsync replication
Replicate the contents of one PersistentVolume to another.

This set of commands is designed to set up and manage a replication
relationship between two different PVCs in the same Namespace, across
Namespaces, or in different clusters. The contents of the volume can be
replicated either on-demand or based on a provided schedule.

Usage:
  kubectl-volsync replication [command]

Available Commands:
  create          Create a new replication relationship
  delete          Delete an existing replication relationship
  schedule        Set replication schedule for the relationship
  set-destination Set the destination of the replication
  set-source      Set the source of the replication
  sync            Run a single synchronization
```

--------------------------------

### Apply ReplicationDestination to Cluster

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/restic/database_example.rst.txt

Apply the configured ReplicationDestination resource to the Kubernetes cluster to start the restore process.

```console
$ kubectl -n dest create -f examples/restic/volsync_v1alpha1_replicationdestination.yaml
```

--------------------------------

### Deploy application to source cluster

Source: https://volsync.readthedocs.io/en/stable/usage/cli/replication.html

Commands to create the namespace and deploy the PVC and Pod.

```bash
$ kubectl --context kind create ns source
namespace/source created

$ kubectl --context kind -n source create -f pvc.yaml
persistentvolumeclaim/datavol created

$ kubectl --context kind -n source create -f pod.yaml
pod/busybox created
```

--------------------------------

### Build, Inject, and Run Operator in Kind

Source: https://volsync.readthedocs.io/en/stable/installation/development.html

Builds all VolSync containers from local source, injects them into the kind cluster, and starts the operator using local Helm templates.

```bash
# Build, inject, and run
$ ./hack/run-in-kind.sh

```

--------------------------------

### Configure Destination Namespace

Source: https://volsync.readthedocs.io/en/stable/usage/restic/database_example.html

Prepare the destination namespace by creating it and enabling privileged movers.

```bash
$ kubectl create ns dest
$ kubectl annotate namespace dest volsync.backube/privileged-movers="true"
$ kubectl -n dest create -f examples/restic/source-restic/
```

--------------------------------

### Create Dokuwiki Namespace and Resources

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/syncthing/syncthing_example.rst.txt

Creates a namespace for the Dokuwiki application and applies the necessary resources. Ensure LoadBalancer is configured.

```bash
kubectl create ns dokuwiki-east
kubectl apply -f examples/dokuwiki/ -n dokuwiki-east
```

--------------------------------

### Get External IP for dokuwiki-central

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/syncthing/syncthing_example.rst.txt

Retrieves the external IP address for the Dokuwiki service in the 'dokuwiki-central' namespace.

```console
$ kubectl get service -n dokuwiki-central dokuwiki-service
NAME               TYPE           CLUSTER-IP      EXTERNAL-IP      PORT(S)          AGE
dokuwiki-service   LoadBalancer   10.96.254.251   172.18.255.203   5196:31687/TCP   2m32s
```

--------------------------------

### Get External IP for dokuwiki-west

Source: https://volsync.readthedocs.io/en/stable/_sources/usage/syncthing/syncthing_example.rst.txt

Retrieves the external IP address for the Dokuwiki service in the 'dokuwiki-west' namespace.

```console
$ kubectl get service -n dokuwiki-west dokuwiki-service
NAME               TYPE           CLUSTER-IP      EXTERNAL-IP      PORT(S)          AGE
dokuwiki-service   LoadBalancer   10.96.142.135   172.18.255.202   5196:32364/TCP   114s
```

--------------------------------

### List and View Longhorn CSI VolumeSnapshotClass

Source: https://volsync.readthedocs.io/en/stable/installation/index.html

Lists all VolumeSnapshotClasses and then views the details of a specific Longhorn CSI VolumeSnapshotClass. This example highlights the parameters specific to Longhorn snapshots.

```bash
# List VolumeSnapshotClasses
$ kubectl get volumesnapshotclasses
NAME                    DRIVER                  DELETIONPOLICY   AGE
longhorn-snapshot-vsc   driver.longhorn.io      Delete           10m


# View details of the longhorn-snapshot-vsc VSC
$ kubectl get volumesnapshotclass/longhorn-snapshot-vsc -oyaml
kind: VolumeSnapshotClass
apiVersion: snapshot.storage.k8s.io/v1
metadata:
  annotations:
    snapshot.storage.kubernetes.io/is-default-class: "true"
  name: longhorn-snapshot-vsc
driver: driver.longhorn.io
deletionPolicy: Delete
parameters:
  type: snap  # a CSI snapshot maps to a Longhorn snapshot

```
Tokens:
Raw