feat: aws_url paramater (#288)

* chore: commit to create new remote branch

* feat: aws_domain parameter (#286)

* fix: add aws_domain parameter to job

* refactor: env subst

---------

Co-authored-by: John <[email protected]>

Author: brivu

src/commands/build_and_push_image.yml

@@ -179,6 +179,13 @@ parameters:
     default: ""
     description: |
       The path to the .json file containing the repository policy to be applied to a specified repository in AWS ECR.
+  aws_domain:
+    type: string
+    default: "amazonaws.com"
+    description: >
+      The AWS domain for your region, e.g in China, the AWS domain is amazonaws.com.cn
+      The default value is amazonaws.com
+
   auth:
     description: |
       The authentication method used to access your AWS account. Import the aws-cli orb in your config and
@@ -255,3 +262,4 @@ steps:
       lifecycle_policy_path: <<parameters.lifecycle_policy_path>>
       public_registry_alias: <<parameters.public_registry_alias>>
       build_path: <<parameters.build_path>>
+      aws_domain: <<parameters.aws_domain>>

src/commands/build_image.yml

@@ -98,6 +98,13 @@ parameters:
       buildx builders to be saved with Docker Layer Caching, the builder must explicitly be named.
       Specify the a builder name with this parameter. This parameter defaults to "default-builder" if none is provided.
 
+  aws_domain:
+    type: string
+    default: "amazonaws.com"
+    description: >
+      The AWS domain for your region, e.g in China, the AWS domain is amazonaws.com.cn
+      The default value is amazonaws.com
+
 steps:
   - run:
       name: Build Docker Image with buildx
@@ -117,5 +124,6 @@ steps:
         ORB_STR_LIFECYCLE_POLICY_PATH: <<parameters.lifecycle_policy_path>>
         ORB_STR_PUBLIC_REGISTRY_ALIAS: <<parameters.public_registry_alias>>
         ORB_EVAL_BUILD_PATH: <<parameters.build_path>>
+        ORB_STR_AWS_DOMAIN: <<parameters.aws_domain>>
       command: <<include(scripts/docker_buildx.sh)>>
       no_output_timeout: <<parameters.no_output_timeout>>

src/commands/ecr_login.yml

@@ -27,6 +27,12 @@ parameters:
     description: Set to true if building and pushing an image to a Public Registry on ECR.
     default: false
 
+  aws_domain:
+    type: string
+    default: "amazonaws.com"
+    description: >
+      AWS domain, China regions will require override.
+
 steps:
   - run:
       name: Log into Amazon ECR with profile <<parameters.profile_name>>
@@ -35,4 +41,5 @@ steps:
         ORB_ENV_REGISTRY_ID: <<parameters.registry_id>>
         ORB_STR_REGION: <<parameters.region>>
         ORB_BOOL_PUBLIC_REGISTRY: <<parameters.public_registry>>
+        ORB_STR_AWS_DOMAIN: <<parameters.aws_domain>>
       command: <<include(scripts/ecr_login.sh)>>

src/commands/push_image.yml

@@ -30,6 +30,11 @@ parameters:
     description: >
       The public registry alias for your public repositories. This parameter is required if pushing to a public repository
       It can be found in the Amazon ECR console > Public Registries.
+  aws_domain:
+    type: string
+    default: "amazonaws.com"
+    description: >
+      AWS domain, China regions will require override.
 steps:
   - run:
       name: Push image to AWS ECR
@@ -40,4 +45,5 @@ steps:
         ORB_BOOL_PUBLIC_REGISTRY: <<parameters.public_registry>>
         ORB_STR_PUBLIC_REGISTRY_ALIAS: <<parameters.public_registry_alias>>
         ORB_ENV_REGISTRY_ID: << parameters.registry_id >>
+        ORB_STR_AWS_DOMAIN: <<parameters.aws_domain>>
       command: << include(scripts/push_image.sh) >>

src/jobs/build_and_push_image.yml

@@ -189,6 +189,12 @@ parameters:
       provide the aws-cli/setup command to authenticate with your preferred method. View examples for more information.
     type: steps
 
+  aws_domain:
+    type: string
+    default: "amazonaws.com"
+    description: >
+      AWS domain, China regions will require override.
+
 steps:
   - build_and_push_image:
       registry_id: <<parameters.registry_id>>
@@ -221,3 +227,4 @@ steps:
       repo_policy_path: <<parameters.repo_policy_path>>
       build_path: <<parameters.build_path>>
       auth: <<parameters.auth>>
+      aws_domain: <<parameters.aws_domain>>

src/scripts/docker_buildx.sh

@@ -3,7 +3,8 @@ ORB_STR_REGION="$(circleci env subst "${ORB_STR_REGION}")"
 ORB_STR_REPO="$(circleci env subst "${ORB_STR_REPO}")"
 ORB_STR_TAG="$(circleci env subst "${ORB_STR_TAG}")"
 ORB_EVAL_PATH="$(eval echo "${ORB_EVAL_PATH}")"
-ORB_VAL_ACCOUNT_URL="${!ORB_ENV_REGISTRY_ID}.dkr.ecr.${ORB_STR_REGION}.amazonaws.com"
+ORB_STR_AWS_DOMAIN="$(echo "${ORB_STR_AWS_DOMAIN}" | circleci env subst)"
+ORB_VAL_ACCOUNT_URL="${!ORB_ENV_REGISTRY_ID}.dkr.ecr.${ORB_STR_REGION}.${ORB_STR_AWS_DOMAIN}"
 ORB_STR_PUBLIC_REGISTRY_ALIAS="$(circleci env subst "${ORB_STR_PUBLIC_REGISTRY_ALIAS}")"
 ORB_STR_EXTRA_BUILD_ARGS="$(echo "${ORB_STR_EXTRA_BUILD_ARGS}" | circleci env subst)"
 ORB_EVAL_BUILD_PATH="$(eval echo "${ORB_EVAL_BUILD_PATH}")"

src/scripts/ecr_login.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 ORB_STR_REGION="$(circleci env subst "${ORB_STR_REGION}")"
 ORB_STR_PROFILE_NAME="$(circleci env subst "${ORB_STR_PROFILE_NAME}")"
-ORB_VAL_ACCOUNT_URL="${!ORB_ENV_REGISTRY_ID}.dkr.ecr.${ORB_STR_REGION}.amazonaws.com"
+ORB_VAL_ACCOUNT_URL="${!ORB_ENV_REGISTRY_ID}.dkr.ecr.${ORB_STR_REGION}.${ORB_STR_AWS_DOMAIN}"
 ECR_COMMAND="ecr"
 
 if [ -z "${!ORB_ENV_REGISTRY_ID}" ]; then

src/scripts/push_image.sh

@@ -2,7 +2,7 @@
 ORB_STR_REPO="$(circleci env subst "${ORB_STR_REPO}")"
 ORB_STR_TAG="$(circleci env subst "${ORB_STR_TAG}")"
 ORB_STR_REGION="$(circleci env subst "${ORB_STR_REGION}")"
-ORB_VAL_ACCOUNT_URL="${!ORB_ENV_REGISTRY_ID}.dkr.ecr.${ORB_STR_REGION}.amazonaws.com"
+ORB_VAL_ACCOUNT_URL="${!ORB_ENV_REGISTRY_ID}.dkr.ecr.${ORB_STR_REGION}.${ORB_STR_AWS_DOMAIN}"
 ORB_STR_PUBLIC_REGISTRY_ALIAS="$(circleci env subst "${ORB_STR_PUBLIC_REGISTRY_ALIAS}")"
 
 if [ -z "${!ORB_ENV_REGISTRY_ID}" ]; then