Deploying CloudFormation stack on API Task AWS VPC

The AWS CloudFormation stack enables you to create necessary infrastructure resources in the API Task AWS account that serves as the runtime environment. Use the custom CloudFormation template to create and deploy the AWS CloudFormation stack on the API Task AWS account VPC.

Create and deploy the AWS CloudFormation stack using the custom CloudFormation template in your API Task AWS account console. When you deploy the CloudFormation stack, the stack creates necessary resources and outputs that enable the Control Room installer to query and sync with the API Task AWS account. If required, you can also update the stack parameters as per your organizational requirements.

Prerequisites

Ensure that you meet the following requirements:

Procedure

  1. Log in to the API Task AWS console as an administrator.
  2. Go to the CloudFormation console, and click Create stack.
  3. Configure the following parameters in the Create stack page:
    1. Select Choose an existing template in Prerequisite - Prepare template section.
    2. Select Upload a template file, and click Choose file in Specify template section
    3. Select the downloaded CloudFormation template file and click Next.
      The S3 URL automatically generates from the uploaded file.
  4. Configure the following parameters in the Specify stack details page:
    1. Enter api-task-onprem in Stack name.
      Note: Ensure that you enter the exact stack name as this stack name is hardcoded in the installer.
    2. Enter the CIDR block of private IP addresses that you must use with the subnets associated with the API Task AWS VPC in ApiTaskSubnetCidr.
    3. Enter the ARN of the sub-domain certificate that you created in AWS Certificate Manager (ACM) of the API Task AWS account.
    4. Enter the account ID of the Control Room AWS account in ControlRoomAWSAccountId.
      This setting enables you to connect the Control Room AWS account to the API Task AWS for VPC peering.
    5. Enter the CIDR of the Control Room AWS account in ControlRoomVPCCidr.
      This setting whitelists the CIDR blocks associated with the Control Room AWS VPC.
    6. Enter the domain name associated with the API Task AWS account sub-domain certificate in Domain.
    7. Enter the CIDR block associated with the Kubernetes service in KubernetesServerCidr.
      The template file auto-populates this field. You can retain this value if it does not overlap with other previously configured CIDR blocks.
    8. Click Next.
  5. Configure the following parameters in Configure stack options page:
    1. Select Preserve successfully provisioned resources option in the Stack failure options section.
      The Preserve successfully provisioned resources option enables you to debug and troubleshoot in case of any deployment failures.
      Note: The Use deletion policy option is the default selection in Delete newly created resources during a rollback.
    2. Select the I acknowledge that AWS CloudFormation might create IAM resources with custom names check box, and click Next .
  6. Review the details of the CloudFormation template, and then click Submit.
    CloudFormation starts to create the stack with all the resources defined in the template
The Stacks dashboard of the CloudFormation console displays the new stack. You can view the resources you created in the Resources tab, and the settings that the Control Room installer queries in the Output tab. If required, you can use the Update stack option to modify the configured parameters based on your organizational requirements.