Tip
To deploy this project using GUI-based flow, navigate to console
- simple Websocket API built using Socket.io.
- The application runs in a container workload and uses Upstash redis to store the session data. The requests are routed using Application Load Balancer.
- This project includes a pre-configured stacktape.yml configuration. The configured infrastructure is described in the stack description section
-
Fixed price resources:
- Container workload (~$0.012/hour, ~$9/month)
-
There are also other resources that might incur costs (with pay-per-use pricing). If your load won't get high, these costs will be close to $0.
-
AWS account. If you don't have one, create new account here.
-
Stacktape account. If you don't have one, create new account here.
-
Stacktape installed.
Install on Windows (Powershell)
iwr https://installs.stacktape.com/windows.ps1 -useb | iexInstall on Linux
curl -L https://installs.stacktape.com/linux.sh | shInstall on MacOS
curl -L https://installs.stacktape.com/macos.sh | shInstall on MacOS ARM (Apple silicon)
curl -L https://installs.stacktape.com/macos-arm.sh | sh- Upstash account. If you don't have one, create new account here.
To initialize the project, use
stacktape init --starterId socketio-websocket-api-redis- Fill in your Upstash credentials in the
providerConfig.upstashsection of the stacktape.yml config file. You can get your API key in the Upstash console.
The deployment will take ~5-15 minutes. Subsequent deploys will be significantly faster.
Deploy from local machine
The deployment from local machine will build and deploy the application from your system. This means you also need to have:
- Docker. To install Docker on your system, you can follow this guide.- Node.js installed.
To perform the deployment, use the following command:
stacktape deploy --stage <<stage>> --region <<region>>stage is an arbitrary name of your environment (for example staging, production or dev-john)
region is the AWS region, where your stack will be deployed to. All the available regions are listed below.
| Region name & Location | code |
|---|---|
| Europe (Ireland) | eu-west-1 |
| Europe (London) | eu-west-2 |
| Europe (Frankfurt) | eu-central-1 |
| Europe (Milan) | eu-south-1 |
| Europe (Paris) | eu-west-3 |
| Europe (Stockholm) | eu-north-1 |
| US East (Ohio) | us-east-2 |
| US East (N. Virginia) | us-east-1 |
| US West (N. California) | us-west-1 |
| US West (Oregon) | us-west-2 |
| Canada (Central) | ca-central-1 |
| Africa (Cape Town) | af-south-1 |
| Asia Pacific (Hong Kong) | ap-east-1 |
| Asia Pacific (Mumbai) | ap-south-1 |
| Asia Pacific (Osaka-Local) | ap-northeast-3 |
| Asia Pacific (Seoul) | ap-northeast-2 |
| Asia Pacific (Singapore) | ap-southeast-1 |
| Asia Pacific (Sydney) | ap-southeast-2 |
| Asia Pacific (Tokyo) | ap-northeast-1 |
| China (Beijing) | cn-north-1 |
| China (Ningxia) | cn-northwest-1 |
| Middle East (Bahrain) | me-south-1 |
| South America (São Paulo) | sa-east-1 |
Deploy using AWS CodeBuild pipeline
Deployment using AWS CodeBuild will build and deploy your application inside AWS CodeBuild pipeline. To perform the deployment, use
stacktape codebuild:deploy --stage <<stage>> --region <<region>>stage is an arbitrary name of your environment (for example staging, production or dev-john)
region is the AWS region, where your stack will be deployed to. All the available regions are listed below.
| Region name & Location | code |
|---|---|
| Europe (Ireland) | eu-west-1 |
| Europe (London) | eu-west-2 |
| Europe (Frankfurt) | eu-central-1 |
| Europe (Milan) | eu-south-1 |
| Europe (Paris) | eu-west-3 |
| Europe (Stockholm) | eu-north-1 |
| US East (Ohio) | us-east-2 |
| US East (N. Virginia) | us-east-1 |
| US West (N. California) | us-west-1 |
| US West (Oregon) | us-west-2 |
| Canada (Central) | ca-central-1 |
| Africa (Cape Town) | af-south-1 |
| Asia Pacific (Hong Kong) | ap-east-1 |
| Asia Pacific (Mumbai) | ap-south-1 |
| Asia Pacific (Osaka-Local) | ap-northeast-3 |
| Asia Pacific (Seoul) | ap-northeast-2 |
| Asia Pacific (Singapore) | ap-southeast-1 |
| Asia Pacific (Sydney) | ap-southeast-2 |
| Asia Pacific (Tokyo) | ap-northeast-1 |
| China (Beijing) | cn-north-1 |
| China (Ningxia) | cn-northwest-1 |
| Middle East (Bahrain) | me-south-1 |
| South America (São Paulo) | sa-east-1 |
Deploy using Github actions CI/CD pipeline
- If you don't have one, create a new repository at https://github.com/new
- Create Github repository secrets: https://docs.stacktape.com/user-guides/ci-cd/#2-create-github-repository-secrets
- Replace
<<stage>>and<<region>>in the .github/workflows/deploy.yml file. git init --initial-branch=maingit add .git commit -m "setup stacktape project"git remote add origin git@github.com:<<namespace-name>>/<<repo-name>>.gitgit push -u origin main- To monitor the deployment progress, navigate to your github project and select the Actions tab
stage is an arbitrary name of your environment (for example staging, production or dev-john)
region is the AWS region, where your stack will be deployed to. All the available regions are listed below.
| Region name & Location | code |
|---|---|
| Europe (Ireland) | eu-west-1 |
| Europe (London) | eu-west-2 |
| Europe (Frankfurt) | eu-central-1 |
| Europe (Milan) | eu-south-1 |
| Europe (Paris) | eu-west-3 |
| Europe (Stockholm) | eu-north-1 |
| US East (Ohio) | us-east-2 |
| US East (N. Virginia) | us-east-1 |
| US West (N. California) | us-west-1 |
| US West (Oregon) | us-west-2 |
| Canada (Central) | ca-central-1 |
| Africa (Cape Town) | af-south-1 |
| Asia Pacific (Hong Kong) | ap-east-1 |
| Asia Pacific (Mumbai) | ap-south-1 |
| Asia Pacific (Osaka-Local) | ap-northeast-3 |
| Asia Pacific (Seoul) | ap-northeast-2 |
| Asia Pacific (Singapore) | ap-southeast-1 |
| Asia Pacific (Sydney) | ap-southeast-2 |
| Asia Pacific (Tokyo) | ap-northeast-1 |
| China (Beijing) | cn-north-1 |
| China (Ningxia) | cn-northwest-1 |
| Middle East (Bahrain) | me-south-1 |
| South America (São Paulo) | sa-east-1 |
Deploy using Gitlab CI pipeline
- If you don't have one, create a new repository at https://gitlab.com/projects/new
- Create Gitlab repository secrets: https://docs.stacktape.com/user-guides/ci-cd/#2-create-gitlab-repository-secrets
- replace
<<stage>>and<<region>>in the .gitlab-ci.yml file. git init --initial-branch=maingit add .git commit -m "setup stacktape project"git remote add origin git@gitlab.com:<<namespace-name>>/<<repo-name>>.gitgit push -u origin mainTo monitor the deployment progress, navigate to your gitlab project and select CI/CD->jobs
stage is an arbitrary name of your environment (for example staging, production or dev-john)
region is the AWS region, where your stack will be deployed to. All the available regions are listed below.
| Region name & Location | code |
|---|---|
| Europe (Ireland) | eu-west-1 |
| Europe (London) | eu-west-2 |
| Europe (Frankfurt) | eu-central-1 |
| Europe (Milan) | eu-south-1 |
| Europe (Paris) | eu-west-3 |
| Europe (Stockholm) | eu-north-1 |
| US East (Ohio) | us-east-2 |
| US East (N. Virginia) | us-east-1 |
| US West (N. California) | us-west-1 |
| US West (Oregon) | us-west-2 |
| Canada (Central) | ca-central-1 |
| Africa (Cape Town) | af-south-1 |
| Asia Pacific (Hong Kong) | ap-east-1 |
| Asia Pacific (Mumbai) | ap-south-1 |
| Asia Pacific (Osaka-Local) | ap-northeast-3 |
| Asia Pacific (Seoul) | ap-northeast-2 |
| Asia Pacific (Singapore) | ap-southeast-1 |
| Asia Pacific (Sydney) | ap-southeast-2 |
| Asia Pacific (Tokyo) | ap-northeast-1 |
| China (Beijing) | cn-north-1 |
| China (Ningxia) | cn-northwest-1 |
| Middle East (Bahrain) | me-south-1 |
| South America (São Paulo) | sa-east-1 |
After a successful deployment, some information about the stack will be printed to the terminal (URLs of the deployed services, links to logs, metrics, etc.).
- This project includes a pre-made test script that creates 100 websocket connections and emits a message to all of them. To run it, use
stacktape script:run --scriptName broadcastTest --stage <<your-previously-deployed-stage>> --region <<your-previously-used-region>>To run a container in the development mode (locally on your machine), you can use the dev command.
stacktape dev --region <<your-region>> --stage <<stage>> --resourceName websocketServer --container socketio-serverStacktape runs the container as closely to the deployed version as possible:
- Maps all of the container ports specified in the
eventssection to the host machine. - Injects parameters referenced in the environment variables by
$ResourceParamand$Secretdirectives to the running container. - Injects credentials of the assumed role to the container. This means that your locally running container will have the exact same IAM permissions as the deployed version.
- Pretty-prints logs (stdout/stderr) produced by the container to the terminal.
The container is rebuilt and restarted, when you either:
- type
rs + enterto the terminal - use the
--watchoption and one of your source code files changes
-
Stacktape deployments use AWS CloudFormation under the hood. It brings a lot of guarantees and convenience, but can be slow for certain use-cases.
-
To speed up the deployment, you can use the
--hotSwapflag that avoids Cloudformation. -
Hotswap deployments work only for source code changes (for lambda function, containers and batch jobs) and for content uploads to buckets.
-
If the update deployment is not hot-swappable, Stacktape will automatically fall back to using a Cloudformation deployment.
stacktape deploy --hotSwap --stage <<stage>> --region <<region>>- If you no longer want to use your stack, you can delete it.
- Stacktape will automatically delete every infrastructure resource and deployment artifact associated with your stack.
stacktape delete --stage <<stage>> --region <<region>>Stacktape uses a simple stacktape.yml configuration file to describe infrastructure resources, packaging, deployment
pipeline and other aspects of your project.
You can deploy your project to multiple environments (stages) - for
example production, staging or dev-john. A stack is a running instance of an project. It consists of your application
code (if any) and the infrastructure resources required to run it.
The configuration for this project is described below.
- Every resource must have an arbitrary, alphanumeric name (A-z0-9).
- Stacktape resources consist of multiple underlying AWS or 3rd party resources.
The application load balancer is responsible for maintaining and balancing websocket connections established between clients and the containers.
If there are multiple containers(i.e your workload scales) load balancer distributes connections evenly among these containers.
You can configure more properties on your load balancer, including using custom domain names or enabling TLS. In this example, we are using the default setup.
resources:
mainLoadBalancer:
type: application-load-balancerThe application uses Upstash serverless Redis database. It is used by Socket.IO adapter to synchronize when scaling to multiple Socket.IO container instances.
In this example, we are configuring redis to use tls. You can also configure
other properties if desired.
redis:
type: upstash-redis
properties:
enableTls: trueSocket.IO server runs inside a container workload with a single container. The workload is configured as follows:
- Container. This container
workload uses only a single container:
socketio-server. The container is configured as follows:- Packaging - determines how the Docker container image is built. The easiest and most optimized way to build the
image for a Typescript application is using
stacktape-image-buildpack. We only need to configureentryfilePath. Stacktape automatically transpiles and builds the application code with all of its dependencies, builds the Docker image, and pushes it to a pre-created image repository on AWS. You can also use other types of packaging. - ConnectTo list - we are adding redis database
redisintoconnectTolist. By doing this, Stacktape will automatically inject relevant environment variables into the compute resource's runtime (such as redis connection url required for connecting to database) - Events that reach the container. Load balancer event is configured to forward all incoming connections with path
/(used for load balancer healthcheck) or/websockets*(used for websocket connection) to the container's port3000.
- Packaging - determines how the Docker container image is built. The easiest and most optimized way to build the
image for a Typescript application is using
- Resources. Resources are shared
between containers of container workload (in this case, we only have one container). The cheapest available resource
configuration is
0.25of virtual CPU and512MB of RAM. - Scaling. For the purposes of this tutorial we are scaling the workload to two (parallel) instances, to showcase the "synchronization" through redis. I.e that all websocket clients receive messages even if they are connected to different containers.
websocketServer:
type: multi-container-workload
properties:
resources:
cpu: 0.25
memory: 512
connectTo:
- redis
containers:
- name: socketio-server
packaging:
type: stacktape-image-buildpack
properties:
entryfilePath: src/server/index.ts
environment:
- name: PORT
value: 3000
events:
- type: application-load-balancer
properties:
containerPort: 3000
loadBalancerName: mainLoadBalancer
priority: 2
paths:
- "/"
- "/websockets*"
scaling:
minInstances: 2
maxInstances: 2To simplify testing of the websocket app, the stacktape config also contains broadcastTest
script.
The purpose of this script is to create multiple websocket client connections (connections are balanced between the 2 socket.io containers):
- One of the clients sends a message.
- After rest of the websockets receive the message, they gracefully disconnect and script exits.
scripts:
broadcastTest:
executeScript: scripts/broadcast-test.ts
environment:
- name: LOAD_BALANCER_DOMAIN
value: $ResourceParam('loadBalancer', 'domain')You can execute the test script after the deploy using
stp script:run --scriptName broadcastTet --stage <<previously-used-stage>> --region <<previously-used-region>>