diff --git a/docs/README.md b/docs/README.md index 0e76f4b2..f9246aa2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -67,7 +67,7 @@ Shows different uses cases of Stash like instant backup, pause backup, cross-nam - [Cross-Namespace Backup and Restore](/docs/guides/use-cases/cross-namespace-backup/index.md): Shows how to take backup and restore across namespaces using Stash. - [Cross-Cluster Backup and Restore](/docs/guides/use-cases/cross-cluster-backup/index.md): Shows how to take backup and restore across clusters using Stash. - [Customize Backup and Restore](/docs/guides/use-cases/customize-backup-restore/index.md): Shows how to customize backup and restore processes in Stash according to your needs. -- [Platforms](/docs/guides/platforms/eks-irsa.md): Shows how to use Stash to backup and restore volumes of a Kubernetes workload running in different platforms. +- [Platforms](/docs/guides/platforms/eks-irsa/index.md): Shows how to use Stash to backup and restore volumes of a Kubernetes workload running in different platforms. - [Monitoring](/docs/guides/monitoring/overview/index.md): Shows how Prometheus monitoring works with Stash, what metrics Stash exports, and how to enable monitoring. - [Hooks](/docs/guides/hooks/overview.md): Shows how to execute different actions before/after the backup/restore process. - [CLI](/docs/guides/cli/cli.md): Shows how to manage Stash objects quickly and easily using Stash `kubectl` plugin. diff --git a/docs/guides/README.md b/docs/guides/README.md index 4d441236..4edbd083 100644 --- a/docs/guides/README.md +++ b/docs/guides/README.md @@ -37,7 +37,7 @@ Shows different uses cases of Stash like instant backup, pause backup, cross-nam - [Cross-Namespace Backup and Restore](/docs/guides/use-cases/cross-namespace-backup/index.md): Shows how to take backup and restore across namespaces using Stash. - [Cross-Cluster Backup and Restore](/docs/guides/use-cases/cross-cluster-backup/index.md): Shows how to take backup and restore across clusters using Stash. - [Customize Backup and Restore](/docs/guides/use-cases/customize-backup-restore/index.md): Shows how to customize backup and restore processes in Stash according to your needs. -- [Platforms](/docs/guides/platforms/eks-irsa.md): Shows how to use Stash to backup and restore volumes of a Kubernetes workload running in different platforms. +- [Platforms](/docs/guides/platforms/eks-irsa/index.md): Shows how to use Stash to backup and restore volumes of a Kubernetes workload running in different platforms. - [Monitoring](/docs/guides/monitoring/overview/index.md): Shows how Prometheus monitoring works with Stash, what metrics Stash exports, and how to enable monitoring. - [Hooks](/docs/guides/hooks/overview.md): Shows how to execute different actions before/after the backup/restore process. - [CLI](/docs/guides/cli/cli.md): Shows how to manage Stash objects quickly and easily using Stash `kubectl` plugin. diff --git a/docs/examples/guides/platforms/aks/backupconfiguration.yaml b/docs/guides/platforms/aks/examples/backupconfiguration.yaml similarity index 100% rename from docs/examples/guides/platforms/aks/backupconfiguration.yaml rename to docs/guides/platforms/aks/examples/backupconfiguration.yaml diff --git a/docs/examples/guides/platforms/aks/deployment.yaml b/docs/guides/platforms/aks/examples/deployment.yaml similarity index 100% rename from docs/examples/guides/platforms/aks/deployment.yaml rename to docs/guides/platforms/aks/examples/deployment.yaml diff --git a/docs/examples/guides/platforms/aks/pvc.yaml b/docs/guides/platforms/aks/examples/pvc.yaml similarity index 100% rename from docs/examples/guides/platforms/aks/pvc.yaml rename to docs/guides/platforms/aks/examples/pvc.yaml diff --git a/docs/examples/guides/platforms/aks/recovered_deployment.yaml b/docs/guides/platforms/aks/examples/recovered_deployment.yaml similarity index 100% rename from docs/examples/guides/platforms/aks/recovered_deployment.yaml rename to docs/guides/platforms/aks/examples/recovered_deployment.yaml diff --git a/docs/examples/guides/platforms/aks/repository.yaml b/docs/guides/platforms/aks/examples/repository.yaml similarity index 100% rename from docs/examples/guides/platforms/aks/repository.yaml rename to docs/guides/platforms/aks/examples/repository.yaml diff --git a/docs/examples/guides/platforms/aks/restoresession.yaml b/docs/guides/platforms/aks/examples/restoresession.yaml similarity index 100% rename from docs/examples/guides/platforms/aks/restoresession.yaml rename to docs/guides/platforms/aks/examples/restoresession.yaml diff --git a/docs/images/guides/platforms/aks.png b/docs/guides/platforms/aks/images/aks.png similarity index 100% rename from docs/images/guides/platforms/aks.png rename to docs/guides/platforms/aks/images/aks.png diff --git a/docs/guides/platforms/aks.md b/docs/guides/platforms/aks/index.md similarity index 97% rename from docs/guides/platforms/aks.md rename to docs/guides/platforms/aks/index.md index 34f2ffcd..c2963013 100644 --- a/docs/guides/platforms/aks.md +++ b/docs/guides/platforms/aks/index.md @@ -48,7 +48,7 @@ standard kubernetes.io/azure-disk 3m Here, we have `standard` StorageClass in our cluster. -> **Note:** YAML files used in this tutorial are stored in [docs/examples/guides/platforms/aks](/docs/examples/guides/platforms/aks) directory of [stashed/doc](https://github.com/stashed/doc) repository. +> **Note:** YAML files used in this tutorial are stored in [docs/guides/platforms/aks/examples](/docs/guides/platforms/aks/examples) directory of [stashed/doc](https://github.com/stashed/doc) repository. ## Backup the Volume of a Deployment @@ -80,7 +80,7 @@ spec: Let's create the PVC we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/aks/pvc.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/aks/examples/pvc.yaml persistentvolumeclaim/stash-sample-data created ``` @@ -128,7 +128,7 @@ spec: Let's create the Deployment we have shown above. ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/aks/deployment.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/aks/examples/deployment.yaml deployment.apps/stash-demo created ``` @@ -212,7 +212,7 @@ spec: Let's create the Repository we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/aks/repository.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/aks/examples/repository.yaml repository.stash.appscode.com/azure-repo created ``` @@ -262,7 +262,7 @@ Here, Let's create the `BackupConfiguration` crd we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/aks/backupconfiguration.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/aks/examples/backupconfiguration.yaml backupconfiguration.stash.appscode.com/deployment-backup created ``` @@ -407,7 +407,7 @@ azure-repo true 8 B 1 2s 1m10s Now, if we navigate to the Azure blob container, we are going to see backed up data has been stored in `/source/data` directory as specified by `spec.backend.azure.prefix` field of `Repository` crd.
-  Backup data in Azure Blob Storage Container +  Backup data in Azure Blob Storage Container
Fig: Backup data in Azure Blob Storage Container
@@ -496,7 +496,7 @@ spec: Let's create the Deployment and PVC we have shown above. ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/aks/recovered_deployment.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/aks/examples/recovered_deployment.yaml persistentvolumeclaim/restore-pvc created deployment.apps/stash-recovered created ``` @@ -540,7 +540,7 @@ Here, Let's create the `RestoreSession` crd we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/aks/restoresession.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/aks/examples/restoresession.yaml restoresession.stash.appscode.com/deployment-restore created ``` diff --git a/docs/examples/guides/platforms/eks/irsa/backupconfiguration.yaml b/docs/guides/platforms/eks-irsa/examples/backupconfiguration.yaml similarity index 100% rename from docs/examples/guides/platforms/eks/irsa/backupconfiguration.yaml rename to docs/guides/platforms/eks-irsa/examples/backupconfiguration.yaml diff --git a/docs/examples/guides/platforms/eks/irsa/mariadb.yaml b/docs/guides/platforms/eks-irsa/examples/mariadb.yaml similarity index 100% rename from docs/examples/guides/platforms/eks/irsa/mariadb.yaml rename to docs/guides/platforms/eks-irsa/examples/mariadb.yaml diff --git a/docs/examples/guides/platforms/eks/irsa/repository.yaml b/docs/guides/platforms/eks-irsa/examples/repository.yaml similarity index 100% rename from docs/examples/guides/platforms/eks/irsa/repository.yaml rename to docs/guides/platforms/eks-irsa/examples/repository.yaml diff --git a/docs/examples/guides/platforms/eks/irsa/restoresession.yaml b/docs/guides/platforms/eks-irsa/examples/restoresession.yaml similarity index 100% rename from docs/examples/guides/platforms/eks/irsa/restoresession.yaml rename to docs/guides/platforms/eks-irsa/examples/restoresession.yaml diff --git a/docs/images/guides/platforms/create-bucket-policy-1.png b/docs/guides/platforms/eks-irsa/images/create-bucket-policy-1.png similarity index 100% rename from docs/images/guides/platforms/create-bucket-policy-1.png rename to docs/guides/platforms/eks-irsa/images/create-bucket-policy-1.png diff --git a/docs/images/guides/platforms/create-bucket-policy-2.png b/docs/guides/platforms/eks-irsa/images/create-bucket-policy-2.png similarity index 100% rename from docs/images/guides/platforms/create-bucket-policy-2.png rename to docs/guides/platforms/eks-irsa/images/create-bucket-policy-2.png diff --git a/docs/images/guides/platforms/eks.png b/docs/guides/platforms/eks-irsa/images/eks.png similarity index 100% rename from docs/images/guides/platforms/eks.png rename to docs/guides/platforms/eks-irsa/images/eks.png diff --git a/docs/images/guides/platforms/gke.png b/docs/guides/platforms/eks-irsa/images/gcs.png similarity index 100% rename from docs/images/guides/platforms/gke.png rename to docs/guides/platforms/eks-irsa/images/gcs.png diff --git a/docs/guides/platforms/eks-irsa.md b/docs/guides/platforms/eks-irsa/index.md similarity index 97% rename from docs/guides/platforms/eks-irsa.md rename to docs/guides/platforms/eks-irsa/index.md index 0311481c..ced1122a 100644 --- a/docs/guides/platforms/eks-irsa.md +++ b/docs/guides/platforms/eks-irsa/index.md @@ -65,7 +65,7 @@ spec: ``` ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/eks/irsa/mariadb.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/eks-irsa/examples/mariadb.yaml mariadb.kubedb.com/sample-mariadb created ``` @@ -230,7 +230,7 @@ spec: Let's create the `Repository` we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/eks/irsa/repository.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/eks-irsa/examples/repository.yaml repository.stash.appscode.com/gcs-repo created ``` @@ -257,12 +257,12 @@ We need an IAM policy for accessing S3 buckets. Below is the `JSON`of the IAM po Let's navigate to the IAM management console to create a policy `bucket-accessor` with full access permission to S3 bucket.
-  Create IAM policy (Step: 1) +  Create IAM policy (Step: 1)
Fig: Create IAM policy (Step: 1)
-  Create IAM policy (Step: 2) +  Create IAM policy (Step: 2)
Fig: Create IAM policy (Step: 2
@@ -322,7 +322,7 @@ Here, Let's create the `BackupConfiguration` crd we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/eks/irsa/backupconfiguration.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/eks-irsa/examples/backupconfiguration.yaml backupconfiguration.stash.appscode.com/sample-mariadb-backup created ``` @@ -378,7 +378,7 @@ gcs-repo true 1.327 MiB 1 60s 8m Now, if we navigate to the GCS bucket, we will see the backed up data has been stored in `demo/mariadb/sample-mariadb` directory as specified by `.spec.backend.gcs.prefix` field of the Repository object.
-  Backup data in GCS Bucket +  Backup data in GCS Bucket
Fig: Backup data in GCS Bucket
@@ -508,7 +508,7 @@ Here, Let's create the `RestoreSession` object object we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/eks/irsa/restoresession.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/eks-irsa/examples/restoresession.yaml restoresession.stash.appscode.com/sample-mariadb-restore created ``` diff --git a/docs/examples/guides/platforms/eks/kube2iam/backupconfiguration.yaml b/docs/guides/platforms/eks-kube2iam/examples/backupconfiguration.yaml similarity index 100% rename from docs/examples/guides/platforms/eks/kube2iam/backupconfiguration.yaml rename to docs/guides/platforms/eks-kube2iam/examples/backupconfiguration.yaml diff --git a/docs/examples/guides/platforms/eks/kube2iam/kube2iam.yaml b/docs/guides/platforms/eks-kube2iam/examples/kube2iam.yaml similarity index 100% rename from docs/examples/guides/platforms/eks/kube2iam/kube2iam.yaml rename to docs/guides/platforms/eks-kube2iam/examples/kube2iam.yaml diff --git a/docs/examples/guides/platforms/eks/kube2iam/mariadb.yaml b/docs/guides/platforms/eks-kube2iam/examples/mariadb.yaml similarity index 100% rename from docs/examples/guides/platforms/eks/kube2iam/mariadb.yaml rename to docs/guides/platforms/eks-kube2iam/examples/mariadb.yaml diff --git a/docs/examples/guides/platforms/eks/kube2iam/repository.yaml b/docs/guides/platforms/eks-kube2iam/examples/repository.yaml similarity index 100% rename from docs/examples/guides/platforms/eks/kube2iam/repository.yaml rename to docs/guides/platforms/eks-kube2iam/examples/repository.yaml diff --git a/docs/examples/guides/platforms/eks/kube2iam/restoresession.yaml b/docs/guides/platforms/eks-kube2iam/examples/restoresession.yaml similarity index 100% rename from docs/examples/guides/platforms/eks/kube2iam/restoresession.yaml rename to docs/guides/platforms/eks-kube2iam/examples/restoresession.yaml diff --git a/docs/images/guides/platforms/attach-policy-1.png b/docs/guides/platforms/eks-kube2iam/images/attach-policy-1.png similarity index 100% rename from docs/images/guides/platforms/attach-policy-1.png rename to docs/guides/platforms/eks-kube2iam/images/attach-policy-1.png diff --git a/docs/images/guides/platforms/attach-policy-2.png b/docs/guides/platforms/eks-kube2iam/images/attach-policy-2.png similarity index 100% rename from docs/images/guides/platforms/attach-policy-2.png rename to docs/guides/platforms/eks-kube2iam/images/attach-policy-2.png diff --git a/docs/images/guides/platforms/create-assume-policy-1.png b/docs/guides/platforms/eks-kube2iam/images/create-assume-policy-1.png similarity index 100% rename from docs/images/guides/platforms/create-assume-policy-1.png rename to docs/guides/platforms/eks-kube2iam/images/create-assume-policy-1.png diff --git a/docs/images/guides/platforms/create-assume-policy-2.png b/docs/guides/platforms/eks-kube2iam/images/create-assume-policy-2.png similarity index 100% rename from docs/images/guides/platforms/create-assume-policy-2.png rename to docs/guides/platforms/eks-kube2iam/images/create-assume-policy-2.png diff --git a/docs/guides/platforms/eks-kube2iam/images/create-bucket-policy-1.png b/docs/guides/platforms/eks-kube2iam/images/create-bucket-policy-1.png new file mode 100644 index 00000000..327522f7 Binary files /dev/null and b/docs/guides/platforms/eks-kube2iam/images/create-bucket-policy-1.png differ diff --git a/docs/guides/platforms/eks-kube2iam/images/create-bucket-policy-2.png b/docs/guides/platforms/eks-kube2iam/images/create-bucket-policy-2.png new file mode 100644 index 00000000..31f60dee Binary files /dev/null and b/docs/guides/platforms/eks-kube2iam/images/create-bucket-policy-2.png differ diff --git a/docs/images/guides/platforms/create-role-1.png b/docs/guides/platforms/eks-kube2iam/images/create-role-1.png similarity index 100% rename from docs/images/guides/platforms/create-role-1.png rename to docs/guides/platforms/eks-kube2iam/images/create-role-1.png diff --git a/docs/images/guides/platforms/create-role-2.png b/docs/guides/platforms/eks-kube2iam/images/create-role-2.png similarity index 100% rename from docs/images/guides/platforms/create-role-2.png rename to docs/guides/platforms/eks-kube2iam/images/create-role-2.png diff --git a/docs/images/guides/platforms/create-role-3.png b/docs/guides/platforms/eks-kube2iam/images/create-role-3.png similarity index 100% rename from docs/images/guides/platforms/create-role-3.png rename to docs/guides/platforms/eks-kube2iam/images/create-role-3.png diff --git a/docs/guides/platforms/eks-kube2iam/images/eks.png b/docs/guides/platforms/eks-kube2iam/images/eks.png new file mode 100644 index 00000000..ea92b061 Binary files /dev/null and b/docs/guides/platforms/eks-kube2iam/images/eks.png differ diff --git a/docs/guides/platforms/eks-kube2iam/images/gcs.png b/docs/guides/platforms/eks-kube2iam/images/gcs.png new file mode 100644 index 00000000..8ec12b62 Binary files /dev/null and b/docs/guides/platforms/eks-kube2iam/images/gcs.png differ diff --git a/docs/images/guides/platforms/trust-policy-1.png b/docs/guides/platforms/eks-kube2iam/images/trust-policy-1.png similarity index 100% rename from docs/images/guides/platforms/trust-policy-1.png rename to docs/guides/platforms/eks-kube2iam/images/trust-policy-1.png diff --git a/docs/images/guides/platforms/trust-policy-2.png b/docs/guides/platforms/eks-kube2iam/images/trust-policy-2.png similarity index 100% rename from docs/images/guides/platforms/trust-policy-2.png rename to docs/guides/platforms/eks-kube2iam/images/trust-policy-2.png diff --git a/docs/guides/platforms/eks-kube2iam.md b/docs/guides/platforms/eks-kube2iam/index.md similarity index 93% rename from docs/guides/platforms/eks-kube2iam.md rename to docs/guides/platforms/eks-kube2iam/index.md index 6db08712..cd5e79e3 100644 --- a/docs/guides/platforms/eks-kube2iam.md +++ b/docs/guides/platforms/eks-kube2iam/index.md @@ -60,12 +60,12 @@ We need an IAM policy for accessing S3 buckets. Below is the `JSON`of the IAM po Let's navigate to the IAM management console to create a policy `bucket-accessor` with full access permission to S3 buckets.
-  Create IAM policy +  Create IAM policy
Fig: Create IAM policy
-  Review IAM policy +  Review IAM policy
Fig: Review IAM policy
@@ -74,17 +74,17 @@ Let's navigate to the IAM management console to create a policy `bucket-accessor Now, let's create an IAM role `bucket-accessor` attaching the above IAM policy,
-  Create IAM role (Step: 1) +  Create IAM role (Step: 1)
Fig: Create IAM Role (Step: 1)
-  Create IAM role (Step: 2) +  Create IAM role (Step: 2)
Fig: Create IAM Role (Step: 2)
-  Create IAM role (Step: 3) +  Create IAM role (Step: 3)
Fig: Create IAM Role (Step: 3)
@@ -110,23 +110,23 @@ We need to add the policy to allow our Kubernete worker nodes to assume roles th Let's navigate to the IAM management console to create `assume-policy`,
-  Create IAM policy (Step: 1) +  Create IAM policy (Step: 1)
Fig: Create IAM policy (Step: 1)
-  Create IAM policy(Step: 2) +  Create IAM policy(Step: 2)
Fig: Create IAM policy (Step: 2)
Now, let's attach the IAM policy to our exisiting node role,
-  Attach IAM policy(Step: 1 +  Attach IAM policy(Step: 1
Fig: Attach Policy (Step: 1)
-  Attach IAM policy(Step: 2 +  Attach IAM policy(Step: 2
Fig: Attach Policy (Step: 2)
@@ -158,12 +158,12 @@ The `bucket-accessor` role needs the trust policy to trust the node role. Below Lets update the trust policy of `bucket-accessor` role,
-  Update Trust policy(Step: 1 +  Update Trust policy(Step: 1
Fig: Update Trust Policy (Step: 1)
-  Update Trust policy(Step: 2 +  Update Trust policy(Step: 2
Fig: Update Trust Policy (Step: 2)
@@ -196,7 +196,7 @@ spec: ``` ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/eks/kube2iam/mariadb.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/eks-kube2iam/examples/mariadb.yaml mariadb.kubedb.com/sample-mariadb created ``` @@ -361,7 +361,7 @@ spec: Let's create the `Repository` we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/eks/kube2iam/repository.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/eks-kube2iam/examples/repository.yaml repository.stash.appscode.com/gcs-repo created ``` @@ -411,7 +411,7 @@ Here, Let's create the `BackupConfiguration` crd we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/eks/kube2iam/backupconfiguration.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/eks-kube2iam/examples/backupconfiguration.yaml backupconfiguration.stash.appscode.com/sample-mariadb-backup created ``` @@ -467,7 +467,7 @@ gcs-repo true 1.327 MiB 1 60s 8m Now, if we navigate to the GCS bucket, we will see the backed up data has been stored in `demo/mariadb/sample-mariadb` directory as specified by `.spec.backend.gcs.prefix` field of the Repository object.
-  Backup data in GCS Bucket +  Backup data in GCS Bucket
Fig: Backup data in GCS Bucket
@@ -600,7 +600,7 @@ Here, Let's create the `RestoreSession` object object we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/eks/kube2iam/restoresession.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/eks-kube2iam/examples/restoresession.yaml restoresession.stash.appscode.com/sample-mariadb-restore created ``` diff --git a/docs/examples/guides/platforms/gke/backupconfiguration.yaml b/docs/guides/platforms/gke/examples/backupconfiguration.yaml similarity index 100% rename from docs/examples/guides/platforms/gke/backupconfiguration.yaml rename to docs/guides/platforms/gke/examples/backupconfiguration.yaml diff --git a/docs/examples/guides/platforms/gke/mariadb.yaml b/docs/guides/platforms/gke/examples/mariadb.yaml similarity index 100% rename from docs/examples/guides/platforms/gke/mariadb.yaml rename to docs/guides/platforms/gke/examples/mariadb.yaml diff --git a/docs/examples/guides/platforms/gke/repository.yaml b/docs/guides/platforms/gke/examples/repository.yaml similarity index 100% rename from docs/examples/guides/platforms/gke/repository.yaml rename to docs/guides/platforms/gke/examples/repository.yaml diff --git a/docs/examples/guides/platforms/gke/restoresession.yaml b/docs/guides/platforms/gke/examples/restoresession.yaml similarity index 100% rename from docs/examples/guides/platforms/gke/restoresession.yaml rename to docs/guides/platforms/gke/examples/restoresession.yaml diff --git a/docs/guides/platforms/gke/images/gke.png b/docs/guides/platforms/gke/images/gke.png new file mode 100644 index 00000000..8ec12b62 Binary files /dev/null and b/docs/guides/platforms/gke/images/gke.png differ diff --git a/docs/guides/platforms/gke.md b/docs/guides/platforms/gke/index.md similarity index 98% rename from docs/guides/platforms/gke.md rename to docs/guides/platforms/gke/index.md index 89187a9a..120d22bf 100644 --- a/docs/guides/platforms/gke.md +++ b/docs/guides/platforms/gke/index.md @@ -91,7 +91,7 @@ spec: ``` ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/gke/mariadb.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/gke/examples/mariadb.yaml mariadb.kubedb.com/sample-mariadb created ``` @@ -253,7 +253,7 @@ spec: Let's create the `Repository` we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/gke/repository.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/gke/examples/repository.yaml repository.stash.appscode.com/gcs-repo created ``` @@ -324,7 +324,7 @@ Here, Let's create the `BackupConfiguration` crd we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/gke/backupconfiguration.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/gke/examples/backupconfiguration.yaml backupconfiguration.stash.appscode.com/sample-mariadb-backup created ``` @@ -380,7 +380,7 @@ gcs-repo true 1.327 MiB 1 60s 8m Now, if we navigate to the GCS bucket, we will see the backed up data has been stored in `demo/mariadb/sample-mariadb` directory as specified by `.spec.backend.gcs.prefix` field of the Repository object.
-  Backup data in GCS Bucket +  Backup data in GCS Bucket
Fig: Backup data in GCS Bucket
@@ -509,7 +509,7 @@ Here, Let's create the `RestoreSession` object object we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/gke/restoresession.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/gke/examples/restoresession.yaml restoresession.stash.appscode.com/sample-mariadb-restore created ``` diff --git a/docs/examples/guides/platforms/minio/backupconfiguration.yaml b/docs/guides/platforms/minio/examples/backupconfiguration.yaml similarity index 100% rename from docs/examples/guides/platforms/minio/backupconfiguration.yaml rename to docs/guides/platforms/minio/examples/backupconfiguration.yaml diff --git a/docs/examples/guides/platforms/minio/deployment.yaml b/docs/guides/platforms/minio/examples/deployment.yaml similarity index 100% rename from docs/examples/guides/platforms/minio/deployment.yaml rename to docs/guides/platforms/minio/examples/deployment.yaml diff --git a/docs/examples/guides/platforms/minio/minio-deployment.yaml b/docs/guides/platforms/minio/examples/minio-deployment.yaml similarity index 100% rename from docs/examples/guides/platforms/minio/minio-deployment.yaml rename to docs/guides/platforms/minio/examples/minio-deployment.yaml diff --git a/docs/examples/guides/platforms/minio/minio-nodeport-svc.yaml b/docs/guides/platforms/minio/examples/minio-nodeport-svc.yaml similarity index 100% rename from docs/examples/guides/platforms/minio/minio-nodeport-svc.yaml rename to docs/guides/platforms/minio/examples/minio-nodeport-svc.yaml diff --git a/docs/examples/guides/platforms/minio/minio-pvc.yaml b/docs/guides/platforms/minio/examples/minio-pvc.yaml similarity index 100% rename from docs/examples/guides/platforms/minio/minio-pvc.yaml rename to docs/guides/platforms/minio/examples/minio-pvc.yaml diff --git a/docs/examples/guides/platforms/minio/pvc.yaml b/docs/guides/platforms/minio/examples/pvc.yaml similarity index 100% rename from docs/examples/guides/platforms/minio/pvc.yaml rename to docs/guides/platforms/minio/examples/pvc.yaml diff --git a/docs/examples/guides/platforms/minio/recovered_deployment.yaml b/docs/guides/platforms/minio/examples/recovered_deployment.yaml similarity index 100% rename from docs/examples/guides/platforms/minio/recovered_deployment.yaml rename to docs/guides/platforms/minio/examples/recovered_deployment.yaml diff --git a/docs/examples/guides/platforms/minio/repository.yaml b/docs/guides/platforms/minio/examples/repository.yaml similarity index 100% rename from docs/examples/guides/platforms/minio/repository.yaml rename to docs/guides/platforms/minio/examples/repository.yaml diff --git a/docs/examples/guides/platforms/minio/restoresession.yaml b/docs/guides/platforms/minio/examples/restoresession.yaml similarity index 100% rename from docs/examples/guides/platforms/minio/restoresession.yaml rename to docs/guides/platforms/minio/examples/restoresession.yaml diff --git a/docs/images/guides/platforms/minio.png b/docs/guides/platforms/minio/images/minio.png similarity index 100% rename from docs/images/guides/platforms/minio.png rename to docs/guides/platforms/minio/images/minio.png diff --git a/docs/guides/platforms/minio.md b/docs/guides/platforms/minio/index.md similarity index 97% rename from docs/guides/platforms/minio.md rename to docs/guides/platforms/minio/index.md index 15bdd675..dca41cb8 100644 --- a/docs/guides/platforms/minio.md +++ b/docs/guides/platforms/minio/index.md @@ -48,7 +48,7 @@ standard (default) k8s.io/minikube-hostpath 130m Here, we have `standard` StorageClass in our cluster. -> **Note:** YAML files used in this tutorial are stored in [docs/examples/guides/platforms/minio](/docs/examples/guides/platforms/minio) directory of [stashed/doc](https://github.com/stashed/doc) repository. +> **Note:** YAML files used in this tutorial are stored in [docs/guides/platforms/minio/examples](/docs/guides/platforms/minio/examples) directory of [stashed/doc](https://github.com/stashed/doc) repository. ## Backup the Volume of a Deployment @@ -80,7 +80,7 @@ spec: Let's create the PVC we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/minio/pvc.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/minio/examples/pvc.yaml persistentvolumeclaim/source-pvc created ``` @@ -128,7 +128,7 @@ spec: Let's create the Deployment we have shown above. ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/minio/deployment.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/minio/examples/deployment.yaml deployment.apps/stash-demo created ``` @@ -216,7 +216,7 @@ spec: Let's create the `Repository` we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/minio/repository.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/minio/examples/repository.yaml repository.stash.appscode.com/minio-repo created ``` @@ -266,7 +266,7 @@ Here, Let's create the `BackupConfiguration` crd we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/minio/backupconfiguration.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/minio/examples/backupconfiguration.yaml backupconfiguration.stash.appscode.com/deployment-backup created ``` @@ -438,7 +438,7 @@ minio-repo true 32 B 2 3m40s 5m18s Now, if we navigate to the Minio Bucket, we are going to see backed up data has been stored in `/source/data` directory as specified by `spec.backend.s3.prefix` field of `Repository` crd.
-  Backup data in Minio Bucket +  Backup data in Minio Bucket
Fig: Backup data in Minio Bucket
@@ -527,7 +527,7 @@ spec: Let's create the Deployment and PVC we have shown above. ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/minio/recovered_deployment.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/minio/examples/recovered_deployment.yaml persistentvolumeclaim/restore-pvc created deployment.apps/stash-recovered created ``` @@ -570,7 +570,7 @@ Here, Let's create the `RestoreSession` crd we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/minio/restoresession.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/minio/examples/restoresession.yaml restoresession.stash.appscode.com/deployment-restore created ``` diff --git a/docs/examples/guides/platforms/rook/backupconfiguration.yaml b/docs/guides/platforms/rook/examples/backupconfiguration.yaml similarity index 100% rename from docs/examples/guides/platforms/rook/backupconfiguration.yaml rename to docs/guides/platforms/rook/examples/backupconfiguration.yaml diff --git a/docs/examples/guides/platforms/rook/deployment.yaml b/docs/guides/platforms/rook/examples/deployment.yaml similarity index 100% rename from docs/examples/guides/platforms/rook/deployment.yaml rename to docs/guides/platforms/rook/examples/deployment.yaml diff --git a/docs/examples/guides/platforms/rook/pvc.yaml b/docs/guides/platforms/rook/examples/pvc.yaml similarity index 100% rename from docs/examples/guides/platforms/rook/pvc.yaml rename to docs/guides/platforms/rook/examples/pvc.yaml diff --git a/docs/examples/guides/platforms/rook/recovered_deployment.yaml b/docs/guides/platforms/rook/examples/recovered_deployment.yaml similarity index 100% rename from docs/examples/guides/platforms/rook/recovered_deployment.yaml rename to docs/guides/platforms/rook/examples/recovered_deployment.yaml diff --git a/docs/examples/guides/platforms/rook/repository.yaml b/docs/guides/platforms/rook/examples/repository.yaml similarity index 100% rename from docs/examples/guides/platforms/rook/repository.yaml rename to docs/guides/platforms/rook/examples/repository.yaml diff --git a/docs/examples/guides/platforms/rook/restoresession.yaml b/docs/guides/platforms/rook/examples/restoresession.yaml similarity index 100% rename from docs/examples/guides/platforms/rook/restoresession.yaml rename to docs/guides/platforms/rook/examples/restoresession.yaml diff --git a/docs/guides/platforms/rook.md b/docs/guides/platforms/rook/index.md similarity index 97% rename from docs/guides/platforms/rook.md rename to docs/guides/platforms/rook/index.md index a55b6e55..aecb4e24 100644 --- a/docs/guides/platforms/rook.md +++ b/docs/guides/platforms/rook/index.md @@ -36,7 +36,7 @@ $ kubectl create ns demo namespace/demo created ``` -> **Note:** YAML files used in this tutorial are stored in [docs/examples/guides/platforms/rook](/docs/examples/guides/platforms/rook) directory of [stashed/doc](https://github.com/stashed/doc) repository. +> **Note:** YAML files used in this tutorial are stored in [docs/guides/platforms/rook/examples](/docs/guides/platforms/rook/examples) directory of [stashed/doc](https://github.com/stashed/doc) repository. **Choosing StorageClass:** @@ -79,7 +79,7 @@ spec: Let's create the PVC we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/rook/pvc.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/rook/examples/pvc.yaml persistentvolumeclaim/source-pvc created ``` @@ -131,7 +131,7 @@ spec: Let's create the Deployment we have shown above. ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/rook/deployment.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/rook/examples/deployment.yaml deployment.apps/stash-demo created ``` @@ -214,7 +214,7 @@ spec: Let's create the `Repository` we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/rook/repository.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/rook/examples/repository.yaml repository.stash.appscode.com/rook-repo created ``` @@ -264,7 +264,7 @@ Here, Let's create the `BackupConfiguration` crd we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/rook/backupconfiguration.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/rook/examples/backupconfiguration.yaml backupconfiguration.stash.appscode.com/deployment-backup created ``` @@ -526,7 +526,7 @@ spec: Let's create the Deployment and PVC we have shown above. ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/rook/recovered_deployment.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/rook/examples/recovered_deployment.yaml persistentvolumeclaim/restore-pvc created deployment.apps/stash-recovered created ``` @@ -569,7 +569,7 @@ Here, Let's create the `RestoreSession` crd we have shown above, ```bash -$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/examples/guides/platforms/rook/restoresession.yaml +$ kubectl apply -f https://github.com/stashed/docs/raw/{{< param "info.version" >}}/docs/guides/platforms/rook/examples/restoresession.yaml restoresession.stash.appscode.com/deployment-restore created ``` diff --git a/docs/images/guides/platforms/review-assume-policy.png b/docs/images/guides/platforms/review-assume-policy.png deleted file mode 100644 index 940df96a..00000000 Binary files a/docs/images/guides/platforms/review-assume-policy.png and /dev/null differ