You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 29, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/meshstack.building-aws-quickstart-guide.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,13 +6,13 @@ title: AWS S3 Quickstart Guide
6
6
## Introduction
7
7
8
8
Welcome to the **AWS building block quickstart guide**! This guide provides step-by-step instructions to help you
9
-
quickly set up your first meshStack building block and deploy AWS resources using Terraform.
9
+
quickly set up your first meshStack building block and deploy AWS resources using OpenTofu.
10
10
11
11
## Goals
12
12
13
13
By the end of this guide, you will have achieved:
14
14
15
-
1. Creating a [building block definition](administration.building-blocks.md) that deploys an AWS S3 Bucket using Terraform.
15
+
1. Creating a [building block definition](administration.building-blocks.md) that deploys an AWS S3 Bucket using OpenTofu.
16
16
2. Deployed & tested the building block.
17
17
3. Publishing the building block on the marketplace.
18
18
@@ -21,8 +21,8 @@ By the end of this guide, you will have achieved:
21
21
Before starting, ensure you have the following:
22
22
23
23
- An AWS account with a service user that has permission to manage S3 buckets.
24
-
- Tip: have a look at our [Terraform code](https://github.com/meshcloud/meshstack-hub/tree/main/modules/aws/s3_bucket/backplane) for defining a service user to learn more.
25
-
-Terraform code to provision an S3 bucket. We highly recommend using our [template](https://github.com/meshcloud/meshstack-hub/tree/main/modules/aws/s3_bucket/buildingblock) to get started.
24
+
- Tip: have a look at our [OpenTofu code](https://github.com/meshcloud/meshstack-hub/tree/main/modules/aws/s3_bucket/backplane) for defining a service user to learn more.
25
+
-OpenTofu code to provision an S3 bucket. We highly recommend using our [template](https://github.com/meshcloud/meshstack-hub/tree/main/modules/aws/s3_bucket/buildingblock) to get started.
26
26
- Access to a meshStack workspace that has the [Platform Builder enabled](marketplace.platform-builder.md).
27
27
If you don’t see the Platform Builder, go to Settings > General in your workspace and enable it.
28
28
@@ -36,7 +36,7 @@ Before starting, ensure you have the following:
36
36
2.**Create a new building block definition**
37
37
38
38
In the list, click on the button “+ Create new Definition”. A wizard will open where we will have to enter all
39
-
the necessary information to run the S3 bucket using Terraform.
39
+
the necessary information to run the S3 bucket using OpenTofu.
40
40
41
41
3.**Select a type**
42
42
@@ -65,23 +65,23 @@ Before starting, ensure you have the following:
65
65
66
66
If still on the general page, click “Next” and let’s start filling in all details for running OpenTofu as part of this building block.
67
67
68
-
You will be asked which implementation type to use. Pick “Terraform” here. Additional settings will show up.
68
+
You will be asked which implementation type to use. Pick “OpenTofu” here. Additional settings will show up.
69
69
70
70
- Enter a desired OpenTofu version or leave the default value.
71
71
72
72
> 💡Any versions entered over 1.5.5 will run using [OpenTofu](https://opentofu.org/).
73
-
> This is an open-source, friendlier alternative of Terraform.
73
+
> This is an open-source, friendlier alternative of OpenTofu.
74
74
75
75
- Enable the option “Use meshStack’s Http Backend” if using our template.
76
76
Learn more about how this meshStack backend works [here](meshstack.building-blocks.meshStack-http-backend.md).
77
77
- Enter a git repository URL. You can either enter your own or use our template, for which the git repository URL
78
78
is `https://github.com/meshcloud/meshstack-hub.git`
79
-
- The AWS Bucket Terraform code is under folder `modules/aws/s3_bucket/buildingblock`.
79
+
- The AWS Bucket OpenTofu code is under folder `modules/aws/s3_bucket/buildingblock`.
80
80
Make sure to enter this folder under "Git Repository Path".
81
-
- You can leave "Git Reference" empty for now. With this field, you can pin the used Terraform files to a certain
81
+
- You can leave "Git Reference" empty for now. With this field, you can pin the used OpenTofu files to a certain
82
82
git tag, branch, or commit.
83
83
- If you don’t use a self-hosted git repository, a “Test Connection” button will appear.
84
-
- Click this button and if everything is correct you should see all Terraform files related to your AWS S3 bucket.
84
+
- Click this button and if everything is correct you should see all OpenTofu files related to your AWS S3 bucket.
85
85
- If anything has gone wrong, you will receive an error message instead. Analyze the given error, try to
86
86
resolve the issue, and try again.
87
87
- For “Execution Mode” leave this as it is. In complex scenarios, you can take over the status reporting of your
@@ -104,11 +104,11 @@ Before starting, ensure you have the following:
104
104
105
105
Leave all of them checked and click “Add selected”.
106
106
107
-
You will now see all variables that are defined in Terraform plus the AWS authentication environment variables that
107
+
You will now see all variables that are defined in OpenTofu plus the AWS authentication environment variables that
108
108
are needed to manage resources in AWS. Let’s fill those in:
109
109
110
110
(If you are unsure what rights are needed, take a look at our
111
-
[Terraform IAM definition](https://github.com/meshcloud/meshstack-hub/blob/main/modules/aws/s3_bucket/backplane/iam.tf)
111
+
[OpenTofu IAM definition](https://github.com/meshcloud/meshstack-hub/blob/main/modules/aws/s3_bucket/backplane/iam.tf)
112
112
for this quickstart guide)
113
113
114
114
- For `AWS_ACCESS_KEY_ID` add the ID of an access key in AWS that has the right to manage S3 resources in the “Static Value” field.
@@ -142,7 +142,7 @@ There should be a wizard explaining what the next step is. Let’s follow those
142
142
143
143
You will be redirected to the list of building blocks, and you should see the newly created building block in a pending state.
144
144
Let’s open it up and see if it runs successfully. Click on the name of the building block and open up the first run.
145
-
You should see the Terraform logs which are automatically refreshed.
145
+
You should see the OpenTofu logs which are automatically refreshed.
0 commit comments