Skip to content

Commit dd386e2

Browse files
authored
Merge pull request #1 from derek10cloud/fix-stack-dir
chore: Fix README(stack-directory changed)
2 parents b4ce418 + 61d5aeb commit dd386e2

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

aws-stack/README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,15 @@ see the following links for more information on `stackql`, `stackql-deploy` and
1111

1212
## Overview
1313

14-
__`stackql-deploy`__ is a stateless, declarative, SQL driven Infrastructure-as-Code (IaC) framework. There is no state file required as the current state is assessed for each resource at runtime. __`stackql-deploy`__ is capable of provisioning, deprovisioning and testing a stack which can include resources across different providers, like a stack spanning `aws` and `azure` for example.
14+
**`stackql-deploy`** is a stateless, declarative, SQL driven Infrastructure-as-Code (IaC) framework. There is no state file required as the current state is assessed for each resource at runtime. **`stackql-deploy`** is capable of provisioning, deprovisioning and testing a stack which can include resources across different providers, like a stack spanning `aws` and `azure` for example.
1515

1616
## Prerequisites
1717

18-
This example requires `stackql-deploy` to be installed using __`pip install stackql-deploy`__. The host used to run `stackql-deploy` needs the necessary environment variables set to authenticate to your specific provider, in the case of the `aws` provider, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and optionally `AWS_SESSION_TOKEN` must be set, for more information on authentication to `aws` see the [`aws` provider documentation](https://aws.stackql.io/providers/aws).
18+
This example requires `stackql-deploy` to be installed using **`pip install stackql-deploy`**. The host used to run `stackql-deploy` needs the necessary environment variables set to authenticate to your specific provider, in the case of the `aws` provider, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and optionally `AWS_SESSION_TOKEN` must be set, for more information on authentication to `aws` see the [`aws` provider documentation](https://aws.stackql.io/providers/aws).
1919

20-
> __Note for macOS users__
21-
> to install `stackql-deploy` in a virtual environment (which may be necessary on __macOS__), use the following:
20+
> **Note for macOS users**
21+
> to install `stackql-deploy` in a virtual environment (which may be necessary on **macOS**), use the following:
22+
>
2223
> ```bash
2324
> python3 -m venv myenv
2425
> source myenv/bin/activate
@@ -27,29 +28,29 @@ This example requires `stackql-deploy` to be installed using __`pip install stac
2728
2829
## Usage
2930
30-
Adjust the values in the [__`stackql_manifest.yml`__](stackql_manifest.yml) file if desired. The [__`stackql_manifest.yml`__](stackql_manifest.yml) file contains resource configuration variables to support multiple deployment environments, these will be used for `stackql` queries in the `resources` and `resources` folders.
31+
Adjust the values in the [**`stackql_manifest.yml`**](stackql_manifest.yml) file if desired. The [**`stackql_manifest.yml`**](stackql_manifest.yml) file contains resource configuration variables to support multiple deployment environments, these will be used for `stackql` queries in the `resources` and `resources` folders.
3132
3233
The syntax for the `stackql-deploy` command is as follows:
3334
3435
```bash
3536
stackql-deploy { build | test | teardown } { stack-directory } { deployment environment} [ optional flags ]
36-
```
37+
```
3738
3839
### Deploying a stack
3940
4041
For example, to deploy the stack to an environment labeled `sit`, run the following:
4142
4243
```bash
4344
stackql-deploy build \
44-
examples/aws/aws-stack sit \
45+
aws-stack/ sit \
4546
-e AWS_REGION=ap-southeast-2
4647
```
4748
4849
Use the `--dry-run` flag to view the queries to be run without actually running them, for example:
4950
5051
```bash
5152
stackql-deploy build \
52-
examples/aws/aws-stack sit \
53+
aws-stack/ sit \
5354
-e AWS_REGION=ap-southeast-2 \
5455
--dry-run
5556
```
@@ -60,7 +61,7 @@ To test a stack to ensure that all resources are present and in the desired stat
6061
6162
```bash
6263
stackql-deploy test \
63-
examples/aws/aws-stack sit \
64+
aws-stack/ sit \
6465
-e AWS_REGION=ap-southeast-2
6566
```
6667
@@ -70,6 +71,6 @@ To destroy or deprovision all resources in a stack for our `sit` deployment exam
7071
7172
```bash
7273
stackql-deploy teardown \
73-
examples/aws/aws-stack sit \
74+
aws-stack/ sit \
7475
-e AWS_REGION=ap-southeast-2
75-
```
76+
```

0 commit comments

Comments
 (0)