Skip to content

Commit 89611ad

Browse files
authored
Fix readme and cloudwatch+docker dep (#56)
1 parent a1b3ffd commit 89611ad

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -142,14 +142,14 @@ The following inputs can be used as `step.with` keys
142142
| `aws_ec2_instance_create` | Boolean | Set to `true` if you wish to create an EC2 instance. (Default is `false`). |
143143
| `aws_ec2_ami_filter` | String | AWS AMI Filter string. Will be used to lookup for lates image based on the string. Defaults to `ubuntu/images/hvm-ssd/ubuntu-jammy-22.04-amd64-server-*`.' |
144144
| `aws_ec2_ami_owner` | String | 'Owner of AWS AMI image. This ensures the provider is the one we are looking for. Defaults to `099720109477`, Canonical (Ubuntu).' |
145-
| `aws_ec2_ami_id` | String | AWS AMI ID. Will default to latest Ubuntu 22.04 server image (HVM). Accepts `ami-###` values. |
145+
| `aws_ec2_ami_id` | String | AWS AMI ID. Will default to the latest Ubuntu 22.04 server image (HVM). Accepts `ami-###` values. |
146146
| `aws_ec2_ami_update` | Boolean | Set this to `true` if you want to recreate the EC2 instance if there is a newer version of the AMI. Defaults to `false`.|
147147
| `aws_ec2_instance_type` | String | The AWS IAM instance type to use. Default is `t2.small`. See [this list](https://aws.amazon.com/ec2/instance-types/) for reference. |
148148
| `aws_ec2_instance_root_vol_size` | Integer | Define the volume size (in GiB) for the root volume on the AWS Instance. Defaults to `8`. |
149149
| `aws_ec2_instance_root_vol_preserve` | Boolean | Set this to true to avoid deletion of root volume on termination. Defaults to `false`. |
150150
| `aws_ec2_security_group_name` | String | The name of the EC2 security group. Defaults to `SG for ${aws_resource_identifier} - EC2`. |
151151
| `aws_ec2_iam_instance_profile` | String | The AWS IAM instance profile to use for the EC2 instance. Will create one if none provided with the name`${GITHUB_ORG_NAME}-${GITHUB_REPO_NAME}-${GITHUB_BRANCH_NAME}`. |
152-
| `aws_ec2_create_keypair_sm` | Boolean | Generates and manage a secret manager entry that contains the public and private keys created for the ec2 instance. |
152+
| `aws_ec2_create_keypair_sm` | Boolean | Generates and manages a secret manager entry that contains the public and private keys created for the ec2 instance. |
153153
| `aws_ec2_instance_public_ip` | Boolean | Add a public IP to the instance or not. (Not an Elastic IP). |
154154
| `aws_ec2_port_list` | String | Comma separated list of ports to be enabled in the EC2 instance security group. (NOT THE ELB) In a `xx,yy` format. |
155155
| `aws_ec2_user_data_file` | String | Relative path in the repo for a user provided script to be executed with Terraform EC2 Instance creation. See [this note](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html#user-data-shell-scripts) |
@@ -191,7 +191,7 @@ The following inputs can be used as `step.with` keys
191191
#### **Load Balancer Inputs**
192192
| Name | Type | Description |
193193
|------------------|---------|------------------------------------|
194-
| `aws_elb_create` | Boolean | Set this to true to create a load balancer and map ports to the EC2 instance.'|
194+
| `aws_elb_create` | Boolean | Toggles the creation of a load balancer and map ports to the EC2 instance.|
195195
| `aws_elb_security_group_name` | String | The name of the ELB security group. Defaults to `SG for ${aws_resource_identifier} - ELB`. |
196196
| `aws_elb_app_port` | String | Port in the EC2 instance to be redirected to. Default is `3000` |
197197
| `aws_elb_app_protocol` | String | Protocol to enable. Could be HTTP, HTTPS, TCP or SSL. Defaults to TCP. |
@@ -205,18 +205,18 @@ The following inputs can be used as `step.with` keys
205205
#### **EFS Inputs**
206206
| Name | Type | Description |
207207
|------------------|---------|------------------------------------|
208-
| `aws_efs_create` | Boolean | Toggle to indicate whether to create and EFS and mount it to the ec2 as a part of the provisioning. Note: The EFS will be managed by the stack and will be destroyed along with the stack |
209-
| `aws_efs_create_ha` | Boolean | Toggle to indicate whether the EFS resource should be highly available (target mounts in all available zones within region) |
208+
| `aws_efs_create` | Boolean | Toggle to indicate whether to create an EFS and mount it to the ec2 as a part of the provisioning. Note: The stack will manage the EFS and will be destroyed along with the stack. |
209+
| `aws_efs_create_ha` | Boolean | Toggle to indicate whether the EFS resource should be highly available (target mounts in all available zones within a region). |
210210
| `aws_efs_fs_id` | String | ID of existing EFS. |
211211
| `aws_efs_vpc_id` | String | ID of the VPC for the EFS mount target. If aws_efs_create_ha is set to true, will create one mount target per subnet available in the VPC. If not, will create one in an automated selected region. |
212212
| `aws_efs_subnet_ids` | String | ID (or ID's) of the subnet for the EFS mount target. (Comma separated string.) |
213213
| `aws_efs_security_group_name` | String | The name of the EFS security group. Defaults to `SG for ${aws_resource_identifier} - EFS`. |
214-
| `aws_efs_create_replica` | Boolean | Toggle to indiciate whether a read-only replica should be created for the EFS primary file system |
214+
| `aws_efs_create_replica` | Boolean | Toggle whether a read-only replica should be created for the EFS primary file system |
215215
| `aws_efs_replication_destination` | String | AWS Region to target for replication. |
216-
| `aws_efs_enable_backup_policy` | Boolean | Toggle to indiciate whether the EFS should have a backup policy |
216+
| `aws_efs_enable_backup_policy` | Boolean | Toggle whether the EFS should have a backup policy. |
217217
| `aws_efs_transition_to_inactive` | String | Indicates how long it takes to transition files to the IA storage class. |
218218
| `aws_efs_mount_target` | String | Directory path in efs to mount directory to. Default is `/`. |
219-
| `aws_efs_ec2_mount_point` | String | The aws_efs_ec2_mount_point input represents the folder path within the EC2 instance to the data directory. Default is `/user/ubuntu/<application_repo>/data`. Additionally this value is loaded into the docker-compose `.env` file as `HOST_DIR`. |
219+
| `aws_efs_ec2_mount_point` | String | The aws_efs_ec2_mount_point input represents the folder path within the EC2 instance to the data directory. Default is `/user/ubuntu/<application_repo>/data`. Additionally, this value is loaded into the docker-compose `.env` file as `HOST_DIR`. |
220220
| `aws_efs_additional_tags` | JSON | Add additional tags to the terraform [default tags](https://www.hashicorp.com/blog/default-tags-in-the-terraform-aws-provider), any tags put here will be added to efs provisioned resources.|
221221
<hr/>
222222
<br/>
@@ -265,7 +265,7 @@ The following inputs can be used as `step.with` keys
265265
| `aws_aurora_snapshot_name` | String | Specify a database name. Will be created if it does not exist. Won't overwrite. |
266266
| `aws_aurora_snapshot_overwrite` | Boolean | Set to true to overwrite the snapshot. |
267267
| `aws_aurora_database_protection` | Boolean | Protects the database from deletion. Default is `false`.|
268-
| `aws_aurora_database_final_snapshot` | Boolean | Creates a snapshot before deletion. If a string is passed, it will be used as snapsthot name. Defaults to `false`.|
268+
| `aws_aurora_database_final_snapshot` | Boolean | Creates a snapshot before deletion. If a string is passed, it will be used as the snapsthot name. Defaults to `false`.|
269269
| `aws_aurora_additional_tags` | JSON | Add additional tags to the terraform [default tags](https://www.hashicorp.com/blog/default-tags-in-the-terraform-aws-provider), any tags put here will be added to aurora provisioned resources.|
270270
<hr/>
271271
<br/>

operations/_scripts/generate/generate_bitops_config.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ bitops:
192192
add_ansible_module efs
193193
fi
194194
# Ansible - Install CloudWatch
195-
if [[ $(alpha_only "$DOCKER_CLOUDWATCH_ENABLE") == true ]]; then
195+
if [[ $(alpha_only "$DOCKER_CLOUDWATCH_ENABLE") == true ]] && [[ $(alpha_only "$DOCKER_INSTALL") == true ]]; then
196196
add_ansible_module cloudwatch
197197
fi
198198
# Ansible - Install Docker

0 commit comments

Comments
 (0)