Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/20tab/talos
A 20tab standard project.
https://github.com/20tab/talos
cicd cookiecutter digitalocean docker gitlab k8s
Last synced: about 2 months ago
JSON representation
A 20tab standard project.
- Host: GitHub
- URL: https://github.com/20tab/talos
- Owner: 20tab
- License: mit
- Created: 2019-12-17T14:17:58.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-27T10:58:58.000Z (3 months ago)
- Last Synced: 2024-10-15T23:48:33.420Z (2 months ago)
- Topics: cicd, cookiecutter, digitalocean, docker, gitlab, k8s
- Language: Python
- Homepage: https://www.20tab.com
- Size: 1.25 MB
- Stars: 44
- Watchers: 7
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Talos
[](https://github.com/python/black)
> A [20tab](https://www.20tab.com/) project.
## 🧩 Requirements
The Talos script can be run either using Docker or a Python virtual environment.
### 🐋 Docker
In order to run Talos via Docker, a working [Docker installation](https://docs.docker.com/get-docker/) is the only requirement.
### 🐍 Virtual environment
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:
```console
cd ~/projects
git clone [email protected]:20tab/talos.git
cd talos
```
Then, create and activate a virtual environment and install the requirements:
```console
python3.12 -m venv .venv
source .venv/bin/activate
python3 -m pip install --upgrade pip setuptools
python3 -m pip install -r requirements/common.txt
```
The `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](https://learn.hashicorp.com/tutorials/terraform/install-cli).
## 🔑 Credentials (optional)
### 🌊 DigitalOcean
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](https://cloud.digitalocean.com/account/api/)
**Note:** all credentials can be generated in the DigitalOcean API configuration section.
⚠️ Beware that the token is shown only once after creation.
### 🦊 GitLab
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](https://gitlab.com/-/profile/personal_access_tokens)
**Note:** the token can be generated in the Access Tokens section of the GitLab User Settings panel.
⚠️ Beware that the token is shown only once after creation.
### 🌎 Terraform Cloud
If the Terraform Cloud integration is enabled, a User API token is required.
[Terraform Cloud API Token](https://app.terraform.io/app/settings/tokens)
**Note:** ⚠️ Beware that the token is shown only once after creation.
## 🚀️ Quickstart
Change to the projects directory, for example:
```console
cd ~/projects
```
### 🐋 Docker
```console
docker run --interactive --tty --rm --volume $PWD/.dumps:/app/.dumps --volume $PWD/.logs:/app/.logs --volume $PWD:/data 20tab/talos:latest
```
**Note:** On a non-AMD64 architecture, `--platform linux/amd64` can be passed to force emulation.
### 🐍 Virtual environment
```console
source talos/.venv/bin/activate
./talos/start.py
```
### ⚠️ Provisioning
The first run is manual, made from GitLab Pipeline. Use orchestrator generated README for more details.
### Example
```console
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 resources
```
## 🗒️ Arguments
The following arguments can be appended to the Docker and shell commands
#### User id
`--uid=$UID`
#### Group id
`--gid=1000`
#### Output directory
`--output-dir="~/projects"`
#### Project name
`--project-name="My project name"`
#### Project slug
`--project-slug="my-project-name"`
#### Project dirname
`--project-dirname="myprojectname"`
### 🎖️ Services
#### Backend type
| 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-service-slug=backend`
#### Backend service port
`--backend-service-port=8000`
#### Frontend type
| 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-service-slug=frontend`
#### Frontend service port
`--frontend-service-port=3000`
### 📐 Architecture
#### Deploy type
| Value | Description | Argument |
| ---------------- | ------------------------------------------- | ------------------------------------ |
| digitalocean-k8s | [DigitalOcean](#🌊-digitalocean-kubernetes) | `--deployment-type=digitalocean-k8s` |
| other-k8s | [Other Kubernetes](#☸️-other-kubernetes) | `--deployment-type=other-k8s` |
#### Terraform backend
| Name | Argument |
| --------------- | ------------------------------------- |
| Terraform Cloud | `--terraform-backend=terraform-cloud` |
| GitLab | `--terraform-backend=gitlab` |
##### Terraform Cloud required argument
`--terraform-cloud-hostname=app.terraform.io`
`--terraform-cloud-token={{terraform-cloud-token}}`
`--terraform-cloud-organization`
##### Terraform Cloud create organization
`--terraform-cloud-organization-create`
`--terraform-cloud-admin-email={{terraform-cloud-admin-email}}`
Disabled args
`--terraform-cloud-organization-create-skip`
#### Environments distribution
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`
#### Project Domain
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`
#### Media storage
| Value | Description | Argument |
| --------------- | ------------------------------------------- | -------------------------------------------- |
| digitalocean-s3 | DigitalOcean Spaces are used to store media | [DigitalOcean Media storage](#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 Kubernetes
[DigitalOcean API Slugs](https://slugs.do-api.dev/)
[DigitalOcean Database Slugs](https://docs.digitalocean.com/reference/api/api-reference/#tag/Databases)
#### DigitalOcean Token
`--digitalocean-token={{digitalocean-token}}`
#### Media storage
`--media-storage=digitalocean-s3`
`--spaces-bucket-region=fra1`
`--spaces-access-id`
`--spaces-secret-key`
#### Project Domain
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`
#### Kubernetes cluster DigitalOcean region
`"--digitalocean-k8s-cluster-region=fra1`
#### Database cluster DigitalOcean region
`"--digitalocean-database-cluster-region=fra1`
#### Database cluster DigitalOcean node size
`"--digitalocean-database-cluster-node-size=db-s-1vcpu-2gb`
#### Monitoring
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/`
#### Redis
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`
### ☸️ Other Kubernetes
#### Kubernetes cluster CA certificate
`--kubernetes-cluster-ca-certificate={{absolute-path-to-certificate}}`
#### Kubernetes host
`--kubernetes-host={{kubernetes-host-url}}`
#### Kubernetes token
`--kubernetes-token={{kubernetes-token}}`
#### Postgres
`--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
`--redis-image=redis:6.2`
### 🦊 GitLab
> **⚠️ 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]`
#### 👨⚖️ Pact
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}}`
#### 🪖 Sentry
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}}`
#### 🔇 Quiet
No confirmations shown.
`--quiet`