-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(snapshots): Support direct cloud storage (#117)
* use recent build to make it work * feat(snapshots): Support direct cloud storage * use v1.11.0 version instead * rename s3 to dir to be more common * remove unnecessary image change * add docs for feature * small updates * fix issue with dir missing
- Loading branch information
1 parent
04c3e71
commit 2034628
Showing
4 changed files
with
139 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| # Configure Snapshots to S3 with the Dragonfly Operator | ||
|
|
||
| In this guide, We will see how to configure the Dragonfly Instances to use S3 as a backup location with the | ||
| Dragonfly Operator. While just having the AWS credentials in the environment (through a file or env) is enough | ||
| to use S3, In this guide we will use [AWS IAM roles for service accounts](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html) to provide the credentials to the Dragonfly | ||
| pod. | ||
|
|
||
| As this mechanism uses OIDC (OpenID Connect) to authenticate the service account, we will also get the benefits of | ||
| credentials isolation and automatic rotation of credentials. This way we can avoid having to pass long lived credentials. This is all done automatically by EKS. | ||
|
|
||
| ## Create an EKS cluster | ||
|
|
||
| ```bash | ||
| eksctl create cluster --name df-storage --region us-east-1 | ||
| ``` | ||
|
|
||
| ## Create and Associate IAM OIDC Provider for your cluster | ||
|
|
||
| By following the [AWS documentation](https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html), create and associate an IAM OIDC provider for your cluster. | ||
| This is a required step for the next steps to work. | ||
|
|
||
| ## Create an S3 bucket | ||
|
|
||
| Now, we will create an S3 bucket to store the snapshots. This bucket can be created using the AWS console or using the AWS CLI. | ||
|
|
||
| ```bash | ||
| aws s3api create-bucket --bucket dragonfly-backup --region us-east-1 | ||
| ``` | ||
|
|
||
| ## Create a policy to read a specific S3 bucket | ||
|
|
||
| We will now create a policy that allows the Dragonfly Instance to read and write to the S3 bucket we created in the previous step. | ||
|
|
||
| ```bash | ||
| cat <<EOF > policy.json | ||
| { | ||
| "Version": "2012-10-17", | ||
| "Statement": [ | ||
| { | ||
| "Effect": "Allow", | ||
| "Action": "s3:*", | ||
| "Resource": [ | ||
| "arn:aws:s3:::dragonfly-backup/*", | ||
| "arn:aws:s3:::dragonfly-backup" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| EOF | ||
| ``` | ||
|
|
||
| ```bash | ||
| aws iam create-policy --policy-name dragonfly-backup --policy-document file://policy.json | ||
| ``` | ||
|
|
||
| ## Associate the policy with a role | ||
|
|
||
| Now, we will associate the policy we created in the previous step with a role. This role will be used by the service account called `dragonfly-backup` which will also be created in this step. | ||
|
|
||
| ```bash | ||
| eksctl create iamserviceaccount --name dragonfly-backup --namespace default --cluster df-storage --role-name dragonfly-backup --attach-policy-arn arn:aws:iam::<account-no>:policy/dragonfly-backup --approve | ||
| ``` | ||
|
|
||
| ## Create a Dragonfly Instance with that service account | ||
|
|
||
| Let's create a Dragonfly Instance with the service account we created in the previous step. We will also configure the snapshot location to be the S3 bucket we created in the previous steps. | ||
|
|
||
| Important to note that this feature is only available from the `v1.12.0` version of the Dragonfly. Currently, We will | ||
| use the weekly release of Dragonfly to use this feature. | ||
|
|
||
| ```bash | ||
| kubectl apply -f - <<EOF | ||
| apiVersion: dragonflydb.io/v1alpha1 | ||
| kind: Dragonfly | ||
| metadata: | ||
| name: dragonfly-sample | ||
| spec: | ||
| replicas: 1 | ||
| image: <> | ||
| snapshot: | ||
| dir: "s3://dragonfly-backup" | ||
| EOF | ||
| ``` | ||
|
|
||
| ## Verify that the Dragonfly Instance is running | ||
|
|
||
| ```bash | ||
| kubectl describe dragonfly dragonfly-sample | ||
| ``` | ||
|
|
||
| ## Load Data and Terminate the Dragonfly Instance | ||
|
|
||
| Now, we will load some data into the Dragonfly Instance and then terminate the Dragonfly Instance. | ||
|
|
||
| ```bash | ||
| kubectl run -it --rm --restart=Never redis-cli --image=redis:7.0.10 -- redis-cli -h dragonfly-sample.default SET 1 2 | ||
| ``` | ||
|
|
||
| ```bash | ||
| kubectl delete pod dragonfly-sample-0 | ||
| ``` | ||
|
|
||
| ## Verification | ||
|
|
||
| ### Verify that the backups are created in the S3 bucket | ||
|
|
||
| ```bash | ||
| aws s3 ls s3://dragonfly-backup | ||
| ``` | ||
|
|
||
| ### Verify that the data is automatically restored | ||
|
|
||
| ```bash | ||
| kubectl run -it --rm --restart=Never redis-cli --image=redis:7.0.10 -- redis-cli -h dragonfly-sample.default GET 1 | ||
| ``` | ||
|
|
||
| As you can see, the data is automatically restored from the S3 bucket. This is because the Dragonfly instance is configured to use the S3 bucket as the snapshot location. |