Tip
To deploy this project using GUI-based flow, navigate to console
- simple HTTP API built using Flask.
- The application runs in a web service resource and uses a Postgres relational database to store the data.
- This project includes a pre-configured stacktape.yml configuration. The configured infrastructure is described in the stack description section
-
Fixed price resources:
- Relational (SQL) database ($0.017/hour, ~$12.5/month, free-tier eligible)
- Web service (~$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 | shTo initialize the project, use
stacktape init --starterId flask-api-postgres- Install your projects dependencies. The recommended way is to use Virtual environment.
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.- Python version > 3.9 and Poetry package manager 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.).
To test the application, you will need the web service URL. It's printed to the terminal.
Make a POST request to <<web_service_url>>/post with the JSON data in its body to save the post. Use your preferred HTTP client or
the following cURL command:
curl -X POST <<web_service_url>>/posts -H 'content-type: application/json' -d '{ "title": "MyPost", "content": "Hello!", "authorEmail": "info@stacktape.com"}'If the above cURL command did not work, try escaping the JSON content:
curl -X POST <<web_service_url>>/posts -H 'content-type: application/json' -d '{ \"title\":\"MyPost\",\"content\":\"Hello!\",\"authorEmail\":\"info@stacktape.com\"}'Make a GET request to <<web_service_url>>/posts to get all posts.
curl <<web_service_url>>/posts-
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.
Application runs in web-service resource and is configured as follows:
- Packaging - determines how the Docker container image is built. In this case, we are using
stacktape-image-buildpack. We only need to configureentryfilePath. Stacktape automatically 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 database
mainDatabaseintoconnectTolist. By doing this, Stacktape will automatically inject relevant environment variables into the container runtime (such as the connection string required to connect to the database) - Resources. The cheapest available resource
configuration is
0.25of virtual CPU and512MB of RAM. - For convenience, automatic CORS is enabled.
You can also configure scaling. New (parallel) container can be added when (for example) the utilization of your CPU or RAM gets larger than 80%. The traffic is evenly distributed to all the containers.
resources:
webService:
type: web-service
properties:
packaging:
type: stacktape-image-buildpack
properties:
entryfilePath: .\app.py
resources:
cpu: 0.25
memory: 512
connectTo:
- mainDatabase
cors:
enabled: trueThe application data is stored in a Postgres database. The database is configured as follows:
-
Database credentials. In this example, we input them directly. In production, you should use secrets to store them securely.
-
Engine type. We are using
postgresengine. It uses a single-node database server - the simplest and cheapest option. -
Instance size. We are using the
db.t3.microinstance. It has 1 vCPU, 1GB of memory, and is free-tier eligible (~$12.5/month without a free tier). To see the full list of available options, refer to AWS instance type list.
By default, the version used for the database is the latest AWS-supported stable version (currently 13.4). Minor
version upgrades are done automatically.
You can also configure many other aspects of your database, such as storage, logging, read replicas, or failover instances.
mainDatabase:
type: relational-database
properties:
credentials:
masterUserPassword: my_secret_password
engine:
type: postgres
properties:
primaryInstance:
instanceSize: db.t3.microTo simplify database access and migrations, this project uses Flask-SQLAlchemy together with flask migrate library.
To automatically perform migration after every deployment, the stacktape configuration contains a script and a hook.
Script specifies the command to be executed. To execute it automatically every time before the stack is deployed, we reference it inside a hook.
We also need to pass the STP_MAIN_DATABASE_CONNECTION_STRING environment variable to the script. We do it using the
$ResourceParam() directive that will
automatically download the connection string value and pass it to the script.
scripts:
migrateDb:
executeCommand: poetry run flask db stamp head && poetry run flask db migrate && poetry run flask db upgrade
environment:
- name: STP_MAIN_DATABASE_CONNECTION_STRING
value: $ResourceParam('mainDatabase', 'connectionString')
hooks:
- triggers: ["after:deploy"]
scriptName: migrateDbYou can also execute the migration script anytime using
stp script:run --scriptName migrateDb --stage <<previously-used-stage>> --region <<previously-used-region>>