Merge pull request #47 from bitovi/enh/var-renames

Var renames to be consistent with the `tf_` and `aws_` groups

Author: arm4b

README.md

@@ -68,22 +68,22 @@ The following inputs can be used as `steps.with` keys:
 | **AWS configuration** |
 | `aws_access_key_id` | string | | AWS access key ID (Required) |
 | `aws_secret_access_key` | string | | AWS secret access key (Required) |
-| `aws_session_token` | string | | AWS session token |
+| `aws_session_token` | string | | AWS session token, if you're using temporary credentials |
 | `aws_default_region` | string | `us-east-1` | AWS default region (Required) |
-| `ec2_instance_type` | string | `t2.medium` | The AWS EC2 instance type. |
-| `ec2_instance_profile` | string | | [The AWS IAM instance profile](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) to use for the EC2 instance. Use if you want to pass an AWS role with specific permissions granted to the instance |
-| `aws_resource_identifier` | string | `${org}-{repo}-{branch}` | Auto-generated by default so it's unique for org/repo/branch. Set to override with custom naming the unique AWS resource identifier for the deployment. |
+| `aws_ec2_instance_type` | string | `t2.medium` | The AWS EC2 instance type. |
+| `aws_ec2_instance_profile` | string | | [The AWS IAM instance profile](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) to use for the EC2 instance. Use if you want to pass an AWS role with specific permissions granted to the instance |
+| `aws_resource_identifier` | string | `${org}-${repo}-${branch}` | Auto-generated by default so it's unique for org/repo/branch. Set to override with custom naming the unique AWS resource identifier for the deployment. |
 | `aws_create_vpc` | bool | `false` | Whether an AWS VPC should be created in the action. Otherwise, the existing default VPC will be used. |
-| `infrastructure_only` | bool | `false` | Does infrastructure (i.e. terraform) but **not** the deployment (i.e. ansible) |
+| `infrastructure_only` | bool | `false` | Set to true to provision infrastructure (with Terraform) but skip the app deployment (with ansible) |
 | **Teraform configuration** |
-| `tf_state_bucket` | string | `${org}-${repo}-{branch}-tf-state` | AWS S3 bucket to use for Terraform state. By default, a new deployment will be created for each unique branch. Hardcode if you want to keep a shared resource state between the several branches. |
+| `tf_state_bucket` | string | `${org}-${repo}-${branch}-tf-state` | AWS S3 bucket to use for Terraform state. By default, a new deployment will be created for each unique branch. Hardcode if you want to keep a shared resource state between the several branches. |
 | **StackStorm configuration** |
 | `st2_auth_username` | string | | Username used by StackStorm standalone authentication. Set as a secret in GH Actions. |
 | `st2_auth_password` | string | | Password used by StackStorm standalone authentication. Set as a secret in GH Actions. |
 | `st2_packs` | string |`"st2"` | Comma separated list of packs to install. If you modify this option, be sure to also include `st2` in the list. |
 | **Cleanup** |
-| `stack_destroy` | bool | `false` | Set to `true` to Destroy the created AWS infrastructure for this instance |
-| `tf_state_bucket_destroy` | bool | `false` | Force purge and deletion of `tf_state_bucket` defined. Any file contained there will be destroyed. `stack_destroy` must also be `true`. Use if you want to clean up the resources |
+| `tf_stack_destroy` | bool | `false` | Set to `true` to Destroy the created AWS infrastructure for this instance |
+| `tf_state_bucket_destroy` | bool | `false` | Force purge and deletion of `tf_state_bucket` defined. Any file contained there will be destroyed. `tf_stack_destroy` must also be `true` |
 
 
 ## Note about AWS resource identifiers

action.yaml

@@ -7,65 +7,63 @@ inputs:
   checkout:
     description: 'Specifies if this action should checkout the code'
     required: false
-    default: 'true'
+    default: "true"
+
+  # AWS Configuration
   aws_access_key_id:
     description: 'AWS access key ID'
     required: true
   aws_secret_access_key:
     description: 'AWS secret access key'
     required: true
   aws_session_token:
-    description: 'AWS session token'
+    description: "AWS session token, if you're using temporary credentials"
     required: false
   aws_default_region:
     description: 'AWS default region'
     required: true
-    default: 'us-east-1'
-  tf_state_bucket:
-    description: 'AWS S3 bucket to use for Terraform state. Defaults to `${org}-${repo}-{branch}-tf-state`'
-    required: false
-  tf_state_bucket_destroy:
-    description: 'Force purge and deletion of S3 bucket defined. Any file contained there will be destroyed `stack_destroy` must also be `true`'
-    required: false
-    default: 'false'
-  ec2_instance_profile:
-    description: 'The AWS IAM instance profile to use for the EC2 instance'
-  ec2_instance_type:
-    description: 'The AWS EC2 instance type. Default is "t2.medium"'
-  stack_destroy:
-    description: 'Set to "true" to Destroy the stack'
+    default: us-east-1
+  aws_ec2_instance_type:
+    description: 'The AWS EC2 instance type'
+    default: t2.medium
+  aws_ec2_instance_profile:
+    description: 'The AWS IAM instance profile to use for the EC2 instance. Use if you want to pass an AWS role with specific permissions granted to the instance'
   aws_resource_identifier:
