Skip to content

Commit

Permalink
docs: updates to cleaner instructions for prereqs
Browse files Browse the repository at this point in the history
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
  • Loading branch information
Gowiem and coderabbitai[bot] authored Nov 8, 2024
1 parent fcb3b2f commit 6ca89ea
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion examples/complete/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,15 @@ By doing this, we provide an example of how to set up Spacelift to automate the

## Use the Example

1. Prerequisites: Replace [backend.tf.json](./components/spacelift-automation/backend.tf.json), [example.tfvars](./components/spacelift-automation/tfvars/example.tfvars), and [example.yaml](./components/spacelift-automation/stacks/example.yaml) values with your own. The values in this repo are hardcoded for Masterpoint's automation and testing needs.
1. Prerequisites:
- Replace the following configuration files with your own values:
- `backend.tf.json`: Configure your Terraform backend settings
- `example.tfvars`: Set your Spacelift configuration variables
- `example.yaml`: Define your stack configuration
> **Important:** These files may contain sensitive information. Ensure you:
> - Remove any hardcoded credentials or sensitive values
> - Have appropriate Spacelift and AWS permissions
> - Follow your organization's security practices
1. Navigate to the spacelift-automation component directory:
```sh
cd ./components/spacelift-automation/
Expand Down

0 comments on commit 6ca89ea

Please sign in to comment.