A 20tab project.
The Talos script can be run either using Docker or a Python virtual environment.
In order to run Talos via Docker, a working Docker installation is the only requirement.
In order to run Talos in a virtual environment, first clone the repository in a local projects directory and ensure it is your current directory:
cd ~/projects
git clone [email protected]:20tab/talos.git
cd talosThen, create and activate a virtual environment and install the requirements:
python3.12 -m venv .venv
source .venv/bin/activate
python3 -m pip install --upgrade pip setuptools
python3 -m pip install -r requirements/common.txtThe terraform cli package is required, unless you want to generate a project only locally. To install it we suggest to use the official install guide.
If DigitalOcean is chosen for deployment, a Personal Access Token with write permission is required.
Additionally, if DigitalOcean Spaces is the chosen media storage backend, a pair of Spaces access keys is required.
Digital Ocean Personal Access Token
Note: all credentials can be generated in the DigitalOcean API configuration section.
If the GitLab integration is enabled, a Personal Access Token with api permission is required.
It can be generated in the GitLab User Settings panel.
GitLab Personal Access Token
Note: the token can be generated in the Access Tokens section of the GitLab User Settings panel.
If the Terraform Cloud integration is enabled, a User API token is required.
Terraform Cloud API Token
Note:
Change to the projects directory, for example:
cd ~/projectsdocker run --interactive --tty --rm --volume $PWD/.dumps:/app/.dumps --volume $PWD/.logs:/app/.logs --volume $PWD:/data 20tab/talos:latestNote: On a non-AMD64 architecture, --platform linux/amd64 can be passed to force emulation.
source talos/.venv/bin/activate
./talos/start.pyThe first run is manual, made from GitLab Pipeline. Use orchestrator generated README for more details.
Project name: My Project Name
Project slug [my-project-name]:
Backend type (django, none) [django]:
Backend service slug [backend]:
Frontend type (nextjs, none) [nextjs]:
Frontend service slug [frontend]:
Deploy type (digitalocean-k8s, other-k8s) [digitalocean-k8s]:
Terraform backend (terraform-cloud, gitlab) [terraform-cloud]:
Terraform host name [app.terraform.io]:
Terraform Cloud User token:
Terraform Organization: my-organization-name
Do you want to create Terraform Cloud Organization 'my-organization-name'? [y/N]:
Choose the environments distribution:
1 - All environments share the same stack (Default)
2 - Dev and Stage environments share the same stack, Prod has its own
3 - Each environment has its own stack
(1, 2, 3) [1]:
Do you want to enable the monitoring stack? [y/N]:
DigitalOcean token:
Do you want to configure DNS records? (BEWARE: NS must be set accordingly) [y/N]:
Development environment complete URL [https://dev.my-project-name.com]:
Staging environment complete URL [https://stage.my-project-name.com]:
Production environment complete URL [https://www.my-project-name.com]:
Do you want Traefik to generate SSL certificates? [Y/n]:
Let's Encrypt certificates email: [email protected]
Do you want to use Redis? [y/N]:
Kubernetes cluster DigitalOcean region [fra1]:
Database cluster DigitalOcean region [fra1]:
Database cluster node size [db-s-1vcpu-2gb]:
Media storage (digitalocean-s3, aws-s3, local, none) [digitalocean-s3]:
Do you want to use Sentry? [y/N]:
Do you want to use Pact? [y/N]:
Do you want to use GitLab? [Y/n]:
GitLab group slug [my-project-name]:
Make sure the GitLab "my-project-name" group exists before proceeding. Continue? [y/N]: y
GitLab private token (with API scope enabled):
Comma-separated GitLab group owners []:
Comma-separated GitLab group maintainers []:
Comma-separated GitLab group developers []:
DigitalOcean Spaces region [fra1]:
S3 Access Key ID:
S3 Secret Access Key:
Initializing the orchestrator service:
...cookiecutting the service
...generating the .env file
...creating the GitLab repository and associated resources
...creating the Terraform Cloud resources
Initializing the backend service:
...cookiecutting the service
...generating the .env file
...formatting the cookiecut python code
...compiling the requirements files
- common.txt
- test.txt
- local.txt
- remote.txt
- base.txt
...creating the '/static' directory
...creating the GitLab repository and associated resources
...creating the Terraform Cloud resources
Initializing the frontend service:
...cookiecutting the service
...generating the .env file
...creating the GitLab repository and associated resources
...creating the Terraform Cloud resourcesThe following arguments can be appended to the Docker and shell commands
--uid=$UID
--gid=1000
--output-dir="~/projects"
--project-name="My project name"
--project-slug="my-project-name"
--project-dirname="myprojectname"
| Value | Description | Argument |
|---|---|---|
| django | https://github.com/20tab/django-continuous-delivery | --backend-type=django |
| none | the backend service will not be initialized | --backend-type=none |
--backend-service-slug=backend
--backend-service-port=8000
| Value | Description | Argument |
|---|---|---|
| nextjs | https://github.com/20tab/nextjs-continuous-delivery | --frontend-type=nextjs |
| none | the frontend service will not be initialized | --frontend-type=none |
--frontend-service-slug=frontend
--frontend-service-port=3000
| Value | Description | Argument |
|---|---|---|
| digitalocean-k8s | DigitalOcean | --deployment-type=digitalocean-k8s |
| other-k8s | Other Kubernetes | --deployment-type=other-k8s |
| Name | Argument |
|---|---|
| Terraform Cloud | --terraform-backend=terraform-cloud |
| GitLab | --terraform-backend=gitlab |
--terraform-cloud-hostname=app.terraform.io
--terraform-cloud-token={{terraform-cloud-token}}
--terraform-cloud-organization
--terraform-cloud-organization-create
--terraform-cloud-admin-email={{terraform-cloud-admin-email}}
Disabled args
--terraform-cloud-organization-create-skip
Choose the environments distribution:
| Value | Description | Argument |
|---|---|---|
| 1 | All environments share the same stack (Default) | --environments-distribution=1 |
| 2 | Dev and Stage environments share the same stack, Prod has its own | --environments-distribution=2 |
| 3 | Each environment has its own stack | --environments-distribution=3 |
If you don't want DigitalOcean DNS configuration the following args are required
--project-url-dev=https://dev.project-domain.com
--project-url-stage=https://stage.project-domain.com
--project-url-prod=https://www.project-domain.com
| Value | Description | Argument |
|---|---|---|
| digitalocean-s3 | DigitalOcean Spaces are used to store media | DigitalOcean Media storage |
| aws-s3 | AWS S3 are used to store media | --media-storage=aws-s3 |
| local | Docker Volume are used to store media | --media-storage=local |
| none | Project have no media | --media-storage=none |
DigitalOcean API Slugs DigitalOcean Database Slugs
--digitalocean-token={{digitalocean-token}}
--media-storage=digitalocean-s3
--spaces-bucket-region=fra1
--spaces-access-id
--spaces-secret-key
If you want DigitalOcean DNS configuration the following args are required
--project-domain=project-domain.com
--subdomain-dev=dev
--subdomain-stage=test
--subdomain-prod=www
"--digitalocean-k8s-cluster-region=fra1
"--digitalocean-database-cluster-region=fra1
"--digitalocean-database-cluster-node-size=db-s-1vcpu-2gb
For enabling monitoring the following arguments are needed:
if project domain is managed use
--subdomain-monitoring=logs
else use
--project-url-monitoring=https://logs.example.org/
For enabling redis integration the following arguments are needed:
--use-redis
--digitalocean-redis-cluster-region=fra1
--digitalocean-redis-cluster-node-size=db-s-1vcpu-2gb
Disabled args
--no-redis
--kubernetes-cluster-ca-certificate={{absolute-path-to-certificate}}
--kubernetes-host={{kubernetes-host-url}}
--kubernetes-token={{kubernetes-token}}
--postgres-image=postgres:14
--postgres-persistent-volume-capacity=10Gi
--postgres-persistent-volume-claim-capacity=""
--postgres-persistent-volume-host-path={{postgres-persistent-volume-host-path}}
--redis-image=redis:6.2
⚠️ Important: Make sure the GitLab group exists before creating. > https://gitlab.com/gitlab-org/gitlab/-/issues/244345
For enabling gitlab integration the following arguments are needed:
--gitlab-private-token={{gitlab-private-token}}
--gitlab-group-slug={{gitlab-group-slug}}
Add user to repository using comma separeted arguments
--gitlab-group-owners=user1, [email protected]
--gitlab-group-maintainers=user1, [email protected]
--gitlab-group-developers=user1, [email protected]
For enabling pact the following arguments are needed:
--pact-broker-url={{pact-broker-url}}
--pact-broker-username={{pact-broker-username}}
--pact-broker-password={{pact-broker-password}}
For enabling sentry integration the following arguments are needed:
--sentry-url=https://sentry.io/
--sentry-org={{sentry-org}}
--sentry-auth-token={{sentry-auth-token}}
If the project has a backend service, the following argument is needed:
--backend-sentry-dsn={{backend-sentry-dsn}}
If the project has a frontend service, the following argument is needed:
--frontend-sentry-dsn={{frontend-sentry-dsn}}
No confirmations shown.
--quiet