-    description: 'Set to override the AWS resource identifier for the deployment.  Defaults to `${org}-{repo}-{branch}`.  Use with destroy to destroy specific resources.'
-  # domain_name:
-  #   description: 'Define the root domain name for the application. e.g. app.com'
-  #   required: true
-  # create_domain:
-  #   description: "Bool, whether the domain should be created in the action. Default is false"
-  #   default: false
-  # sub_domain:
-  #   description: 'Define the sub-domain part of the URL. Defaults to `${org}-${repo}-{branch}`'
-  # create_hosted_zone:
-  #   description: "Bool, whether the hosted zone should be created in the action. Default is false"
-  #   default: false
+    description: "Auto-generated by default so it's unique for org/repo/branch. Set to override with custom naming the unique AWS resource identifier for the deployment. Defaults to `${org}-${repo}-${branch}`."
   aws_create_vpc:
-    description: "Bool, whether an AWS VPC should be created in the action. Default is false"
-    default: false
+    description: 'Bool, whether an AWS VPC should be created in the action. Otherwise, the existing default VPC will be used.'
+    default: "false"
   infrastructure_only:
-    description: "Bool, does infrastructure (i.e. terraform) but **not** the deployment (i.e. ansible) . Default is false"
-    default: false
+    description: 'Set to true to provision infrastructure (with Terraform) but skip the app deployment (with ansible)'
+    default: "false"
 
+  # Terraform configuration
+  tf_state_bucket:
+    description: 'AWS S3 bucket to use for Terraform state. Defaults to `${org}-${repo}-${branch}-tf-state`'
+    required: false
 
-  # ST2 config
+  # StackStorm configuration
   st2_auth_username:
-    description: Username used by StackStorm standalone authentication
+    description: 'Username used by StackStorm standalone authentication. Set as a secret in GH Actions.'
+    required: true
   st2_auth_password:
-    description: Password used by StackStorm standalone authentication
+    description: 'Password used by StackStorm standalone authentication. Set as a secret in GH Actions.'
+    required: true
   st2_packs:
-    description: String. Comma separated list of packs to install. This flag does not work with a --python3 only pack. (default `"st2"`). If you modify this option, be sure to also include `st2` in the list.
+    description: 'Comma separated list of packs to install. If you modify this option, be sure to also include `st2` in the list.'
     default: "st2"
+  
+  # Cleanup
+  tf_stack_destroy:
+    description: 'Set to "true" to Destroy the created AWS infrastructure for this instance'
+    default: "false"
+  tf_state_bucket_destroy:
+    description: 'Force purge and deletion of tf_state_bucket defined. Any file contained there will be destroyed. tf_stack_destroy must also be true.'
+    default: "false"
+
 outputs:
   lb_url:
-    description: "The URL of the generated app"
+    description: 'The URL of the generated app'
     value: ${{ steps.deploy.outputs.lb_url }}
 
 runs:
@@ -89,21 +87,16 @@ runs:
         TF_STATE_BUCKET_DESTROY: ${{ inputs.tf_state_bucket_destroy }}
 
         APP_PORT: ${{ inputs.app_port }}
-        EC2_INSTANCE_PROFILE: ${{ inputs.ec2_instance_profile }}
-        EC2_INSTANCE_TYPE: ${{ inputs.ec2_instance_type }}
-        STACK_DESTROY: ${{ inputs.stack_destroy }}
+        EC2_INSTANCE_PROFILE: ${{ inputs.aws_ec2_instance_profile }}
+        EC2_INSTANCE_TYPE: ${{ inputs.aws_ec2_instance_type }}
+        STACK_DESTROY: ${{ inputs.tf_stack_destroy }}
         AWS_RESOURCE_IDENTIFIER: ${{ inputs.aws_resource_identifier }}
-        # DOMAIN_NAME: ${{ inputs.domain_name }}
-        # CREATE_DOMAIN: ${{ inputs.CREATE_DOMAIN }}
-        # SUB_DOMAIN: ${{ inputs.sub_domain }}
-        # CREATE_HOSTED_ZONE: ${{ inputs.CREATE_HOSTED_ZONE }}
-
         CREATE_VPC: ${{ inputs.aws_create_vpc }}
 
         # Skip ansible deployment if deploying only infrastructure
         ANSIBLE_SKIP_DEPLOY: ${{ inputs.infrastructure_only }}
 
-        BITOPS_FAST_FAIL: true
+        BITOPS_FAST_FAIL: "true"
 
         # ST2 config
         ST2_AUTH_USERNAME: ${{ inputs.st2_auth_username }}