Skip to content

Commit

Permalink
Update Platform Directory Structure (#218)
Browse files Browse the repository at this point in the history
* Update structure

Signed-off-by: hmsayem <[email protected]>

* Update image path

Signed-off-by: hmsayem <[email protected]>

Co-authored-by: Emruz Hossain <[email protected]>
  • Loading branch information
hmsayem and Emruz Hossain authored Apr 12, 2022
1 parent c1fc7f7 commit 6559500
Show file tree
Hide file tree
Showing 63 changed files with 53 additions and 53 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
File renamed without changes.
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
```

Expand Down Expand Up @@ -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
```

Expand Down Expand Up @@ -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
```

Expand Down Expand Up @@ -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
```

Expand Down Expand Up @@ -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 `<storage account name>/source/data` directory as specified by `spec.backend.azure.prefix` field of `Repository` crd.

<figure align="center">
  <img alt="Backup data in Azure Blob Storage Container" src="/docs/images/guides/platforms/aks.png">
  <img alt="Backup data in Azure Blob Storage Container" src="/docs/guides/platforms/aks/images/aks.png">
<figcaption align="center">Fig: Backup data in Azure Blob Storage Container</figcaption>
</figure>

Expand Down Expand Up @@ -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
```
Expand Down Expand Up @@ -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
```

Expand Down
File renamed without changes
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down Expand Up @@ -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
```
Expand All @@ -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.
<figure align="center">
  <img alt="Create IAM policy (Step: 1)" src="/docs/images/guides/platforms/create-bucket-policy-1.png">
  <img alt="Create IAM policy (Step: 1)" src="/docs/guides/platforms/eks-irsa/images/create-bucket-policy-1.png">
<figcaption align="center">Fig: Create IAM policy (Step: 1)</figcaption>
</figure>
<figure align="center">
  <img alt="Create IAM policy (Step: 2)" src="/docs/images/guides/platforms/create-bucket-policy-2.png">
  <img alt="Create IAM policy (Step: 2)" src="/docs/guides/platforms/eks-irsa/images/create-bucket-policy-2.png">
<figcaption align="center">Fig: Create IAM policy (Step: 2 </figcaption>
</figure>
Expand Down Expand Up @@ -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
```
Expand Down Expand Up @@ -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.
<figure align="center">
  <img alt="Backup data in GCS Bucket" src="/docs/images/guides/platforms/gke.png">
  <img alt="Backup data in GCS Bucket" src="/docs/guides/platforms/eks-irsa/images/gcs.png">
<figcaption align="center">Fig: Backup data in GCS Bucket</figcaption>
</figure>
Expand Down Expand Up @@ -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
```
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/platforms/eks-kube2iam/images/eks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/platforms/eks-kube2iam/images/gcs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<figure align="center">
  <img alt="Create IAM policy" src="/docs/images/guides/platforms/create-bucket-policy-1.png">
  <img alt="Create IAM policy" src="/docs/guides/platforms/eks-kube2iam/images/create-bucket-policy-1.png">
<figcaption align="center">Fig: Create IAM policy</figcaption>
</figure>

<figure align="center">
  <img alt="Review IAM policy" src="/docs/images/guides/platforms/create-bucket-policy-2.png">
  <img alt="Review IAM policy" src="/docs/guides/platforms/eks-kube2iam/images/create-bucket-policy-2.png">
<figcaption align="center">Fig: Review IAM policy</figcaption>
</figure>

Expand All @@ -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,

<figure align="center">
  <img alt="Create IAM role (Step: 1)" src="/docs/images/guides/platforms/create-role-1.png">
  <img alt="Create IAM role (Step: 1)" src="/docs/guides/platforms/eks-kube2iam/images/create-role-1.png">
<figcaption align="center">Fig: Create IAM Role (Step: 1)</figcaption>
</figure>

<figure align="center">
  <img alt="Create IAM role (Step: 2)" src="/docs/images/guides/platforms/create-role-2.png">
  <img alt="Create IAM role (Step: 2)" src="/docs/guides/platforms/eks-kube2iam/images/create-role-2.png">
<figcaption align="center">Fig: Create IAM Role (Step: 2)</figcaption>
</figure>

<figure align="center">
  <img alt="Create IAM role (Step: 3)" src="/docs/images/guides/platforms/create-role-3.png">
  <img alt="Create IAM role (Step: 3)" src="/docs/guides/platforms/eks-kube2iam/images/create-role-3.png">
<figcaption align="center">Fig: Create IAM Role (Step: 3)</figcaption>
</figure>

Expand All @@ -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`,

<figure align="center">
  <img alt="Create IAM policy (Step: 1)" src="/docs/images/guides/platforms/create-assume-policy-1.png">
  <img alt="Create IAM policy (Step: 1)" src="/docs/guides/platforms/eks-kube2iam/images/create-assume-policy-1.png">
<figcaption align="center">Fig: Create IAM policy (Step: 1)</figcaption>
</figure>

<figure align="center">
  <img alt="Create IAM policy(Step: 2) " src="/docs/images/guides/platforms/create-assume-policy-2.png">
  <img alt="Create IAM policy(Step: 2) " src="/docs/guides/platforms/eks-kube2iam/images/create-assume-policy-2.png">
<figcaption align="center">Fig: Create IAM policy (Step: 2)</figcaption>
</figure>

Now, let's attach the IAM policy to our exisiting node role,
<figure align="center">
  <img alt="Attach IAM policy(Step: 1" src="/docs/images/guides/platforms/attach-policy-1.png">
  <img alt="Attach IAM policy(Step: 1" src="/docs/guides/platforms/eks-kube2iam/images/attach-policy-1.png">
<figcaption align="center">Fig: Attach Policy (Step: 1)</figcaption>
</figure>

<figure align="center">
  <img alt="Attach IAM policy(Step: 2" src="/docs/images/guides/platforms/attach-policy-2.png">
  <img alt="Attach IAM policy(Step: 2" src="/docs/guides/platforms/eks-kube2iam/images/attach-policy-2.png">
<figcaption align="center">Fig: Attach Policy (Step: 2)</figcaption>
</figure>

Expand Down Expand Up @@ -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,

<figure align="center">
  <img alt="Update Trust policy(Step: 1" src="/docs/images/guides/platforms/trust-policy-1.png">
  <img alt="Update Trust policy(Step: 1" src="/docs/guides/platforms/eks-kube2iam/images/trust-policy-1.png">
<figcaption align="center">Fig: Update Trust Policy (Step: 1)</figcaption>
</figure>

<figure align="center">
  <img alt="Update Trust policy(Step: 2" src="/docs/images/guides/platforms/trust-policy-2.png">
  <img alt="Update Trust policy(Step: 2" src="/docs/guides/platforms/eks-kube2iam/images/trust-policy-2.png">
<figcaption align="center">Fig: Update Trust Policy (Step: 2)</figcaption>
</figure>

Expand Down Expand Up @@ -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
```

Expand Down Expand Up @@ -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
```
Expand Down Expand Up @@ -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
```
Expand Down Expand Up @@ -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.
<figure align="center">
  <img alt="Backup data in GCS Bucket" src="/docs/images/guides/platforms/gke.png">
  <img alt="Backup data in GCS Bucket" src="/docs/guides/platforms/eks-kube2iam/images/gcs.png">
<figcaption align="center">Fig: Backup data in GCS Bucket</figcaption>
</figure>
Expand Down Expand Up @@ -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
```
Expand Down
Binary file added docs/guides/platforms/gke/images/gke.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down Expand Up @@ -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
```
Expand Down Expand Up @@ -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
```
Expand Down Expand Up @@ -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.
<figure align="center">
  <img alt="Backup data in GCS Bucket" src="/docs/images/guides/platforms/gke.png">
  <img alt="Backup data in GCS Bucket" src="/docs/guides/platforms/gke/images/gke.png">
<figcaption align="center">Fig: Backup data in GCS Bucket</figcaption>
</figure>
Expand Down Expand Up @@ -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
```
Expand Down
File renamed without changes
Loading

0 comments on commit 6559500

Please sign in to comment.