Merge pull request #3 from tmshkr/update-listener-rules

v4

Author: tmshkr

.env.example

@@ -0,0 +1,27 @@
+AWS_ACCESS_KEY_ID=
+AWS_REGION=
+AWS_SECRET_ACCESS_KEY=
+
+INPUT_APP_NAME="my-app"
+INPUT_BLUE_ENV="my-blue-env"
+INPUT_CREATE_ENVIRONMENT="true"
+INPUT_DEPLOY="true"
+INPUT_DISABLE_TERMINATION_PROTECTION="false"
+INPUT_ENABLE_TERMINATION_PROTECTION="false"
+INPUT_GREEN_ENV="my-green-env"
+INPUT_OPTION_SETTINGS=
+INPUT_PLATFORM_BRANCH_NAME="Docker running on 64bit Amazon Linux 2023"
+INPUT_PRODUCTION_CNAME="my-production-cname"
+INPUT_PROMOTE="true"
+INPUT_SOURCE_BUNDLE=
+INPUT_STAGING_CNAME="my-staging-cname"
+INPUT_TEMPLATE_NAME=
+INPUT_TERMINATE_UNHEALTHY_ENVIRONMENT="true"
+INPUT_UPDATE_ENVIRONMENT="true"
+INPUT_UPDATE_LISTENER_RULES="false"
+INPUT_VERSION_DESCRIPTION=
+INPUT_VERSION_LABEL=
+INPUT_WAIT_FOR_DEPLOYMENT="true"
+INPUT_WAIT_FOR_ENVIRONMENT="true"
+INPUT_WAIT_FOR_TERMINATION="true"
+INPUT_USE_DEFAULT_OPTION_SETTINGS="true"

README.md

@@ -7,41 +7,24 @@ The action will create the following resources:
 - An Elastic Beanstalk application, if it doesn't already exist.
 - An Elastic Beanstalk application version, if it doesn't already exist.
 - An Elastic Beanstalk environment, if it doesn't already exist.
-- An Application Load Balancer, if it doesn't already exist, when using the `shared_alb` strategy.
 
-Based on the provided inputs, the action will determine which environment is the target environment, i.e., the environment to which a new application version should be deployed.
+Based on the provided inputs, the action will determine which environment is the target environment, to which a new application version should be deployed.
 
-## Inputs/Outputs
-
-See [action.yml](action.yml)
-
-## Deployment Strategies
-
-This action supports two blue/green deployment strategies: `swap_cnames` and `shared_alb`.
-
-The default strategy is `swap_cnames`.
-
-### `swap_cnames`
-
-The `swap_cnames` strategy uses the value of the `production_cname` input to determine which environment is the production environment.
-
-If neither the blue or green environments exist, it will create a new environment with the `production_cname` input. If the production environment already exists, the action will target the staging environment, creating it if it doesn't exist.
+The action uses the values of the `production_cname` and `staging_cname` inputs to determine which environment is the production or staging environment. Accordingly, the `production_cname` and `staging_cname` inputs should be set to the CNAME prefix of the production and staging environments, respectively.
 
-The action will then swap the CNAMEs of the staging and production environments if `promote` is set to true.
+If neither environment exists, it will create a new environment with the `production_cname` input. If the production environment already exists, the action will target the staging environment, creating it if it doesn't exist.
 
-### `shared_alb`
+After deploying, the action will swap the CNAMEs of the staging and production environments, if `swap_cnames` is set to true.
 
-The `shared_alb` strategy determines which environment is the production environment by finding the `elasticbeanstalk:environment-id` tag on the associated ALB target groups, which is automatically created by Elastic Beanstalk. If the target groups are not properly tagged, the action will fail.
-
-If neither the blue or green environments exist, it will provision an Application Load Balancer to share between the environments, and then create the production environment. If the production environment already exists, the action will target the staging environment, creating it if it doesn't exist.
-
-When `promote` is set to true, the action will update the default action for each listener on the ALB with a port provided in the `ports` input, so that it forwards to the target group associated with the target environment.
+## Inputs/Outputs
 
-When specifying multiple ports, the action will forward to the target group associated with that port, or else the target group associated with the first port provided, if no target group is associated with the port. For example, if `80,443,3000` is provided as the input, and only ports 80 and 3000 have target groups, the action will forward ports 80 and 443 to the target group for port 80, and port 3000 to the target group for port 3000.
+See [action.yml](action.yml)
 
 ## Terminating Environments
 
-If the action finds that the staging environment is in an unhealthy state, it will be terminated and recreated, unless `terminate_unhealthy_environment` is set to false. The environment should be configured to recreate any associated resources that are deleted during environment termination, so that they are available when it is recreated.
+If the action finds that the target environment is in an unhealthy state, it will be terminated and recreated, unless `terminate_unhealthy_environment` is set to false. The environment should be configured to recreate any associated resources that are deleted during environment termination, so that they are available when it is recreated.
+
+The action will also enable or disable termination protection on the target environment's underlying CloudFormation stack, if `enable_termination_protection` or `disable_termination_protection` are set to true, respectively.
 
 ## Usage
 
@@ -65,7 +48,7 @@ jobs:
       - name: Generate source bundle
         run: zip -r bundle.zip . -x '*.git*'
       - name: Deploy
-        uses: tmshkr/blue-green-beanstalk@v3
+        uses: tmshkr/blue-green-beanstalk@v4
         with:
           app_name: "test-app"
           aws_access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
