Skip to content
This repository has been archived by the owner on Aug 25, 2021. It is now read-only.

Commit

Permalink
Merge pull request #200 from cooktheryan/examplesv2
Browse files Browse the repository at this point in the history
Resubmitting examples and docs cleanup
  • Loading branch information
mergify[bot] committed Jun 9, 2021
2 parents e1e3ef1 + 01ae11a commit 087c993
Show file tree
Hide file tree
Showing 13 changed files with 15 additions and 15 deletions.
8 changes: 4 additions & 4 deletions docs/usage/rclone/database_example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ Now, deploy the ``rclone-secret`` followed by ``ReplicationSource`` configuratio

.. code:: bash
$ kubectl create secret generic rclone-secret --from-file=rclone.conf=./examples/rclone.conf -n source
$ kubectl create -f examples/scribe_v1alpha1_replicationsource_rclone.yaml -n source
$ kubectl create secret generic rclone-secret --from-file=rclone.conf=./examples/rclone/rclone.conf -n source
$ kubectl create -f examples/rclone/scribe_v1alpha1_replicationsource.yaml -n source
To verify the replication has completed describe the Replication source.

Expand Down Expand Up @@ -81,8 +81,8 @@ on the destination.
.. code:: bash
$ kubectl create ns dest
$ kubectl create secret generic rclone-secret --from-file=rclone.conf=./examples/rclone.conf -n dest
$ kubectl create -f examples/scribe_v1alpha1_replicationdestination_rclone.yaml -n dest
$ kubectl create secret generic rclone-secret --from-file=rclone.conf=./examples/rclone/rclone.conf -n dest
$ kubectl create -f examples/rclone/scribe_v1alpha1_replicationdestination.yaml -n dest
Expand Down
4 changes: 2 additions & 2 deletions docs/usage/rclone/rclone-secret.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Source side

.. code:: bash
$ kubectl create secret generic rclone-secret --from-file=rclone.conf=./examples/rclone.conf -n source
$ kubectl create secret generic rclone-secret --from-file=rclone.conf=./examples/rclone/rclone.conf -n source
$ kubectl get secrets -n source
NAME TYPE DATA AGE
default-token-g9vdx kubernetes.io/service-account-token 3 20s
Expand All @@ -56,7 +56,7 @@ Destination side

.. code:: bash
$ kubectl create secret generic rclone-secret --from-file=rclone.conf=./examples/rclone.conf -n dest
$ kubectl create secret generic rclone-secret --from-file=rclone.conf=./examples/rclone/rclone.conf -n dest
$ kubectl get secrets -n dest
NAME TYPE DATA AGE
default-token-5ngtg kubernetes.io/service-account-token 3 17s
Expand Down
8 changes: 4 additions & 4 deletions docs/usage/restic/database_example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,8 @@ Now, deploy the ``restic-config`` followed by ``ReplicationSource`` configuratio

.. code-block:: none
$ kubectl create -f example/source-restic/source-restic.yaml -n source
$ kubectl create -f examples/scribe_v1alpha1_replicationsource_restic.yaml -n source
$ kubectl create -f examples/restic/source-restic/source-restic.yaml -n source
$ kubectl create -f examples/restic/scribe_v1alpha1_replicationsource.yaml -n source
To verify the replication has completed, view the the ReplicationSource
``.status`` field.
Expand Down Expand Up @@ -202,7 +202,7 @@ To restore from the backup, create a destination, deploy ``restic-config`` and
.. code-block:: none
$ kubectl create ns dest
$ kubectl -n dest create -f examples/source-restic/
$ kubectl -n dest create -f examples/restic/source-restic/
To start the restore, create a empty PVC for the data:

Expand Down Expand Up @@ -231,7 +231,7 @@ Create the ReplicationDestination in the ``dest`` namespace to restore the data:
.. code-block:: none
$ kubectl -n dest create -f examples/scribe_v1alpha1_replicationdestination_restic.yaml
$ kubectl -n dest create -f examples/restic/scribe_v1alpha1_replicationdestination.yaml
Once the restore is complete, the ``.status.lastManualSync`` field will match
``.spec.trigger.manual``.
Expand Down
6 changes: 3 additions & 3 deletions docs/usage/rsync/database_example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ configuration.
.. code:: bash
$ kubectl create ns dest
$ kubectl create -n dest -f examples/scribe_v1alpha1_replicationdestination.yaml
$ kubectl create -n dest -f examples/rsync/scribe_v1alpha1_replicationdestination.yaml
A Service is created which will be used by the ReplicationSource to Rsync the
data. Record the service IP address as it will be used for the
Expand Down Expand Up @@ -54,8 +54,8 @@ the value of the address and create the ReplicationSource object.

.. code:: bash
$ sed -i 's/my.host.com/10.107.249.72/g' examples/scribe_v1alpha1_replicationsource.yaml
$ kubectl create -n source -f examples/scribe_v1alpha1_replicationsource.yaml
$ sed -i 's/my.host.com/10.107.249.72/g' examples/rsync/scribe_v1alpha1_replicationsource.yaml
$ kubectl create -n source -f examples/rsync/scribe_v1alpha1_replicationsource.yaml
To verify the replication has completed describe the Replication source.

Expand Down
4 changes: 2 additions & 2 deletions docs/usage/rsync/ssh_keys.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Replication destination configuration

The last step to use these keys is to provide the value of ``sshKeys`` to the
ReplicationDestination object as a field. As an example we will modify
``examples/scribe_v1alpha1_replicationdestination.yaml``.
``examples/rsync/scribe_v1alpha1_replicationdestination.yaml``.

.. code:: yaml
Expand All @@ -108,7 +108,7 @@ The ReplicationDestination object can now be created:

.. code::
$ kubectl create -f examples/scribe_v1alpha1_replicationdestination.yaml
$ kubectl create -f examples/rsync/scribe_v1alpha1_replicationdestination.yaml
The above steps should be repeated to modify set the ``sshKeys`` field in the
ReplicationSource.
File renamed without changes.

0 comments on commit 087c993

Please sign in to comment.