Skip to content

Commit 56d4626

Browse files
terraform-docs: automated action
1 parent 939a706 commit 56d4626

File tree

1 file changed

+7
-45
lines changed

1 file changed

+7
-45
lines changed

README.md

Lines changed: 7 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
<!-- BEGIN_TF_DOCS -->
2+
# terraform-aws-kong
3+
4+
Terraform Module to setup Kong(OSS) in ECS with self managed EC2 instances.
5+
26
# Architectural Diagram
37

48
![Kong](https://github.com/infraspecdev/terraform-aws-kong/raw/main/diagrams/kong-architecture.png)
@@ -7,61 +11,19 @@
711

812
This setup assumes that the `ECS cluster` that has `Auto Scaling Group (ASG)` exist with the name `default`. If you are using different name, you can provide those in the variables section of your Terraform configuration.
913

10-
# Prerequisites for Setting Up AWS SSM Parameters
11-
12-
To configure and manage your AWS resources and GitHub Actions using Secure String parameters in AWS Systems Manager Parameter Store, follow the steps below to add the required parameters:
13-
14-
## AWS CLI Installation
15-
16-
Ensure you have the AWS CLI installed on your machine. You can install the AWS CLI using the following commands based on your operating system:
17-
18-
### Windows
19-
```sh
20-
msiexec.exe /i https://awscli.amazonaws.com/AWSCLIV2.msi
21-
```
22-
23-
### macOS
24-
```sh
25-
brew install awscli
26-
```
27-
28-
### Linux
29-
```sh
30-
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
31-
unzip awscliv2.zip
32-
sudo ./aws/install
33-
```
34-
35-
## AWS CLI Configuration
36-
37-
Configure the AWS CLI with your AWS credentials and region. Run the following command and follow the prompts to enter your AWS Access Key, Secret Access Key, and default region:
38-
39-
```sh
40-
aws configure
41-
```
42-
4314
## Adding Parameters to AWS Systems Manager Parameter Store
4415

45-
Use the following commands to add the required parameters to AWS Systems Manager Parameter Store. These parameters are necessary for configuring your PostgreSQL database and GitHub Actions.
16+
Ensure you have the AWS CLI installed on your machine. You can find the installation instructions for different operating systems in the official AWS CLI documentation:
17+
[Install AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
4618

47-
### RDS Parameters
19+
Use the following commands to add the required parameters to AWS Systems Manager Parameter Store. These parameters are necessary for configuring your PostgreSQL database.
4820

4921
```sh
5022
aws ssm put-parameter --name "/rds/POSTGRES_USERNAME" --value "value" --type "SecureString"
5123
aws ssm put-parameter --name "/rds/POSTGRES_PASSWORD" --value "value" --type "SecureString"
5224
aws ssm put-parameter --name "/rds/POSTGRES_DB_NAME" --value "value" --type "SecureString"
5325
```
5426

55-
## Verifying Parameter Storage
56-
57-
After adding the parameters, you can verify their storage in AWS Systems Manager Parameter Store using the following command:
58-
59-
```sh
60-
aws ssm get-parameters --names "/rds/POSTGRES_USERNAME" "/rds/POSTGRES_PASSWORD" "/rds/POSTGRES_DB_NAME" --with-decryption
61-
```
62-
63-
This command will display the values of the stored parameters, ensuring they have been added correctly.
64-
6527
## Requirements
6628

6729
| Name | Version |

0 commit comments

Comments
 (0)