From 3f8770119cdddda5a6e2695f890eaee721f8c13f Mon Sep 17 00:00:00 2001 From: Christopher Davis Date: Wed, 24 Jun 2020 10:19:48 -0700 Subject: [PATCH] docs: Provide instructions for s3 backend prerequisites Related to https://github.com/kinvolk/lokomotive/issues/226 --- docs/configuration-reference/backend/s3.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/configuration-reference/backend/s3.md b/docs/configuration-reference/backend/s3.md index 0b8fe44c0..32974359e 100644 --- a/docs/configuration-reference/backend/s3.md +++ b/docs/configuration-reference/backend/s3.md @@ -19,8 +19,23 @@ used. ## Prerequisites -* AWS S3 bucket to be used should already be created. +* AWS S3 bucket to be used should already be created. You can do this by running the following AWS CLI command: + +```sh +aws s3 mb s3://kinvolk-lokomotive-test --region=eu-central-1 +``` + * DynamoDB table to be used for state locking should already be created. The table must have a primary key named LockID. +You can create it with the following AWS CLI command: + + +```sh +aws dynamodb create-table --table-name kinvolk-lokomotive-test \ +--attribute-definitions AttributeName=LockID,AttributeType=S \ +--key-schema AttributeName=LockID,KeyType=HASH \ +--billing-mode=PAY_PER_REQUEST +``` + * The necessary [IAM permissions](#iam-permissions) for S3 and DynamoDB. ## Configuration