Merge pull request #670 from kinvolk/cdavis/backend-documentation

kinvolk · Jul 2, 2020 · fc47cfb · fc47cfb
2 parents f9d3bc6 + bc6d519
commit fc47cfb
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 1 deletion.
diff --git 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

diff --git a/docs/quickstarts/aks.md b/docs/quickstarts/aks.md
@@ -98,6 +98,10 @@ The provided configuration installs the Lokomotive cluster and the following com
 
 You can configure the components as per your requirements.
 
+Lokomotive can store Terraform state [locally](../configuration-reference/backend/local.md)
+or remotely within an [AWS S3 bucket](../configuration-reference/backend/s3.md). By default, Lokomotive
+stores Terraform state locally.
+
 Create a variables file named `lokocfg.vars` in the working directory to set values for variables
 defined in the configuration file.
 

diff --git a/docs/quickstarts/aws.md b/docs/quickstarts/aws.md
@@ -90,6 +90,10 @@ The provided configuration installs the Lokomotive cluster and the following com
 
 You can configure the components as per your requirements.
 
+Lokomotive can store Terraform state [locally](../configuration-reference/backend/local.md)
+or remotely within an [AWS S3 bucket](../configuration-reference/backend/s3.md). By default, Lokomotive
+stores Terraform state locally.
+
 Create a variables file named `lokocfg.vars` in the working directory to set values for variables
 defined in the configuration file.
 

diff --git a/docs/quickstarts/baremetal.md b/docs/quickstarts/baremetal.md
@@ -188,6 +188,10 @@ cluster "bare-metal" {
 
 ```
 
+Lokomotive can store Terraform state [locally](../configuration-reference/backend/local.md)
+or remotely within an [AWS S3 bucket](../configuration-reference/backend/s3.md). By default, Lokomotive
+stores Terraform state locally.
+
 For advanced cluster configurations and more information refer to the [Bare Metal configuration
 guide](../configuration-reference/platforms/baremetal.md).
 

diff --git a/docs/quickstarts/packet.md b/docs/quickstarts/packet.md
@@ -27,6 +27,10 @@ uses the `stable` channel.
 The guide uses [Amazon Route 53](https://aws.amazon.com/route53/) as a DNS provider. For more
 information on how Lokomotive handles DNS, refer to [this](../concepts/dns.md) document.
 
+Lokomotive can store Terraform state [locally](../configuration-reference/backend/local.md)
+or remotely within an [AWS S3 bucket](../configuration-reference/backend/s3.md). By default, Lokomotive
+stores Terraform state locally.
+
 [Lokomotive components](../concepts/components.md) complement the "stock" Kubernetes functionality
 by adding features such as load balancing, persistent storage and monitoring to a cluster. To keep
 this guide short you will deploy a single component - `httpbin` - which serves as a demo