@@ -76,9 +59,15 @@ jobs:
           green_env: "my-green-env"
           platform_branch_name: "Docker running on 64bit Amazon Linux 2023"
           production_cname: "blue-green-beanstalk-prod"
-          promote: ${{ github.ref_name == 'main' }}
           source_bundle: "bundle.zip"
+          swap_cnames: ${{ github.ref_name == 'main' }}
           staging_cname: "blue-green-beanstalk-staging"
           version_description: ${{ github.event.head_commit.message }}
           version_label: ${{ github.ref_name }}-${{ github.sha }}
 ```
+
+### Using a Shared Load Balancer
+
+When using a [shared load balancer](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environments-cfg-alb-shared.html), the `update_listener_rules` input can be set to true, so that the action will update any listener rules that are tagged with a `bluegreenbeanstalk:target_cname` key, whose value is equal to the `production_cname` or `staging_cname` inputs, so that the listener rule points to the same target group as the CNAME.
+
+To forward to a process on a port besides the default port 80, set another tag on the listener rule with a `bluegreenbeanstalk:target_port` key and a value equal to the port number.

action.yml

@@ -15,8 +15,11 @@ inputs:
   blue_env:
     description: "Name of the blue environment."
     required: true
+  create_environment:
+    description: "Whether to create a new environment during deployment if the target environment doesn't exist."
+    default: "true"
   deploy:
-    description: "Whether to deploy the new application version to the target environment."
+    description: "Whether to deploy to the target environment."
     default: "false"
   disable_termination_protection:
     description: "Whether to disable termination protection for the target environment's CloudFormation stack before attempting to terminate it."
@@ -28,31 +31,33 @@ inputs:
     description: "Name of the green environment."
     required: true
   option_settings:
-    description: "Path to a JSON file of option settings to use when creating a new environment. When using custom option settings, the default option settings will be ignored, but the SharedLoadBalancer will still be provided when using the `shared_alb` strategy."
+    description: "Path to a JSON file consisting of an array of option settings to use when creating a new environment."
   platform_branch_name:
     description: "Name of the platform branch to use. When creating a new environment, it will be launched with the latest version of the specified platform branch. To see the list of available platform branches, run the `aws elasticbeanstalk list-platform-branches` command."
-  prep:
-    description: "When prep is set to true, the action will exit if the target environment is healthy, or create a new environment if it is not healthy. This is useful for preparing the target environment, e.g. with the sample application, before deploying a new application version in a later step."
-    default: "false"
-  ports:
-    description: "Comma-separated list of ALB listener ports for use with the `shared_alb` strategy. When using the action to create an ALB, HTTP listeners will be created for each port. To enable HTTPS, port 443 must be configured on the ALB with ACM. When using an existing ALB, the action will update each specified port's default listener rule to point to the target environment if `promote` is set to true."
-    default: "80"
   production_cname:
-    description: "CNAME prefix for the domain that serves production traffic. Only required for the `swap_cnames` strategy."
-  promote:
-    description: "Whether to promote the target environment to production. When using the `swap_cnames` strategy, the action will swap the CNAMEs of the blue and green environments to redirect production traffic to the target environment. When using the `shared_alb` strategy, the action will update the shared Application Load Balancer's default listener rule to point to the target environment, replacing the other environment."
-    default: "false"
-  staging_cname:
-    description: "CNAME prefix for the staging environment when using the `swap_cnames` strategy."
+    description: "CNAME prefix for the domain that serves production traffic."
+    required: true
   source_bundle:
     description: "Path to the source bundle to deploy. If not specified, the sample application will be used."
-  strategy:
-    description: "Deployment strategy to use: `swap_cnames` or `shared_alb`. See the `promote` input description for more details."
-    default: "swap_cnames"
+  staging_cname:
+    description: "CNAME prefix for the staging environment."
+    required: true
+  swap_cnames:
+    description: "Whether to swap the CNAMEs of the blue and green environments."
+    default: "false"
   template_name:
     description: "Name of an Elastic Beanstalk configuration template to use when creating a new environment."
   terminate_unhealthy_environment:
-    description: "Whether to terminate an unhealthy target environment. If set to false, the action will exit with an error when the target environment is unhealthy."
+    description: "Whether to terminate an unhealthy target environment."
+    default: "true"
+  update_environment:
+    description: "Whether to update an existing environment during deployment."
+    default: "true"
+  update_listener_rules:
+    description: "When set to true, the action will update any elbv2 listener rules on the environments' SharedLoadBalancer tagged with a `bluegreenbeanstalk:target_cname` key, whose value is equal to the staging or production CNAME prefix, so that it forwards to the corresponding target group. The action will also remove any target group from the listener before terminating the environment. The port of the process may be specified by another tag with the key `bluegreenbeanstalk:target_port` whose value is the port number. If no such tag is found, the default port of 80 will be used."
+    default: "false"
+  use_default_option_settings:
+    description: "Whether to use default option settings when creating a new environment."
     default: "true"
   version_description:
     description: "Description to use for the new application version."
@@ -67,9 +72,6 @@ inputs:
   wait_for_termination:
     description: "Whether to wait for an environment to be terminated."
     default: "true"
-  use_default_option_settings:
-    description: "Whether to use default option settings when creating a new environment."
-    default: "true"
 outputs:
   target_env_cname:
     description: "CNAME of the target environment."