AWS ECS - Temporal Deployment

A temporal deployment tool which lets you setup , deploy and get your temporal service running on ECS in few minutes. This tool deploys Temporal Server , RDS , OpenSearch and Temporal UI. AWS Copilot is used to do the deployment part.

Getting Started 📌

• Pre - requisites 📝
  • You need to have AWS Copilot setup in order to make the script work. If you haven't done it already, go through this.
• Once you have all things in place , clone this repo and open it in any of your favourite IDE.
• Make sure you are in the root directory of the project, this is where you will execute the next steps.
• Run this command to give the execution permission to the script's. chmod +x setup-temporal.sh update-temporal.sh
• Run the script ./setup-temporal.sh serverName uiName envName
• When prompted by copilot init Would you like to deploy a test environment?
  • Enter N (We will create our on env for deployment)
• Have a 🍿 and watch the things being deployed 🚀

All about the script 🪄

./setup-temporal.sh will take in three arguments and all are mandatory. serverName uiName envName are the arguments that are required.

• Server Name - Specify the name that you want the temporal app and service to be called with. Don't worry about the naming conventions , we will add suffix to the names correctly.

  serverName-app will be the app name.

  serverName-svc will be the service name.

• UI Name - Specify the name that you want the temporal ui server to be called with. Again , we will take care of the naming conventions 😉

  uiName-svc will be the service name

• Env Name - Specify the name for the environment which you want all the services to be deployed. And for the suffix - We Don't Do That Here

Setting up your temporal workflow.

Considering that you have some idea about temporal , let's see how you can use the deployed Temporal servers within your existing workflow and workers. Incase you are new to temporal, you should consider going through temporal first.

When the temporal server is deployed you will get a link on the terminal , you will need this link to point your workflow to the server.

Grab the link and pass it to your WorkflowServiceStubs -

WorkflowServiceStubs service = WorkflowServiceStubs.newServiceStubs(  
    WorkflowServiceStubsOptions.newBuilder().setTarget("urlToTemporal:7233").build()  
    );

Also if you launch all the services in the same VPC (which is the case with the current deployment) you can simply use the service discovery url's which will always be {service_name}.{env_name}.{app_name}.local.

You can read more about copilot service discovery over here.

When the UI server is deployed you will get another link , this link will be used to see the dashboard for your workflow details.

Deploy in existing ECS Cluster

You already have an ECS application in place? No problem ./existing-temporal.sh script will help you setup temporal in your cluster.

This script considers you have already deployed app and env using copilot, so it requires 4 arguments to run and they are same as the setup script except the 4th one is the app name that you want the temporal service to be in. ./existing-temporal.sh serverName uiName envName appName

This script will still create a seprate rds for temporal, if you want to use the exisiting rds to then you will have to edit existing-temporal.sh to not copy the database-cluster.yml file and edit the secrets in base\serverManifest.yml and pass your db details.

Enable auto-scaling

To enable auto-scaling uncomment the code given in base\serverManifest.yml from line 24 and edit accordingly. For more details on auto-scaling parameters refer this link here

Update Script

./update-temporal.sh is all you need whenever you want to deploy any changes to the current ECS Infrastructure. It also requires 3 arguments to run and they are same as the setup script. As AWS Copilot is being used under the hood , only if there are any changes; the script will deploy them or else it wont do any unnecessary deployment.

./update-temporal.sh serverName uiName envName

Similary, to update temporal service deployed inside an exsiting ecs use ./update-existing-temporal.sh serverName uiName envName appName

To know more about the script or for detailed tutorial please visit the blogpost.

PS- Remember the basic's Be in the root folder to run this script as well 😄