🔊 Add consistent errors for env vars not set#200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tiangolo merged 1 commit into from
May 25, 2020
Merged

🔊 Add consistent errors for env vars not set #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions {{cookiecutter.project_slug}}/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -489,10 +489,10 @@ services:
deploy:
placement:
constraints:
- node.labels.${STACK_NAME}.app-db-data == true
- node.labels.${STACK_NAME?Variable not set}.app-db-data == true
```

note the `${STACK_NAME}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:
note the `${STACK_NAME?Variable not set}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:

```yaml
version: '3'
Expand All@@ -506,6 +506,8 @@ services:
- node.labels.{{cookiecutter.docker_swarm_stack_name_main}}.app-db-data == true
```

**Note**: The `${STACK_NAME?Variable not set}` means "use the environment variable `STACK_NAME`, but if it is not set, show an error `Variable not set`".

If you add more volumes to your stack, you need to make sure you add the corresponding constraints to the services that use that named volume.

Then you have to create those labels in some nodes in your Docker Swarm mode cluster. You can use `docker-auto-labels` to do it automatically.
Expand DownExpand Up@@ -632,10 +634,10 @@ You can do the process by hand based on those same scripts if you wanted. The ge
```bash
# Use the environment variables passed to this script, as TAG and FRONTEND_ENV
# And re-create those variables as environment variables for the next command
TAG=${TAG} \
TAG=${TAG?Variable not set} \
# Set the environment variable FRONTEND_ENV to the same value passed to this script with
# a default value of "production" if nothing else was passed
FRONTEND_ENV=${FRONTEND_ENV-production} \
FRONTEND_ENV=${FRONTEND_ENV-production?Variable not set} \
# The actual comand that does the work: docker-compose
docker-compose \
# Pass the file that should be used, setting explicitly docker-compose.yml avoids the
Expand All@@ -653,7 +655,7 @@ config > docker-stack.yml
docker-auto-labels docker-stack.yml

# Now this command uses that same file to deploy it
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"
```

### Continuous Integration / Continuous Delivery
Expand Down
22 changes: 11 additions & 11 deletions {{cookiecutter.project_slug}}/docker-compose.override.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ services:
- --providers.docker
# Add a constraint to only use services with the label for this stack
# from the env var TRAEFIK_TAG
- --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
- --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
# Do not expose all Docker services, only the ones explicitly exposed
- --providers.docker.exposedbydefault=false
# Disable Docker Swarm mode for local development
Expand All@@ -25,8 +25,8 @@ services:
- --api.insecure=true
labels:
- traefik.enable=true
- traefik.http.routers.${STACK_NAME}-traefik-public-http.rule=Host(`${DOMAIN}`)
- traefik.http.services.${STACK_NAME}-traefik-public.loadbalancer.server.port=80
- traefik.http.routers.${STACK_NAME?Variable not set}-traefik-public-http.rule=Host(`${DOMAIN?Variable not set}`)
- traefik.http.services.${STACK_NAME?Variable not set}-traefik-public.loadbalancer.server.port=80

pgadmin:
ports:
Expand All@@ -43,7 +43,7 @@ services:
- ./backend/app:/app
environment:
- JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
- SERVER_HOST=http://${DOMAIN}
- SERVER_HOST=http://${DOMAIN?Variable not set}
build:
context: ./backend
dockerfile: backend.dockerfile
Expand All@@ -54,17 +54,17 @@ services:
command: /start-reload.sh
labels:
- traefik.enable=true
- traefik.constraint-label-stack=${TRAEFIK_TAG}
- traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
- traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
- traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
- traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
- traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

celeryworker:
volumes:
- ./backend/app:/app
environment:
- RUN=celery worker -A app.worker -l info -Q main-queue -c 1
- JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
- SERVER_HOST=http://${DOMAIN}
- SERVER_HOST=http://${DOMAIN?Variable not set}
build:
context: ./backend
dockerfile: celeryworker.dockerfile
Expand All@@ -79,9 +79,9 @@ services:
FRONTEND_ENV: dev
labels:
- traefik.enable=true
- traefik.constraint-label-stack=${TRAEFIK_TAG}
- traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
- traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
- traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
- traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
- traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

networks:
traefik-public:
Expand Down
110 changes: 55 additions & 55 deletions {{cookiecutter.project_slug}}/docker-compose.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ services:
proxy:
image: traefik:v2.2
networks:
- ${TRAEFIK_PUBLIC_NETWORK}
- ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
- default
volumes:
- /var/run/docker.sock:/var/run/docker.sock
Expand All@@ -13,7 +13,7 @@ services:
- --providers.docker
# Add a constraint to only use services with the label for this stack
# from the env var TRAEFIK_TAG
- --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
- --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
# Do not expose all Docker services, only the ones explicitly exposed
- --providers.docker.exposedbydefault=false
# Enable Docker Swarm mode
Expand All@@ -32,41 +32,41 @@ services:
# Enable Traefik for this service, to make it available in the public network
- traefik.enable=true
# Use the traefik-public network (declared below)
- traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
- traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
# Use the custom label "traefik.constraint-label=traefik-public"
# This public Traefik will only use services with this label
- traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
- traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
# traefik-http set up only to use the middleware to redirect to https
- traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.scheme=https
- traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.permanent=true
- traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.scheme=https
- traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.permanent=true
# Handle host with and without "www" to redirect to only one of them
# Uses environment variable DOMAIN
# To disable www redirection remove the Host() you want to discard, here and
# below for HTTPS
- traefik.http.routers.${STACK_NAME}-proxy-http.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
- traefik.http.routers.${STACK_NAME}-proxy-http.entrypoints=http
- traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
- traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.entrypoints=http
# traefik-https the actual router using HTTPS
- traefik.http.routers.${STACK_NAME}-proxy-https.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
- traefik.http.routers.${STACK_NAME}-proxy-https.entrypoints=https
- traefik.http.routers.${STACK_NAME}-proxy-https.tls=true
- traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
- traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.entrypoints=https
- traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls=true
# Use the "le" (Let's Encrypt) resolver created below
- traefik.http.routers.${STACK_NAME}-proxy-https.tls.certresolver=le
- traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls.certresolver=le
# Define the port inside of the Docker service to use
- traefik.http.services.${STACK_NAME}-proxy.loadbalancer.server.port=80
- traefik.http.services.${STACK_NAME?Variable not set}-proxy.loadbalancer.server.port=80
# Handle domain with and without "www" to redirect to only one
# To disable www redirection remove the next line
- traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN})/(.*)
- traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN?Variable not set})/(.*)
# Redirect a domain with www to non-www
# To disable it remove the next line
- traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://${DOMAIN}/$${3}
- traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.replacement=https://${DOMAIN?Variable not set}/$${3}
# Redirect a domain without www to www
# To enable it remove the previous line and uncomment the next
# - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://www.${DOMAIN}/$${3}
# Middleware to redirect www, to disable it remove the next line
- traefik.http.routers.${STACK_NAME}-proxy-https.middlewares=${STACK_NAME}-www-redirect
- traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.middlewares=${STACK_NAME?Variable not set}-www-redirect
# Middleware to redirect www, and redirect HTTP to HTTPS
# to disable www redirection remove the section: ${STACK_NAME}-www-redirect,
- traefik.http.routers.${STACK_NAME}-proxy-http.middlewares=${STACK_NAME}-www-redirect,${STACK_NAME}-https-redirect
# to disable www redirection remove the section: ${STACK_NAME?Variable not set}-www-redirect,
- traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.middlewares=${STACK_NAME?Variable not set}-www-redirect,${STACK_NAME?Variable not set}-https-redirect

db:
image: postgres:12
Expand All@@ -79,12 +79,12 @@ services:
deploy:
placement:
constraints:
- node.labels.${STACK_NAME}.app-db-data == true
- node.labels.${STACK_NAME?Variable not set}.app-db-data == true

pgadmin:
image: dpage/pgadmin4
networks:
- ${TRAEFIK_PUBLIC_NETWORK}
- ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
- default
depends_on:
- db
Expand All@@ -93,16 +93,16 @@ services:
deploy:
labels:
- traefik.enable=true
- traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
- traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
- traefik.http.routers.${STACK_NAME}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN}`)
- traefik.http.routers.${STACK_NAME}-pgadmin-http.entrypoints=http
- traefik.http.routers.${STACK_NAME}-pgadmin-http.middlewares=${STACK_NAME}-https-redirect
- traefik.http.routers.${STACK_NAME}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN}`)
- traefik.http.routers.${STACK_NAME}-pgadmin-https.entrypoints=https
- traefik.http.routers.${STACK_NAME}-pgadmin-https.tls=true
- traefik.http.routers.${STACK_NAME}-pgadmin-https.tls.certresolver=le
- traefik.http.services.${STACK_NAME}-pgadmin.loadbalancer.server.port=5050
- traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
- traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
- traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
- traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
- traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
- traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
- traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
- traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
- traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
- traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050

queue:
image: rabbitmq:3
Expand All@@ -114,7 +114,7 @@ services:
flower:
image: mher/flower
networks:
- ${TRAEFIK_PUBLIC_NETWORK}
- ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
- default
env_file:
- .env
Expand All@@ -126,26 +126,26 @@ services:
deploy:
labels:
- traefik.enable=true
- traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
- traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
- traefik.http.routers.${STACK_NAME}-flower-http.rule=Host(`flower.${DOMAIN}`)
- traefik.http.routers.${STACK_NAME}-flower-http.entrypoints=http
- traefik.http.routers.${STACK_NAME}-flower-http.middlewares=${STACK_NAME}-https-redirect
- traefik.http.routers.${STACK_NAME}-flower-https.rule=Host(`flower.${DOMAIN}`)
- traefik.http.routers.${STACK_NAME}-flower-https.entrypoints=https
- traefik.http.routers.${STACK_NAME}-flower-https.tls=true
- traefik.http.routers.${STACK_NAME}-flower-https.tls.certresolver=le
- traefik.http.services.${STACK_NAME}-flower.loadbalancer.server.port=5555
- traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
- traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
- traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.rule=Host(`flower.${DOMAIN?Variable not set}`)
- traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.entrypoints=http
- traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
- traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.rule=Host(`flower.${DOMAIN?Variable not set}`)
- traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.entrypoints=https
- traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls=true
- traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls.certresolver=le
- traefik.http.services.${STACK_NAME?Variable not set}-flower.loadbalancer.server.port=5555

backend:
image: '${DOCKER_IMAGE_BACKEND}:${TAG-latest}'
image: '${DOCKER_IMAGE_BACKEND?Variable not set}:${TAG-latest}'
depends_on:
- db
env_file:
- .env
environment:
- SERVER_NAME=${DOMAIN}
- SERVER_HOST=https://${DOMAIN}
- SERVER_NAME=${DOMAIN?Variable not set}
- SERVER_HOST=https://${DOMAIN?Variable not set}
# Allow explicit env var override for tests
- SMTP_HOST=${SMTP_HOST}
build:
Expand All@@ -156,40 +156,40 @@ services:
deploy:
labels:
- traefik.enable=true
- traefik.constraint-label-stack=${TRAEFIK_TAG}
- traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
- traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
- traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
- traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
- traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

celeryworker:
image: '${DOCKER_IMAGE_CELERYWORKER}:${TAG-latest}'
image: '${DOCKER_IMAGE_CELERYWORKER?Variable not set}:${TAG-latest}'
depends_on:
- db
- queue
env_file:
- .env
environment:
- SERVER_NAME=${DOMAIN}
- SERVER_HOST=https://${DOMAIN}
- SERVER_NAME=${DOMAIN?Variable not set}
- SERVER_HOST=https://${DOMAIN?Variable not set}
# Allow explicit env var override for tests
- SMTP_HOST=${SMTP_HOST}
- SMTP_HOST=${SMTP_HOST?Variable not set}
build:
context: ./backend
dockerfile: celeryworker.dockerfile
args:
INSTALL_DEV: ${INSTALL_DEV-false}

frontend:
image: '${DOCKER_IMAGE_FRONTEND}:${TAG-latest}'
image: '${DOCKER_IMAGE_FRONTEND?Variable not set}:${TAG-latest}'
build:
context: ./frontend
args:
FRONTEND_ENV: ${FRONTEND_ENV-production}
deploy:
labels:
- traefik.enable=true
- traefik.constraint-label-stack=${TRAEFIK_TAG}
- traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
- traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
- traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
- traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
- traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

volumes:
app-db-data:
Expand Down
2 changes: 1 addition & 1 deletion {{cookiecutter.project_slug}}/scripts/build-push.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
sh ./scripts/build.sh

Expand Down
2 changes: 1 addition & 1 deletion {{cookiecutter.project_slug}}/scripts/build.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
docker-compose \
-f docker-compose.yml \
Expand Down
10 changes: 5 additions & 5 deletions {{cookiecutter.project_slug}}/scripts/deploy.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,14 @@
# Exit in case of error
set -e

DOMAIN=${DOMAIN} \
TRAEFIK_TAG=${TRAEFIK_TAG} \
STACK_NAME=${STACK_NAME} \
TAG=${TAG} \
DOMAIN=${DOMAIN?Variable not set} \
TRAEFIK_TAG=${TRAEFIK_TAG?Variable not set} \
STACK_NAME=${STACK_NAME?Variable not set} \
TAG=${TAG?Variable not set} \
docker-compose \
-f docker-compose.yml \
config > docker-stack.yml

docker-auto-labels docker-stack.yml

docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
🔊 Add consistent errors for env vars not set#200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

May 25, 2020
 Merged


🔊 Add consistent errors for env vars not set
#200
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


12 changes: 7 additions & 5 deletions
{{cookiecutter.project_slug}}/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -489,10 +489,10 @@ services:
 deploy:
 placement:
 constraints:
 - node.labels.${STACK_NAME}.app-db-data == true
 - node.labels.${STACK_NAME?Variable not set}.app-db-data == true
```

note the `${STACK_NAME}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:
note the `${STACK_NAME?Variable not set}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:

```yaml
version: '3'
Expand All@@ -506,6 +506,8 @@ services:
 - node.labels.{{cookiecutter.docker_swarm_stack_name_main}}.app-db-data == true
```

**Note**: The `${STACK_NAME?Variable not set}` means "use the environment variable `STACK_NAME`, but if it is not set, show an error `Variable not set`".

If you add more volumes to your stack, you need to make sure you add the corresponding constraints to the services that use that named volume.

Then you have to create those labels in some nodes in your Docker Swarm mode cluster. You can use `docker-auto-labels` to do it automatically.
Expand DownExpand Up@@ -632,10 +634,10 @@ You can do the process by hand based on those same scripts if you wanted. The ge
```bash
# Use the environment variables passed to this script, as TAG and FRONTEND_ENV
# And re-create those variables as environment variables for the next command
TAG=${TAG} \
TAG=${TAG?Variable not set} \
# Set the environment variable FRONTEND_ENV to the same value passed to this script with
# a default value of "production" if nothing else was passed
FRONTEND_ENV=${FRONTEND_ENV-production} \
FRONTEND_ENV=${FRONTEND_ENV-production?Variable not set} \
# The actual comand that does the work: docker-compose
docker-compose \
# Pass the file that should be used, setting explicitly docker-compose.yml avoids the
Expand All@@ -653,7 +655,7 @@ config > docker-stack.yml
docker-auto-labels docker-stack.yml

# Now this command uses that same file to deploy it
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"
```

### Continuous Integration / Continuous Delivery
Expand Down

22 changes: 11 additions & 11 deletions
{{cookiecutter.project_slug}}/docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ services:
 - --providers.docker
 # Add a constraint to only use services with the label for this stack
 # from the env var TRAEFIK_TAG
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
 # Do not expose all Docker services, only the ones explicitly exposed
 - --providers.docker.exposedbydefault=false
 # Disable Docker Swarm mode for local development
Expand All@@ -25,8 +25,8 @@ services:
 - --api.insecure=true
 labels:
 - traefik.enable=true
 - traefik.http.routers.${STACK_NAME}-traefik-public-http.rule=Host(`${DOMAIN}`)
 - traefik.http.services.${STACK_NAME}-traefik-public.loadbalancer.server.port=80
 - traefik.http.routers.${STACK_NAME?Variable not set}-traefik-public-http.rule=Host(`${DOMAIN?Variable not set}`)
 - traefik.http.services.${STACK_NAME?Variable not set}-traefik-public.loadbalancer.server.port=80

 pgadmin:
 ports:
Expand All@@ -43,7 +43,7 @@ services:
 - ./backend/app:/app
 environment:
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN}
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: backend.dockerfile
Expand All@@ -54,17 +54,17 @@ services:
 command: /start-reload.sh
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

 celeryworker:
 volumes:
 - ./backend/app:/app
 environment:
 - RUN=celery worker -A app.worker -l info -Q main-queue -c 1
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN}
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
Expand All@@ -79,9 +79,9 @@ services:
 FRONTEND_ENV: dev
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

networks:
 traefik-public:
Expand Down

110 changes: 55 additions & 55 deletions
{{cookiecutter.project_slug}}/docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ services:
 proxy:
 image: traefik:v2.2
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 volumes:
 - /var/run/docker.sock:/var/run/docker.sock
Expand All@@ -13,7 +13,7 @@ services:
 - --providers.docker
 # Add a constraint to only use services with the label for this stack
 # from the env var TRAEFIK_TAG
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
 # Do not expose all Docker services, only the ones explicitly exposed
 - --providers.docker.exposedbydefault=false
 # Enable Docker Swarm mode
Expand All@@ -32,41 +32,41 @@ services:
 # Enable Traefik for this service, to make it available in the public network
 - traefik.enable=true
 # Use the traefik-public network (declared below)
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 # Use the custom label "traefik.constraint-label=traefik-public"
 # This public Traefik will only use services with this label
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 # traefik-http set up only to use the middleware to redirect to https
 - traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.scheme=https
 - traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.permanent=true
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.scheme=https
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.permanent=true
 # Handle host with and without "www" to redirect to only one of them
 # Uses environment variable DOMAIN
 # To disable www redirection remove the Host() you want to discard, here and
 # below for HTTPS
 - traefik.http.routers.${STACK_NAME}-proxy-http.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-proxy-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.entrypoints=http
 # traefik-https the actual router using HTTPS
 - traefik.http.routers.${STACK_NAME}-proxy-https.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-proxy-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-proxy-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls=true
 # Use the "le" (Let's Encrypt) resolver created below
 - traefik.http.routers.${STACK_NAME}-proxy-https.tls.certresolver=le
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls.certresolver=le
 # Define the port inside of the Docker service to use
 - traefik.http.services.${STACK_NAME}-proxy.loadbalancer.server.port=80
 - traefik.http.services.${STACK_NAME?Variable not set}-proxy.loadbalancer.server.port=80
 # Handle domain with and without "www" to redirect to only one
 # To disable www redirection remove the next line
 - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN})/(.*)
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN?Variable not set})/(.*)
 # Redirect a domain with www to non-www
 # To disable it remove the next line
 - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://${DOMAIN}/$${3}
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.replacement=https://${DOMAIN?Variable not set}/$${3}
 # Redirect a domain without www to www
 # To enable it remove the previous line and uncomment the next
 # - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://www.${DOMAIN}/$${3}
 # Middleware to redirect www, to disable it remove the next line 
 - traefik.http.routers.${STACK_NAME}-proxy-https.middlewares=${STACK_NAME}-www-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.middlewares=${STACK_NAME?Variable not set}-www-redirect
 # Middleware to redirect www, and redirect HTTP to HTTPS
 # to disable www redirection remove the section: ${STACK_NAME}-www-redirect,
 - traefik.http.routers.${STACK_NAME}-proxy-http.middlewares=${STACK_NAME}-www-redirect,${STACK_NAME}-https-redirect
 # to disable www redirection remove the section: ${STACK_NAME?Variable not set}-www-redirect,
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.middlewares=${STACK_NAME?Variable not set}-www-redirect,${STACK_NAME?Variable not set}-https-redirect

 db:
 image: postgres:12
Expand All@@ -79,12 +79,12 @@ services:
 deploy:
 placement:
 constraints:
 - node.labels.${STACK_NAME}.app-db-data == true
 - node.labels.${STACK_NAME?Variable not set}.app-db-data == true

 pgadmin:
 image: dpage/pgadmin4
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 depends_on:
 - db
Expand All@@ -93,16 +93,16 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.middlewares=${STACK_NAME}-https-redirect
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME}-pgadmin.loadbalancer.server.port=5050
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050

 queue:
 image: rabbitmq:3
Expand All@@ -114,7 +114,7 @@ services:
 flower:
 image: mher/flower
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 env_file:
 - .env
Expand All@@ -126,26 +126,26 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.http.routers.${STACK_NAME}-flower-http.rule=Host(`flower.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-flower-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME}-flower-http.middlewares=${STACK_NAME}-https-redirect
 - traefik.http.routers.${STACK_NAME}-flower-https.rule=Host(`flower.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-flower-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-flower-https.tls=true
 - traefik.http.routers.${STACK_NAME}-flower-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME}-flower.loadbalancer.server.port=5555
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.rule=Host(`flower.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.rule=Host(`flower.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-flower.loadbalancer.server.port=5555

 backend:
 image: '${DOCKER_IMAGE_BACKEND}:${TAG-latest}'
 image: '${DOCKER_IMAGE_BACKEND?Variable not set}:${TAG-latest}'
 depends_on:
 - db
 env_file:
 - .env
 environment:
 - SERVER_NAME=${DOMAIN}
 - SERVER_HOST=https://${DOMAIN}
 - SERVER_NAME=${DOMAIN?Variable not set}
 - SERVER_HOST=https://${DOMAIN?Variable not set}
 # Allow explicit env var override for tests
 - SMTP_HOST=${SMTP_HOST}
 build:
Expand All@@ -156,40 +156,40 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

 celeryworker:
 image: '${DOCKER_IMAGE_CELERYWORKER}:${TAG-latest}'
 image: '${DOCKER_IMAGE_CELERYWORKER?Variable not set}:${TAG-latest}'
 depends_on:
 - db
 - queue
 env_file:
 - .env
 environment:
 - SERVER_NAME=${DOMAIN}
 - SERVER_HOST=https://${DOMAIN}
 - SERVER_NAME=${DOMAIN?Variable not set}
 - SERVER_HOST=https://${DOMAIN?Variable not set}
 # Allow explicit env var override for tests
 - SMTP_HOST=${SMTP_HOST}
 - SMTP_HOST=${SMTP_HOST?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-false}

 frontend:
 image: '${DOCKER_IMAGE_FRONTEND}:${TAG-latest}'
 image: '${DOCKER_IMAGE_FRONTEND?Variable not set}:${TAG-latest}'
 build:
 context: ./frontend
 args:
 FRONTEND_ENV: ${FRONTEND_ENV-production}
 deploy:
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

volumes:
 app-db-data:
Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/scripts/build-push.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
sh ./scripts/build.sh

Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/scripts/build.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
docker-compose \
-f docker-compose.yml \
Expand Down

10 changes: 5 additions & 5 deletions
{{cookiecutter.project_slug}}/scripts/deploy.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,14 @@
# Exit in case of error
set -e

DOMAIN=${DOMAIN} \
TRAEFIK_TAG=${TRAEFIK_TAG} \
STACK_NAME=${STACK_NAME} \
TAG=${TAG} \
DOMAIN=${DOMAIN?Variable not set} \
TRAEFIK_TAG=${TRAEFIK_TAG?Variable not set} \
STACK_NAME=${STACK_NAME?Variable not set} \
TAG=${TAG?Variable not set} \
docker-compose \
-f docker-compose.yml \
config > docker-stack.yml

docker-auto-labels docker-stack.yml

docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
🔊 Add consistent errors for env vars not set#200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

May 25, 2020
 Merged


🔊 Add consistent errors for env vars not set
#200
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


12 changes: 7 additions & 5 deletions
{{cookiecutter.project_slug}}/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -489,10 +489,10 @@ services:
 deploy:
 placement:
 constraints:
 - node.labels.${STACK_NAME}.app-db-data == true
 - node.labels.${STACK_NAME?Variable not set}.app-db-data == true
```

note the `${STACK_NAME}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:
note the `${STACK_NAME?Variable not set}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:

```yaml
version: '3'
Expand All@@ -506,6 +506,8 @@ services:
 - node.labels.{{cookiecutter.docker_swarm_stack_name_main}}.app-db-data == true
```

**Note**: The `${STACK_NAME?Variable not set}` means "use the environment variable `STACK_NAME`, but if it is not set, show an error `Variable not set`".

If you add more volumes to your stack, you need to make sure you add the corresponding constraints to the services that use that named volume.

Then you have to create those labels in some nodes in your Docker Swarm mode cluster. You can use `docker-auto-labels` to do it automatically.
Expand DownExpand Up@@ -632,10 +634,10 @@ You can do the process by hand based on those same scripts if you wanted. The ge
```bash
# Use the environment variables passed to this script, as TAG and FRONTEND_ENV
# And re-create those variables as environment variables for the next command
TAG=${TAG} \
TAG=${TAG?Variable not set} \
# Set the environment variable FRONTEND_ENV to the same value passed to this script with
# a default value of "production" if nothing else was passed
FRONTEND_ENV=${FRONTEND_ENV-production} \
FRONTEND_ENV=${FRONTEND_ENV-production?Variable not set} \
# The actual comand that does the work: docker-compose
docker-compose \
# Pass the file that should be used, setting explicitly docker-compose.yml avoids the
Expand All@@ -653,7 +655,7 @@ config > docker-stack.yml
docker-auto-labels docker-stack.yml

# Now this command uses that same file to deploy it
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"
```

### Continuous Integration / Continuous Delivery
Expand Down

22 changes: 11 additions & 11 deletions
{{cookiecutter.project_slug}}/docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ services:
 - --providers.docker
 # Add a constraint to only use services with the label for this stack
 # from the env var TRAEFIK_TAG
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
 # Do not expose all Docker services, only the ones explicitly exposed
 - --providers.docker.exposedbydefault=false
 # Disable Docker Swarm mode for local development
Expand All@@ -25,8 +25,8 @@ services:
 - --api.insecure=true
 labels:
 - traefik.enable=true
 - traefik.http.routers.${STACK_NAME}-traefik-public-http.rule=Host(`${DOMAIN}`)
 - traefik.http.services.${STACK_NAME}-traefik-public.loadbalancer.server.port=80
 - traefik.http.routers.${STACK_NAME?Variable not set}-traefik-public-http.rule=Host(`${DOMAIN?Variable not set}`)
 - traefik.http.services.${STACK_NAME?Variable not set}-traefik-public.loadbalancer.server.port=80

 pgadmin:
 ports:
Expand All@@ -43,7 +43,7 @@ services:
 - ./backend/app:/app
 environment:
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN}
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: backend.dockerfile
Expand All@@ -54,17 +54,17 @@ services:
 command: /start-reload.sh
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

 celeryworker:
 volumes:
 - ./backend/app:/app
 environment:
 - RUN=celery worker -A app.worker -l info -Q main-queue -c 1
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN}
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
Expand All@@ -79,9 +79,9 @@ services:
 FRONTEND_ENV: dev
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

networks:
 traefik-public:
Expand Down

110 changes: 55 additions & 55 deletions
{{cookiecutter.project_slug}}/docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ services:
 proxy:
 image: traefik:v2.2
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 volumes:
 - /var/run/docker.sock:/var/run/docker.sock
Expand All@@ -13,7 +13,7 @@ services:
 - --providers.docker
 # Add a constraint to only use services with the label for this stack
 # from the env var TRAEFIK_TAG
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
 # Do not expose all Docker services, only the ones explicitly exposed
 - --providers.docker.exposedbydefault=false
 # Enable Docker Swarm mode
Expand All@@ -32,41 +32,41 @@ services:
 # Enable Traefik for this service, to make it available in the public network
 - traefik.enable=true
 # Use the traefik-public network (declared below)
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 # Use the custom label "traefik.constraint-label=traefik-public"
 # This public Traefik will only use services with this label
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 # traefik-http set up only to use the middleware to redirect to https
 - traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.scheme=https
 - traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.permanent=true
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.scheme=https
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.permanent=true
 # Handle host with and without "www" to redirect to only one of them
 # Uses environment variable DOMAIN
 # To disable www redirection remove the Host() you want to discard, here and
 # below for HTTPS
 - traefik.http.routers.${STACK_NAME}-proxy-http.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-proxy-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.entrypoints=http
 # traefik-https the actual router using HTTPS
 - traefik.http.routers.${STACK_NAME}-proxy-https.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-proxy-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-proxy-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls=true
 # Use the "le" (Let's Encrypt) resolver created below
 - traefik.http.routers.${STACK_NAME}-proxy-https.tls.certresolver=le
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls.certresolver=le
 # Define the port inside of the Docker service to use
 - traefik.http.services.${STACK_NAME}-proxy.loadbalancer.server.port=80
 - traefik.http.services.${STACK_NAME?Variable not set}-proxy.loadbalancer.server.port=80
 # Handle domain with and without "www" to redirect to only one
 # To disable www redirection remove the next line
 - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN})/(.*)
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN?Variable not set})/(.*)
 # Redirect a domain with www to non-www
 # To disable it remove the next line
 - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://${DOMAIN}/$${3}
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.replacement=https://${DOMAIN?Variable not set}/$${3}
 # Redirect a domain without www to www
 # To enable it remove the previous line and uncomment the next
 # - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://www.${DOMAIN}/$${3}
 # Middleware to redirect www, to disable it remove the next line 
 - traefik.http.routers.${STACK_NAME}-proxy-https.middlewares=${STACK_NAME}-www-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.middlewares=${STACK_NAME?Variable not set}-www-redirect
 # Middleware to redirect www, and redirect HTTP to HTTPS
 # to disable www redirection remove the section: ${STACK_NAME}-www-redirect,
 - traefik.http.routers.${STACK_NAME}-proxy-http.middlewares=${STACK_NAME}-www-redirect,${STACK_NAME}-https-redirect
 # to disable www redirection remove the section: ${STACK_NAME?Variable not set}-www-redirect,
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.middlewares=${STACK_NAME?Variable not set}-www-redirect,${STACK_NAME?Variable not set}-https-redirect

 db:
 image: postgres:12
Expand All@@ -79,12 +79,12 @@ services:
 deploy:
 placement:
 constraints:
 - node.labels.${STACK_NAME}.app-db-data == true
 - node.labels.${STACK_NAME?Variable not set}.app-db-data == true

 pgadmin:
 image: dpage/pgadmin4
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 depends_on:
 - db
Expand All@@ -93,16 +93,16 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.middlewares=${STACK_NAME}-https-redirect
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME}-pgadmin.loadbalancer.server.port=5050
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050

 queue:
 image: rabbitmq:3
Expand All@@ -114,7 +114,7 @@ services:
 flower:
 image: mher/flower
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 env_file:
 - .env
Expand All@@ -126,26 +126,26 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.http.routers.${STACK_NAME}-flower-http.rule=Host(`flower.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-flower-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME}-flower-http.middlewares=${STACK_NAME}-https-redirect
 - traefik.http.routers.${STACK_NAME}-flower-https.rule=Host(`flower.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-flower-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-flower-https.tls=true
 - traefik.http.routers.${STACK_NAME}-flower-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME}-flower.loadbalancer.server.port=5555
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.rule=Host(`flower.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.rule=Host(`flower.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-flower.loadbalancer.server.port=5555

 backend:
 image: '${DOCKER_IMAGE_BACKEND}:${TAG-latest}'
 image: '${DOCKER_IMAGE_BACKEND?Variable not set}:${TAG-latest}'
 depends_on:
 - db
 env_file:
 - .env
 environment:
 - SERVER_NAME=${DOMAIN}
 - SERVER_HOST=https://${DOMAIN}
 - SERVER_NAME=${DOMAIN?Variable not set}
 - SERVER_HOST=https://${DOMAIN?Variable not set}
 # Allow explicit env var override for tests
 - SMTP_HOST=${SMTP_HOST}
 build:
Expand All@@ -156,40 +156,40 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

 celeryworker:
 image: '${DOCKER_IMAGE_CELERYWORKER}:${TAG-latest}'
 image: '${DOCKER_IMAGE_CELERYWORKER?Variable not set}:${TAG-latest}'
 depends_on:
 - db
 - queue
 env_file:
 - .env
 environment:
 - SERVER_NAME=${DOMAIN}
 - SERVER_HOST=https://${DOMAIN}
 - SERVER_NAME=${DOMAIN?Variable not set}
 - SERVER_HOST=https://${DOMAIN?Variable not set}
 # Allow explicit env var override for tests
 - SMTP_HOST=${SMTP_HOST}
 - SMTP_HOST=${SMTP_HOST?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-false}

 frontend:
 image: '${DOCKER_IMAGE_FRONTEND}:${TAG-latest}'
 image: '${DOCKER_IMAGE_FRONTEND?Variable not set}:${TAG-latest}'
 build:
 context: ./frontend
 args:
 FRONTEND_ENV: ${FRONTEND_ENV-production}
 deploy:
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

volumes:
 app-db-data:
Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/scripts/build-push.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
sh ./scripts/build.sh

Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/scripts/build.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
docker-compose \
-f docker-compose.yml \
Expand Down

10 changes: 5 additions & 5 deletions
{{cookiecutter.project_slug}}/scripts/deploy.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,14 @@
# Exit in case of error
set -e

DOMAIN=${DOMAIN} \
TRAEFIK_TAG=${TRAEFIK_TAG} \
STACK_NAME=${STACK_NAME} \
TAG=${TAG} \
DOMAIN=${DOMAIN?Variable not set} \
TRAEFIK_TAG=${TRAEFIK_TAG?Variable not set} \
STACK_NAME=${STACK_NAME?Variable not set} \
TAG=${TAG?Variable not set} \
docker-compose \
-f docker-compose.yml \
config > docker-stack.yml

docker-auto-labels docker-stack.yml

docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
🔊 Add consistent errors for env vars not set#200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

May 25, 2020
 Merged


🔊 Add consistent errors for env vars not set
#200
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


12 changes: 7 additions & 5 deletions
{{cookiecutter.project_slug}}/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -489,10 +489,10 @@ services:
 deploy:
 placement:
 constraints:
 - node.labels.${STACK_NAME}.app-db-data == true
 - node.labels.${STACK_NAME?Variable not set}.app-db-data == true
```

note the `${STACK_NAME}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:
note the `${STACK_NAME?Variable not set}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:

```yaml
version: '3'
Expand All@@ -506,6 +506,8 @@ services:
 - node.labels.{{cookiecutter.docker_swarm_stack_name_main}}.app-db-data == true
```

**Note**: The `${STACK_NAME?Variable not set}` means "use the environment variable `STACK_NAME`, but if it is not set, show an error `Variable not set`".

If you add more volumes to your stack, you need to make sure you add the corresponding constraints to the services that use that named volume.

Then you have to create those labels in some nodes in your Docker Swarm mode cluster. You can use `docker-auto-labels` to do it automatically.
Expand DownExpand Up@@ -632,10 +634,10 @@ You can do the process by hand based on those same scripts if you wanted. The ge
```bash
# Use the environment variables passed to this script, as TAG and FRONTEND_ENV
# And re-create those variables as environment variables for the next command
TAG=${TAG} \
TAG=${TAG?Variable not set} \
# Set the environment variable FRONTEND_ENV to the same value passed to this script with
# a default value of "production" if nothing else was passed
FRONTEND_ENV=${FRONTEND_ENV-production} \
FRONTEND_ENV=${FRONTEND_ENV-production?Variable not set} \
# The actual comand that does the work: docker-compose
docker-compose \
# Pass the file that should be used, setting explicitly docker-compose.yml avoids the
Expand All@@ -653,7 +655,7 @@ config > docker-stack.yml
docker-auto-labels docker-stack.yml

# Now this command uses that same file to deploy it
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"
```

### Continuous Integration / Continuous Delivery
Expand Down

22 changes: 11 additions & 11 deletions
{{cookiecutter.project_slug}}/docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ services:
 - --providers.docker
 # Add a constraint to only use services with the label for this stack
 # from the env var TRAEFIK_TAG
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
 # Do not expose all Docker services, only the ones explicitly exposed
 - --providers.docker.exposedbydefault=false
 # Disable Docker Swarm mode for local development
Expand All@@ -25,8 +25,8 @@ services:
 - --api.insecure=true
 labels:
 - traefik.enable=true
 - traefik.http.routers.${STACK_NAME}-traefik-public-http.rule=Host(`${DOMAIN}`)
 - traefik.http.services.${STACK_NAME}-traefik-public.loadbalancer.server.port=80
 - traefik.http.routers.${STACK_NAME?Variable not set}-traefik-public-http.rule=Host(`${DOMAIN?Variable not set}`)
 - traefik.http.services.${STACK_NAME?Variable not set}-traefik-public.loadbalancer.server.port=80

 pgadmin:
 ports:
Expand All@@ -43,7 +43,7 @@ services:
 - ./backend/app:/app
 environment:
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN}
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: backend.dockerfile
Expand All@@ -54,17 +54,17 @@ services:
 command: /start-reload.sh
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

 celeryworker:
 volumes:
 - ./backend/app:/app
 environment:
 - RUN=celery worker -A app.worker -l info -Q main-queue -c 1
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN}
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
Expand All@@ -79,9 +79,9 @@ services:
 FRONTEND_ENV: dev
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

networks:
 traefik-public:
Expand Down

110 changes: 55 additions & 55 deletions
{{cookiecutter.project_slug}}/docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ services:
 proxy:
 image: traefik:v2.2
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 volumes:
 - /var/run/docker.sock:/var/run/docker.sock
Expand All@@ -13,7 +13,7 @@ services:
 - --providers.docker
 # Add a constraint to only use services with the label for this stack
 # from the env var TRAEFIK_TAG
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
 # Do not expose all Docker services, only the ones explicitly exposed
 - --providers.docker.exposedbydefault=false
 # Enable Docker Swarm mode
Expand All@@ -32,41 +32,41 @@ services:
 # Enable Traefik for this service, to make it available in the public network
 - traefik.enable=true
 # Use the traefik-public network (declared below)
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 # Use the custom label "traefik.constraint-label=traefik-public"
 # This public Traefik will only use services with this label
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 # traefik-http set up only to use the middleware to redirect to https
 - traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.scheme=https
 - traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.permanent=true
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.scheme=https
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.permanent=true
 # Handle host with and without "www" to redirect to only one of them
 # Uses environment variable DOMAIN
 # To disable www redirection remove the Host() you want to discard, here and
 # below for HTTPS
 - traefik.http.routers.${STACK_NAME}-proxy-http.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-proxy-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.entrypoints=http
 # traefik-https the actual router using HTTPS
 - traefik.http.routers.${STACK_NAME}-proxy-https.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-proxy-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-proxy-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls=true
 # Use the "le" (Let's Encrypt) resolver created below
 - traefik.http.routers.${STACK_NAME}-proxy-https.tls.certresolver=le
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls.certresolver=le
 # Define the port inside of the Docker service to use
 - traefik.http.services.${STACK_NAME}-proxy.loadbalancer.server.port=80
 - traefik.http.services.${STACK_NAME?Variable not set}-proxy.loadbalancer.server.port=80
 # Handle domain with and without "www" to redirect to only one
 # To disable www redirection remove the next line
 - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN})/(.*)
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN?Variable not set})/(.*)
 # Redirect a domain with www to non-www
 # To disable it remove the next line
 - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://${DOMAIN}/$${3}
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.replacement=https://${DOMAIN?Variable not set}/$${3}
 # Redirect a domain without www to www
 # To enable it remove the previous line and uncomment the next
 # - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://www.${DOMAIN}/$${3}
 # Middleware to redirect www, to disable it remove the next line 
 - traefik.http.routers.${STACK_NAME}-proxy-https.middlewares=${STACK_NAME}-www-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.middlewares=${STACK_NAME?Variable not set}-www-redirect
 # Middleware to redirect www, and redirect HTTP to HTTPS
 # to disable www redirection remove the section: ${STACK_NAME}-www-redirect,
 - traefik.http.routers.${STACK_NAME}-proxy-http.middlewares=${STACK_NAME}-www-redirect,${STACK_NAME}-https-redirect
 # to disable www redirection remove the section: ${STACK_NAME?Variable not set}-www-redirect,
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.middlewares=${STACK_NAME?Variable not set}-www-redirect,${STACK_NAME?Variable not set}-https-redirect

 db:
 image: postgres:12
Expand All@@ -79,12 +79,12 @@ services:
 deploy:
 placement:
 constraints:
 - node.labels.${STACK_NAME}.app-db-data == true
 - node.labels.${STACK_NAME?Variable not set}.app-db-data == true

 pgadmin:
 image: dpage/pgadmin4
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 depends_on:
 - db
Expand All@@ -93,16 +93,16 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.middlewares=${STACK_NAME}-https-redirect
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME}-pgadmin.loadbalancer.server.port=5050
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050

 queue:
 image: rabbitmq:3
Expand All@@ -114,7 +114,7 @@ services:
 flower:
 image: mher/flower
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 env_file:
 - .env
Expand All@@ -126,26 +126,26 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.http.routers.${STACK_NAME}-flower-http.rule=Host(`flower.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-flower-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME}-flower-http.middlewares=${STACK_NAME}-https-redirect
 - traefik.http.routers.${STACK_NAME}-flower-https.rule=Host(`flower.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-flower-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-flower-https.tls=true
 - traefik.http.routers.${STACK_NAME}-flower-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME}-flower.loadbalancer.server.port=5555
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.rule=Host(`flower.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.rule=Host(`flower.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-flower.loadbalancer.server.port=5555

 backend:
 image: '${DOCKER_IMAGE_BACKEND}:${TAG-latest}'
 image: '${DOCKER_IMAGE_BACKEND?Variable not set}:${TAG-latest}'
 depends_on:
 - db
 env_file:
 - .env
 environment:
 - SERVER_NAME=${DOMAIN}
 - SERVER_HOST=https://${DOMAIN}
 - SERVER_NAME=${DOMAIN?Variable not set}
 - SERVER_HOST=https://${DOMAIN?Variable not set}
 # Allow explicit env var override for tests
 - SMTP_HOST=${SMTP_HOST}
 build:
Expand All@@ -156,40 +156,40 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

 celeryworker:
 image: '${DOCKER_IMAGE_CELERYWORKER}:${TAG-latest}'
 image: '${DOCKER_IMAGE_CELERYWORKER?Variable not set}:${TAG-latest}'
 depends_on:
 - db
 - queue
 env_file:
 - .env
 environment:
 - SERVER_NAME=${DOMAIN}
 - SERVER_HOST=https://${DOMAIN}
 - SERVER_NAME=${DOMAIN?Variable not set}
 - SERVER_HOST=https://${DOMAIN?Variable not set}
 # Allow explicit env var override for tests
 - SMTP_HOST=${SMTP_HOST}
 - SMTP_HOST=${SMTP_HOST?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-false}

 frontend:
 image: '${DOCKER_IMAGE_FRONTEND}:${TAG-latest}'
 image: '${DOCKER_IMAGE_FRONTEND?Variable not set}:${TAG-latest}'
 build:
 context: ./frontend
 args:
 FRONTEND_ENV: ${FRONTEND_ENV-production}
 deploy:
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

volumes:
 app-db-data:
Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/scripts/build-push.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
sh ./scripts/build.sh

Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/scripts/build.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
docker-compose \
-f docker-compose.yml \
Expand Down

10 changes: 5 additions & 5 deletions
{{cookiecutter.project_slug}}/scripts/deploy.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,14 @@
# Exit in case of error
set -e

DOMAIN=${DOMAIN} \
TRAEFIK_TAG=${TRAEFIK_TAG} \
STACK_NAME=${STACK_NAME} \
TAG=${TAG} \
DOMAIN=${DOMAIN?Variable not set} \
TRAEFIK_TAG=${TRAEFIK_TAG?Variable not set} \
STACK_NAME=${STACK_NAME?Variable not set} \
TAG=${TAG?Variable not set} \
docker-compose \
-f docker-compose.yml \
config > docker-stack.yml

docker-auto-labels docker-stack.yml

docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
🔊 Add consistent errors for env vars not set#200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

May 25, 2020
 Merged


🔊 Add consistent errors for env vars not set
#200
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


12 changes: 7 additions & 5 deletions
{{cookiecutter.project_slug}}/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -489,10 +489,10 @@ services:
 deploy:
 placement:
 constraints:
 - node.labels.${STACK_NAME}.app-db-data == true
 - node.labels.${STACK_NAME?Variable not set}.app-db-data == true
```

note the `${STACK_NAME}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:
note the `${STACK_NAME?Variable not set}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:

```yaml
version: '3'
Expand All@@ -506,6 +506,8 @@ services:
 - node.labels.{{cookiecutter.docker_swarm_stack_name_main}}.app-db-data == true
```

**Note**: The `${STACK_NAME?Variable not set}` means "use the environment variable `STACK_NAME`, but if it is not set, show an error `Variable not set`".

If you add more volumes to your stack, you need to make sure you add the corresponding constraints to the services that use that named volume.

Then you have to create those labels in some nodes in your Docker Swarm mode cluster. You can use `docker-auto-labels` to do it automatically.
Expand DownExpand Up@@ -632,10 +634,10 @@ You can do the process by hand based on those same scripts if you wanted. The ge
```bash
# Use the environment variables passed to this script, as TAG and FRONTEND_ENV
# And re-create those variables as environment variables for the next command
TAG=${TAG} \
TAG=${TAG?Variable not set} \
# Set the environment variable FRONTEND_ENV to the same value passed to this script with
# a default value of "production" if nothing else was passed
FRONTEND_ENV=${FRONTEND_ENV-production} \
FRONTEND_ENV=${FRONTEND_ENV-production?Variable not set} \
# The actual comand that does the work: docker-compose
docker-compose \
# Pass the file that should be used, setting explicitly docker-compose.yml avoids the
Expand All@@ -653,7 +655,7 @@ config > docker-stack.yml
docker-auto-labels docker-stack.yml

# Now this command uses that same file to deploy it
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"
```

### Continuous Integration / Continuous Delivery
Expand Down

22 changes: 11 additions & 11 deletions
{{cookiecutter.project_slug}}/docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ services:
 - --providers.docker
 # Add a constraint to only use services with the label for this stack
 # from the env var TRAEFIK_TAG
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
 # Do not expose all Docker services, only the ones explicitly exposed
 - --providers.docker.exposedbydefault=false
 # Disable Docker Swarm mode for local development
Expand All@@ -25,8 +25,8 @@ services:
 - --api.insecure=true
 labels:
 - traefik.enable=true
 - traefik.http.routers.${STACK_NAME}-traefik-public-http.rule=Host(`${DOMAIN}`)
 - traefik.http.services.${STACK_NAME}-traefik-public.loadbalancer.server.port=80
 - traefik.http.routers.${STACK_NAME?Variable not set}-traefik-public-http.rule=Host(`${DOMAIN?Variable not set}`)
 - traefik.http.services.${STACK_NAME?Variable not set}-traefik-public.loadbalancer.server.port=80

 pgadmin:
 ports:
Expand All@@ -43,7 +43,7 @@ services:
 - ./backend/app:/app
 environment:
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN}
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: backend.dockerfile
Expand All@@ -54,17 +54,17 @@ services:
 command: /start-reload.sh
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

 celeryworker:
 volumes:
 - ./backend/app:/app
 environment:
 - RUN=celery worker -A app.worker -l info -Q main-queue -c 1
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN}
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
Expand All@@ -79,9 +79,9 @@ services:
 FRONTEND_ENV: dev
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

networks:
 traefik-public:
Expand Down

110 changes: 55 additions & 55 deletions
{{cookiecutter.project_slug}}/docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ services:
 proxy:
 image: traefik:v2.2
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 volumes:
 - /var/run/docker.sock:/var/run/docker.sock
Expand All@@ -13,7 +13,7 @@ services:
 - --providers.docker
 # Add a constraint to only use services with the label for this stack
 # from the env var TRAEFIK_TAG
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
 # Do not expose all Docker services, only the ones explicitly exposed
 - --providers.docker.exposedbydefault=false
 # Enable Docker Swarm mode
Expand All@@ -32,41 +32,41 @@ services:
 # Enable Traefik for this service, to make it available in the public network
 - traefik.enable=true
 # Use the traefik-public network (declared below)
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 # Use the custom label "traefik.constraint-label=traefik-public"
 # This public Traefik will only use services with this label
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 # traefik-http set up only to use the middleware to redirect to https
 - traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.scheme=https
 - traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.permanent=true
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.scheme=https
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.permanent=true
 # Handle host with and without "www" to redirect to only one of them
 # Uses environment variable DOMAIN
 # To disable www redirection remove the Host() you want to discard, here and
 # below for HTTPS
 - traefik.http.routers.${STACK_NAME}-proxy-http.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-proxy-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.entrypoints=http
 # traefik-https the actual router using HTTPS
 - traefik.http.routers.${STACK_NAME}-proxy-https.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-proxy-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-proxy-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls=true
 # Use the "le" (Let's Encrypt) resolver created below
 - traefik.http.routers.${STACK_NAME}-proxy-https.tls.certresolver=le
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls.certresolver=le
 # Define the port inside of the Docker service to use
 - traefik.http.services.${STACK_NAME}-proxy.loadbalancer.server.port=80
 - traefik.http.services.${STACK_NAME?Variable not set}-proxy.loadbalancer.server.port=80
 # Handle domain with and without "www" to redirect to only one
 # To disable www redirection remove the next line
 - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN})/(.*)
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN?Variable not set})/(.*)
 # Redirect a domain with www to non-www
 # To disable it remove the next line
 - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://${DOMAIN}/$${3}
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.replacement=https://${DOMAIN?Variable not set}/$${3}
 # Redirect a domain without www to www
 # To enable it remove the previous line and uncomment the next
 # - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://www.${DOMAIN}/$${3}
 # Middleware to redirect www, to disable it remove the next line 
 - traefik.http.routers.${STACK_NAME}-proxy-https.middlewares=${STACK_NAME}-www-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.middlewares=${STACK_NAME?Variable not set}-www-redirect
 # Middleware to redirect www, and redirect HTTP to HTTPS
 # to disable www redirection remove the section: ${STACK_NAME}-www-redirect,
 - traefik.http.routers.${STACK_NAME}-proxy-http.middlewares=${STACK_NAME}-www-redirect,${STACK_NAME}-https-redirect
 # to disable www redirection remove the section: ${STACK_NAME?Variable not set}-www-redirect,
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.middlewares=${STACK_NAME?Variable not set}-www-redirect,${STACK_NAME?Variable not set}-https-redirect

 db:
 image: postgres:12
Expand All@@ -79,12 +79,12 @@ services:
 deploy:
 placement:
 constraints:
 - node.labels.${STACK_NAME}.app-db-data == true
 - node.labels.${STACK_NAME?Variable not set}.app-db-data == true

 pgadmin:
 image: dpage/pgadmin4
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 depends_on:
 - db
Expand All@@ -93,16 +93,16 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.middlewares=${STACK_NAME}-https-redirect
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME}-pgadmin.loadbalancer.server.port=5050
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050

 queue:
 image: rabbitmq:3
Expand All@@ -114,7 +114,7 @@ services:
 flower:
 image: mher/flower
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 env_file:
 - .env
Expand All@@ -126,26 +126,26 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.http.routers.${STACK_NAME}-flower-http.rule=Host(`flower.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-flower-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME}-flower-http.middlewares=${STACK_NAME}-https-redirect
 - traefik.http.routers.${STACK_NAME}-flower-https.rule=Host(`flower.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-flower-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-flower-https.tls=true
 - traefik.http.routers.${STACK_NAME}-flower-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME}-flower.loadbalancer.server.port=5555
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.rule=Host(`flower.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.rule=Host(`flower.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-flower.loadbalancer.server.port=5555

 backend:
 image: '${DOCKER_IMAGE_BACKEND}:${TAG-latest}'
 image: '${DOCKER_IMAGE_BACKEND?Variable not set}:${TAG-latest}'
 depends_on:
 - db
 env_file:
 - .env
 environment:
 - SERVER_NAME=${DOMAIN}
 - SERVER_HOST=https://${DOMAIN}
 - SERVER_NAME=${DOMAIN?Variable not set}
 - SERVER_HOST=https://${DOMAIN?Variable not set}
 # Allow explicit env var override for tests
 - SMTP_HOST=${SMTP_HOST}
 build:
Expand All@@ -156,40 +156,40 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

 celeryworker:
 image: '${DOCKER_IMAGE_CELERYWORKER}:${TAG-latest}'
 image: '${DOCKER_IMAGE_CELERYWORKER?Variable not set}:${TAG-latest}'
 depends_on:
 - db
 - queue
 env_file:
 - .env
 environment:
 - SERVER_NAME=${DOMAIN}
 - SERVER_HOST=https://${DOMAIN}
 - SERVER_NAME=${DOMAIN?Variable not set}
 - SERVER_HOST=https://${DOMAIN?Variable not set}
 # Allow explicit env var override for tests
 - SMTP_HOST=${SMTP_HOST}
 - SMTP_HOST=${SMTP_HOST?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-false}

 frontend:
 image: '${DOCKER_IMAGE_FRONTEND}:${TAG-latest}'
 image: '${DOCKER_IMAGE_FRONTEND?Variable not set}:${TAG-latest}'
 build:
 context: ./frontend
 args:
 FRONTEND_ENV: ${FRONTEND_ENV-production}
 deploy:
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

volumes:
 app-db-data:
Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/scripts/build-push.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
sh ./scripts/build.sh

Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/scripts/build.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
docker-compose \
-f docker-compose.yml \
Expand Down

10 changes: 5 additions & 5 deletions
{{cookiecutter.project_slug}}/scripts/deploy.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,14 @@
# Exit in case of error
set -e

DOMAIN=${DOMAIN} \
TRAEFIK_TAG=${TRAEFIK_TAG} \
STACK_NAME=${STACK_NAME} \
TAG=${TAG} \
DOMAIN=${DOMAIN?Variable not set} \
TRAEFIK_TAG=${TRAEFIK_TAG?Variable not set} \
STACK_NAME=${STACK_NAME?Variable not set} \
TAG=${TAG?Variable not set} \
docker-compose \
-f docker-compose.yml \
config > docker-stack.yml

docker-auto-labels docker-stack.yml

docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
🔊 Add consistent errors for env vars not set#200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

May 25, 2020
 Merged


🔊 Add consistent errors for env vars not set
#200
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


12 changes: 7 additions & 5 deletions
{{cookiecutter.project_slug}}/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -489,10 +489,10 @@ services:
 deploy:
 placement:
 constraints:
 - node.labels.${STACK_NAME}.app-db-data == true
 - node.labels.${STACK_NAME?Variable not set}.app-db-data == true
```

note the `${STACK_NAME}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:
note the `${STACK_NAME?Variable not set}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:

```yaml
version: '3'
Expand All@@ -506,6 +506,8 @@ services:
 - node.labels.{{cookiecutter.docker_swarm_stack_name_main}}.app-db-data == true
```

**Note**: The `${STACK_NAME?Variable not set}` means "use the environment variable `STACK_NAME`, but if it is not set, show an error `Variable not set`".

If you add more volumes to your stack, you need to make sure you add the corresponding constraints to the services that use that named volume.

Then you have to create those labels in some nodes in your Docker Swarm mode cluster. You can use `docker-auto-labels` to do it automatically.
Expand DownExpand Up@@ -632,10 +634,10 @@ You can do the process by hand based on those same scripts if you wanted. The ge
```bash
# Use the environment variables passed to this script, as TAG and FRONTEND_ENV
# And re-create those variables as environment variables for the next command
TAG=${TAG} \
TAG=${TAG?Variable not set} \
# Set the environment variable FRONTEND_ENV to the same value passed to this script with
# a default value of "production" if nothing else was passed
FRONTEND_ENV=${FRONTEND_ENV-production} \
FRONTEND_ENV=${FRONTEND_ENV-production?Variable not set} \
# The actual comand that does the work: docker-compose
docker-compose \
# Pass the file that should be used, setting explicitly docker-compose.yml avoids the
Expand All@@ -653,7 +655,7 @@ config > docker-stack.yml
docker-auto-labels docker-stack.yml

# Now this command uses that same file to deploy it
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"
```

### Continuous Integration / Continuous Delivery
Expand Down

22 changes: 11 additions & 11 deletions
{{cookiecutter.project_slug}}/docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ services:
 - --providers.docker
 # Add a constraint to only use services with the label for this stack
 # from the env var TRAEFIK_TAG
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
 # Do not expose all Docker services, only the ones explicitly exposed
 - --providers.docker.exposedbydefault=false
 # Disable Docker Swarm mode for local development
Expand All@@ -25,8 +25,8 @@ services:
 - --api.insecure=true
 labels:
 - traefik.enable=true
 - traefik.http.routers.${STACK_NAME}-traefik-public-http.rule=Host(`${DOMAIN}`)
 - traefik.http.services.${STACK_NAME}-traefik-public.loadbalancer.server.port=80
 - traefik.http.routers.${STACK_NAME?Variable not set}-traefik-public-http.rule=Host(`${DOMAIN?Variable not set}`)
 - traefik.http.services.${STACK_NAME?Variable not set}-traefik-public.loadbalancer.server.port=80

 pgadmin:
 ports:
Expand All@@ -43,7 +43,7 @@ services:
 - ./backend/app:/app
 environment:
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN}
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: backend.dockerfile
Expand All@@ -54,17 +54,17 @@ services:
 command: /start-reload.sh
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

 celeryworker:
 volumes:
 - ./backend/app:/app
 environment:
 - RUN=celery worker -A app.worker -l info -Q main-queue -c 1
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN}
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
Expand All@@ -79,9 +79,9 @@ services:
 FRONTEND_ENV: dev
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

networks:
 traefik-public:
Expand Down

110 changes: 55 additions & 55 deletions
{{cookiecutter.project_slug}}/docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ services:
 proxy:
 image: traefik:v2.2
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 volumes:
 - /var/run/docker.sock:/var/run/docker.sock
Expand All@@ -13,7 +13,7 @@ services:
 - --providers.docker
 # Add a constraint to only use services with the label for this stack
 # from the env var TRAEFIK_TAG
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
 # Do not expose all Docker services, only the ones explicitly exposed
 - --providers.docker.exposedbydefault=false
 # Enable Docker Swarm mode
Expand All@@ -32,41 +32,41 @@ services:
 # Enable Traefik for this service, to make it available in the public network
 - traefik.enable=true
 # Use the traefik-public network (declared below)
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 # Use the custom label "traefik.constraint-label=traefik-public"
 # This public Traefik will only use services with this label
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 # traefik-http set up only to use the middleware to redirect to https
 - traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.scheme=https
 - traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.permanent=true
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.scheme=https
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.permanent=true
 # Handle host with and without "www" to redirect to only one of them
 # Uses environment variable DOMAIN
 # To disable www redirection remove the Host() you want to discard, here and
 # below for HTTPS
 - traefik.http.routers.${STACK_NAME}-proxy-http.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-proxy-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.entrypoints=http
 # traefik-https the actual router using HTTPS
 - traefik.http.routers.${STACK_NAME}-proxy-https.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-proxy-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-proxy-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls=true
 # Use the "le" (Let's Encrypt) resolver created below
 - traefik.http.routers.${STACK_NAME}-proxy-https.tls.certresolver=le
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls.certresolver=le
 # Define the port inside of the Docker service to use
 - traefik.http.services.${STACK_NAME}-proxy.loadbalancer.server.port=80
 - traefik.http.services.${STACK_NAME?Variable not set}-proxy.loadbalancer.server.port=80
 # Handle domain with and without "www" to redirect to only one
 # To disable www redirection remove the next line
 - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN})/(.*)
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN?Variable not set})/(.*)
 # Redirect a domain with www to non-www
 # To disable it remove the next line
 - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://${DOMAIN}/$${3}
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.replacement=https://${DOMAIN?Variable not set}/$${3}
 # Redirect a domain without www to www
 # To enable it remove the previous line and uncomment the next
 # - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://www.${DOMAIN}/$${3}
 # Middleware to redirect www, to disable it remove the next line 
 - traefik.http.routers.${STACK_NAME}-proxy-https.middlewares=${STACK_NAME}-www-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.middlewares=${STACK_NAME?Variable not set}-www-redirect
 # Middleware to redirect www, and redirect HTTP to HTTPS
 # to disable www redirection remove the section: ${STACK_NAME}-www-redirect,
 - traefik.http.routers.${STACK_NAME}-proxy-http.middlewares=${STACK_NAME}-www-redirect,${STACK_NAME}-https-redirect
 # to disable www redirection remove the section: ${STACK_NAME?Variable not set}-www-redirect,
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.middlewares=${STACK_NAME?Variable not set}-www-redirect,${STACK_NAME?Variable not set}-https-redirect

 db:
 image: postgres:12
Expand All@@ -79,12 +79,12 @@ services:
 deploy:
 placement:
 constraints:
 - node.labels.${STACK_NAME}.app-db-data == true
 - node.labels.${STACK_NAME?Variable not set}.app-db-data == true

 pgadmin:
 image: dpage/pgadmin4
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 depends_on:
 - db
Expand All@@ -93,16 +93,16 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.middlewares=${STACK_NAME}-https-redirect
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME}-pgadmin.loadbalancer.server.port=5050
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050

 queue:
 image: rabbitmq:3
Expand All@@ -114,7 +114,7 @@ services:
 flower:
 image: mher/flower
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 env_file:
 - .env
Expand All@@ -126,26 +126,26 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.http.routers.${STACK_NAME}-flower-http.rule=Host(`flower.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-flower-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME}-flower-http.middlewares=${STACK_NAME}-https-redirect
 - traefik.http.routers.${STACK_NAME}-flower-https.rule=Host(`flower.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-flower-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-flower-https.tls=true
 - traefik.http.routers.${STACK_NAME}-flower-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME}-flower.loadbalancer.server.port=5555
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.rule=Host(`flower.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.rule=Host(`flower.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-flower.loadbalancer.server.port=5555

 backend:
 image: '${DOCKER_IMAGE_BACKEND}:${TAG-latest}'
 image: '${DOCKER_IMAGE_BACKEND?Variable not set}:${TAG-latest}'
 depends_on:
 - db
 env_file:
 - .env
 environment:
 - SERVER_NAME=${DOMAIN}
 - SERVER_HOST=https://${DOMAIN}
 - SERVER_NAME=${DOMAIN?Variable not set}
 - SERVER_HOST=https://${DOMAIN?Variable not set}
 # Allow explicit env var override for tests
 - SMTP_HOST=${SMTP_HOST}
 build:
Expand All@@ -156,40 +156,40 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

 celeryworker:
 image: '${DOCKER_IMAGE_CELERYWORKER}:${TAG-latest}'
 image: '${DOCKER_IMAGE_CELERYWORKER?Variable not set}:${TAG-latest}'
 depends_on:
 - db
 - queue
 env_file:
 - .env
 environment:
 - SERVER_NAME=${DOMAIN}
 - SERVER_HOST=https://${DOMAIN}
 - SERVER_NAME=${DOMAIN?Variable not set}
 - SERVER_HOST=https://${DOMAIN?Variable not set}
 # Allow explicit env var override for tests
 - SMTP_HOST=${SMTP_HOST}
 - SMTP_HOST=${SMTP_HOST?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-false}

 frontend:
 image: '${DOCKER_IMAGE_FRONTEND}:${TAG-latest}'
 image: '${DOCKER_IMAGE_FRONTEND?Variable not set}:${TAG-latest}'
 build:
 context: ./frontend
 args:
 FRONTEND_ENV: ${FRONTEND_ENV-production}
 deploy:
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

volumes:
 app-db-data:
Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/scripts/build-push.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
sh ./scripts/build.sh

Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/scripts/build.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
docker-compose \
-f docker-compose.yml \
Expand Down

10 changes: 5 additions & 5 deletions
{{cookiecutter.project_slug}}/scripts/deploy.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,14 @@
# Exit in case of error
set -e

DOMAIN=${DOMAIN} \
TRAEFIK_TAG=${TRAEFIK_TAG} \
STACK_NAME=${STACK_NAME} \
TAG=${TAG} \
DOMAIN=${DOMAIN?Variable not set} \
TRAEFIK_TAG=${TRAEFIK_TAG?Variable not set} \
STACK_NAME=${STACK_NAME?Variable not set} \
TAG=${TAG?Variable not set} \
docker-compose \
-f docker-compose.yml \
config > docker-stack.yml

docker-auto-labels docker-stack.yml

docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
🔊 Add consistent errors for env vars not set#200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

May 25, 2020
 Merged


🔊 Add consistent errors for env vars not set
#200
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


12 changes: 7 additions & 5 deletions
{{cookiecutter.project_slug}}/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -489,10 +489,10 @@ services:
 deploy:
 placement:
 constraints:
 - node.labels.${STACK_NAME}.app-db-data == true
 - node.labels.${STACK_NAME?Variable not set}.app-db-data == true
```

note the `${STACK_NAME}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:
note the `${STACK_NAME?Variable not set}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:

```yaml
version: '3'
Expand All@@ -506,6 +506,8 @@ services:
 - node.labels.{{cookiecutter.docker_swarm_stack_name_main}}.app-db-data == true
```

**Note**: The `${STACK_NAME?Variable not set}` means "use the environment variable `STACK_NAME`, but if it is not set, show an error `Variable not set`".

If you add more volumes to your stack, you need to make sure you add the corresponding constraints to the services that use that named volume.

Then you have to create those labels in some nodes in your Docker Swarm mode cluster. You can use `docker-auto-labels` to do it automatically.
Expand DownExpand Up@@ -632,10 +634,10 @@ You can do the process by hand based on those same scripts if you wanted. The ge
```bash
# Use the environment variables passed to this script, as TAG and FRONTEND_ENV
# And re-create those variables as environment variables for the next command
TAG=${TAG} \
TAG=${TAG?Variable not set} \
# Set the environment variable FRONTEND_ENV to the same value passed to this script with
# a default value of "production" if nothing else was passed
FRONTEND_ENV=${FRONTEND_ENV-production} \
FRONTEND_ENV=${FRONTEND_ENV-production?Variable not set} \
# The actual comand that does the work: docker-compose
docker-compose \
# Pass the file that should be used, setting explicitly docker-compose.yml avoids the
Expand All@@ -653,7 +655,7 @@ config > docker-stack.yml
docker-auto-labels docker-stack.yml

# Now this command uses that same file to deploy it
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"
```

### Continuous Integration / Continuous Delivery
Expand Down

22 changes: 11 additions & 11 deletions
{{cookiecutter.project_slug}}/docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ services:
 - --providers.docker
 # Add a constraint to only use services with the label for this stack
 # from the env var TRAEFIK_TAG
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
 # Do not expose all Docker services, only the ones explicitly exposed
 - --providers.docker.exposedbydefault=false
 # Disable Docker Swarm mode for local development
Expand All@@ -25,8 +25,8 @@ services:
 - --api.insecure=true
 labels:
 - traefik.enable=true
 - traefik.http.routers.${STACK_NAME}-traefik-public-http.rule=Host(`${DOMAIN}`)
 - traefik.http.services.${STACK_NAME}-traefik-public.loadbalancer.server.port=80
 - traefik.http.routers.${STACK_NAME?Variable not set}-traefik-public-http.rule=Host(`${DOMAIN?Variable not set}`)
 - traefik.http.services.${STACK_NAME?Variable not set}-traefik-public.loadbalancer.server.port=80

 pgadmin:
 ports:
Expand All@@ -43,7 +43,7 @@ services:
 - ./backend/app:/app
 environment:
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN}
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: backend.dockerfile
Expand All@@ -54,17 +54,17 @@ services:
 command: /start-reload.sh
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

 celeryworker:
 volumes:
 - ./backend/app:/app
 environment:
 - RUN=celery worker -A app.worker -l info -Q main-queue -c 1
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN}
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
Expand All@@ -79,9 +79,9 @@ services:
 FRONTEND_ENV: dev
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

networks:
 traefik-public:
Expand Down

110 changes: 55 additions & 55 deletions
{{cookiecutter.project_slug}}/docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ services:
 proxy:
 image: traefik:v2.2
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 volumes:
 - /var/run/docker.sock:/var/run/docker.sock
Expand All@@ -13,7 +13,7 @@ services:
 - --providers.docker
 # Add a constraint to only use services with the label for this stack
 # from the env var TRAEFIK_TAG
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
 # Do not expose all Docker services, only the ones explicitly exposed
 - --providers.docker.exposedbydefault=false
 # Enable Docker Swarm mode
Expand All@@ -32,41 +32,41 @@ services:
 # Enable Traefik for this service, to make it available in the public network
 - traefik.enable=true
 # Use the traefik-public network (declared below)
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 # Use the custom label "traefik.constraint-label=traefik-public"
 # This public Traefik will only use services with this label
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 # traefik-http set up only to use the middleware to redirect to https
 - traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.scheme=https
 - traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.permanent=true
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.scheme=https
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.permanent=true
 # Handle host with and without "www" to redirect to only one of them
 # Uses environment variable DOMAIN
 # To disable www redirection remove the Host() you want to discard, here and
 # below for HTTPS
 - traefik.http.routers.${STACK_NAME}-proxy-http.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-proxy-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.entrypoints=http
 # traefik-https the actual router using HTTPS
 - traefik.http.routers.${STACK_NAME}-proxy-https.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-proxy-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-proxy-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls=true
 # Use the "le" (Let's Encrypt) resolver created below
 - traefik.http.routers.${STACK_NAME}-proxy-https.tls.certresolver=le
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls.certresolver=le
 # Define the port inside of the Docker service to use
 - traefik.http.services.${STACK_NAME}-proxy.loadbalancer.server.port=80
 - traefik.http.services.${STACK_NAME?Variable not set}-proxy.loadbalancer.server.port=80
 # Handle domain with and without "www" to redirect to only one
 # To disable www redirection remove the next line
 - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN})/(.*)
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN?Variable not set})/(.*)
 # Redirect a domain with www to non-www
 # To disable it remove the next line
 - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://${DOMAIN}/$${3}
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.replacement=https://${DOMAIN?Variable not set}/$${3}
 # Redirect a domain without www to www
 # To enable it remove the previous line and uncomment the next
 # - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://www.${DOMAIN}/$${3}
 # Middleware to redirect www, to disable it remove the next line 
 - traefik.http.routers.${STACK_NAME}-proxy-https.middlewares=${STACK_NAME}-www-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.middlewares=${STACK_NAME?Variable not set}-www-redirect
 # Middleware to redirect www, and redirect HTTP to HTTPS
 # to disable www redirection remove the section: ${STACK_NAME}-www-redirect,
 - traefik.http.routers.${STACK_NAME}-proxy-http.middlewares=${STACK_NAME}-www-redirect,${STACK_NAME}-https-redirect
 # to disable www redirection remove the section: ${STACK_NAME?Variable not set}-www-redirect,
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.middlewares=${STACK_NAME?Variable not set}-www-redirect,${STACK_NAME?Variable not set}-https-redirect

 db:
 image: postgres:12
Expand All@@ -79,12 +79,12 @@ services:
 deploy:
 placement:
 constraints:
 - node.labels.${STACK_NAME}.app-db-data == true
 - node.labels.${STACK_NAME?Variable not set}.app-db-data == true

 pgadmin:
 image: dpage/pgadmin4
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 depends_on:
 - db
Expand All@@ -93,16 +93,16 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.middlewares=${STACK_NAME}-https-redirect
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME}-pgadmin.loadbalancer.server.port=5050
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050

 queue:
 image: rabbitmq:3
Expand All@@ -114,7 +114,7 @@ services:
 flower:
 image: mher/flower
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 env_file:
 - .env
Expand All@@ -126,26 +126,26 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.http.routers.${STACK_NAME}-flower-http.rule=Host(`flower.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-flower-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME}-flower-http.middlewares=${STACK_NAME}-https-redirect
 - traefik.http.routers.${STACK_NAME}-flower-https.rule=Host(`flower.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-flower-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-flower-https.tls=true
 - traefik.http.routers.${STACK_NAME}-flower-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME}-flower.loadbalancer.server.port=5555
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.rule=Host(`flower.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.rule=Host(`flower.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-flower.loadbalancer.server.port=5555

 backend:
 image: '${DOCKER_IMAGE_BACKEND}:${TAG-latest}'
 image: '${DOCKER_IMAGE_BACKEND?Variable not set}:${TAG-latest}'
 depends_on:
 - db
 env_file:
 - .env
 environment:
 - SERVER_NAME=${DOMAIN}
 - SERVER_HOST=https://${DOMAIN}
 - SERVER_NAME=${DOMAIN?Variable not set}
 - SERVER_HOST=https://${DOMAIN?Variable not set}
 # Allow explicit env var override for tests
 - SMTP_HOST=${SMTP_HOST}
 build:
Expand All@@ -156,40 +156,40 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

 celeryworker:
 image: '${DOCKER_IMAGE_CELERYWORKER}:${TAG-latest}'
 image: '${DOCKER_IMAGE_CELERYWORKER?Variable not set}:${TAG-latest}'
 depends_on:
 - db
 - queue
 env_file:
 - .env
 environment:
 - SERVER_NAME=${DOMAIN}
 - SERVER_HOST=https://${DOMAIN}
 - SERVER_NAME=${DOMAIN?Variable not set}
 - SERVER_HOST=https://${DOMAIN?Variable not set}
 # Allow explicit env var override for tests
 - SMTP_HOST=${SMTP_HOST}
 - SMTP_HOST=${SMTP_HOST?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-false}

 frontend:
 image: '${DOCKER_IMAGE_FRONTEND}:${TAG-latest}'
 image: '${DOCKER_IMAGE_FRONTEND?Variable not set}:${TAG-latest}'
 build:
 context: ./frontend
 args:
 FRONTEND_ENV: ${FRONTEND_ENV-production}
 deploy:
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

volumes:
 app-db-data:
Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/scripts/build-push.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
sh ./scripts/build.sh

Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/scripts/build.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
docker-compose \
-f docker-compose.yml \
Expand Down

10 changes: 5 additions & 5 deletions
{{cookiecutter.project_slug}}/scripts/deploy.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,14 @@
# Exit in case of error
set -e

DOMAIN=${DOMAIN} \
TRAEFIK_TAG=${TRAEFIK_TAG} \
STACK_NAME=${STACK_NAME} \
TAG=${TAG} \
DOMAIN=${DOMAIN?Variable not set} \
TRAEFIK_TAG=${TRAEFIK_TAG?Variable not set} \
STACK_NAME=${STACK_NAME?Variable not set} \
TAG=${TAG?Variable not set} \
docker-compose \
-f docker-compose.yml \
config > docker-stack.yml

docker-auto-labels docker-stack.yml

docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
🔊 Add consistent errors for env vars not set#200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

May 25, 2020
 Merged


🔊 Add consistent errors for env vars not set
#200
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


12 changes: 7 additions & 5 deletions
{{cookiecutter.project_slug}}/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -489,10 +489,10 @@ services:
 deploy:
 placement:
 constraints:
 - node.labels.${STACK_NAME}.app-db-data == true
 - node.labels.${STACK_NAME?Variable not set}.app-db-data == true
```

note the `${STACK_NAME}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:
note the `${STACK_NAME?Variable not set}`. In the script `./scripts/deploy.sh`, the `docker-compose.yml` would be converted, and saved to a file `docker-stack.yml` containing:

```yaml
version: '3'
Expand All@@ -506,6 +506,8 @@ services:
 - node.labels.{{cookiecutter.docker_swarm_stack_name_main}}.app-db-data == true
```

**Note**: The `${STACK_NAME?Variable not set}` means "use the environment variable `STACK_NAME`, but if it is not set, show an error `Variable not set`".

If you add more volumes to your stack, you need to make sure you add the corresponding constraints to the services that use that named volume.

Then you have to create those labels in some nodes in your Docker Swarm mode cluster. You can use `docker-auto-labels` to do it automatically.
Expand DownExpand Up@@ -632,10 +634,10 @@ You can do the process by hand based on those same scripts if you wanted. The ge
```bash
# Use the environment variables passed to this script, as TAG and FRONTEND_ENV
# And re-create those variables as environment variables for the next command
TAG=${TAG} \
TAG=${TAG?Variable not set} \
# Set the environment variable FRONTEND_ENV to the same value passed to this script with
# a default value of "production" if nothing else was passed
FRONTEND_ENV=${FRONTEND_ENV-production} \
FRONTEND_ENV=${FRONTEND_ENV-production?Variable not set} \
# The actual comand that does the work: docker-compose
docker-compose \
# Pass the file that should be used, setting explicitly docker-compose.yml avoids the
Expand All@@ -653,7 +655,7 @@ config > docker-stack.yml
docker-auto-labels docker-stack.yml

# Now this command uses that same file to deploy it
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"
```

### Continuous Integration / Continuous Delivery
Expand Down

22 changes: 11 additions & 11 deletions
{{cookiecutter.project_slug}}/docker-compose.override.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ services:
 - --providers.docker
 # Add a constraint to only use services with the label for this stack
 # from the env var TRAEFIK_TAG
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
 # Do not expose all Docker services, only the ones explicitly exposed
 - --providers.docker.exposedbydefault=false
 # Disable Docker Swarm mode for local development
Expand All@@ -25,8 +25,8 @@ services:
 - --api.insecure=true
 labels:
 - traefik.enable=true
 - traefik.http.routers.${STACK_NAME}-traefik-public-http.rule=Host(`${DOMAIN}`)
 - traefik.http.services.${STACK_NAME}-traefik-public.loadbalancer.server.port=80
 - traefik.http.routers.${STACK_NAME?Variable not set}-traefik-public-http.rule=Host(`${DOMAIN?Variable not set}`)
 - traefik.http.services.${STACK_NAME?Variable not set}-traefik-public.loadbalancer.server.port=80

 pgadmin:
 ports:
Expand All@@ -43,7 +43,7 @@ services:
 - ./backend/app:/app
 environment:
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN}
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: backend.dockerfile
Expand All@@ -54,17 +54,17 @@ services:
 command: /start-reload.sh
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

 celeryworker:
 volumes:
 - ./backend/app:/app
 environment:
 - RUN=celery worker -A app.worker -l info -Q main-queue -c 1
 - JUPYTER=jupyter lab --ip=0.0.0.0 --allow-root --NotebookApp.custom_display_url=http://127.0.0.1:8888
 - SERVER_HOST=http://${DOMAIN}
 - SERVER_HOST=http://${DOMAIN?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
Expand All@@ -79,9 +79,9 @@ services:
 FRONTEND_ENV: dev
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

networks:
 traefik-public:
Expand Down

110 changes: 55 additions & 55 deletions
{{cookiecutter.project_slug}}/docker-compose.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ services:
 proxy:
 image: traefik:v2.2
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 volumes:
 - /var/run/docker.sock:/var/run/docker.sock
Expand All@@ -13,7 +13,7 @@ services:
 - --providers.docker
 # Add a constraint to only use services with the label for this stack
 # from the env var TRAEFIK_TAG
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG}`)
 - --providers.docker.constraints=Label(`traefik.constraint-label-stack`, `${TRAEFIK_TAG?Variable not set}`)
 # Do not expose all Docker services, only the ones explicitly exposed
 - --providers.docker.exposedbydefault=false
 # Enable Docker Swarm mode
Expand All@@ -32,41 +32,41 @@ services:
 # Enable Traefik for this service, to make it available in the public network
 - traefik.enable=true
 # Use the traefik-public network (declared below)
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 # Use the custom label "traefik.constraint-label=traefik-public"
 # This public Traefik will only use services with this label
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 # traefik-http set up only to use the middleware to redirect to https
 - traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.scheme=https
 - traefik.http.middlewares.${STACK_NAME}-https-redirect.redirectscheme.permanent=true
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.scheme=https
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-https-redirect.redirectscheme.permanent=true
 # Handle host with and without "www" to redirect to only one of them
 # Uses environment variable DOMAIN
 # To disable www redirection remove the Host() you want to discard, here and
 # below for HTTPS
 - traefik.http.routers.${STACK_NAME}-proxy-http.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-proxy-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.entrypoints=http
 # traefik-https the actual router using HTTPS
 - traefik.http.routers.${STACK_NAME}-proxy-https.rule=Host(`${DOMAIN}`) || Host(`www.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-proxy-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-proxy-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.rule=Host(`${DOMAIN?Variable not set}`) || Host(`www.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls=true
 # Use the "le" (Let's Encrypt) resolver created below
 - traefik.http.routers.${STACK_NAME}-proxy-https.tls.certresolver=le
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.tls.certresolver=le
 # Define the port inside of the Docker service to use
 - traefik.http.services.${STACK_NAME}-proxy.loadbalancer.server.port=80
 - traefik.http.services.${STACK_NAME?Variable not set}-proxy.loadbalancer.server.port=80
 # Handle domain with and without "www" to redirect to only one
 # To disable www redirection remove the next line
 - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN})/(.*)
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.regex=^https?://(www.)?(${DOMAIN?Variable not set})/(.*)
 # Redirect a domain with www to non-www
 # To disable it remove the next line
 - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://${DOMAIN}/$${3}
 - traefik.http.middlewares.${STACK_NAME?Variable not set}-www-redirect.redirectregex.replacement=https://${DOMAIN?Variable not set}/$${3}
 # Redirect a domain without www to www
 # To enable it remove the previous line and uncomment the next
 # - traefik.http.middlewares.${STACK_NAME}-www-redirect.redirectregex.replacement=https://www.${DOMAIN}/$${3}
 # Middleware to redirect www, to disable it remove the next line 
 - traefik.http.routers.${STACK_NAME}-proxy-https.middlewares=${STACK_NAME}-www-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-https.middlewares=${STACK_NAME?Variable not set}-www-redirect
 # Middleware to redirect www, and redirect HTTP to HTTPS
 # to disable www redirection remove the section: ${STACK_NAME}-www-redirect,
 - traefik.http.routers.${STACK_NAME}-proxy-http.middlewares=${STACK_NAME}-www-redirect,${STACK_NAME}-https-redirect
 # to disable www redirection remove the section: ${STACK_NAME?Variable not set}-www-redirect,
 - traefik.http.routers.${STACK_NAME?Variable not set}-proxy-http.middlewares=${STACK_NAME?Variable not set}-www-redirect,${STACK_NAME?Variable not set}-https-redirect

 db:
 image: postgres:12
Expand All@@ -79,12 +79,12 @@ services:
 deploy:
 placement:
 constraints:
 - node.labels.${STACK_NAME}.app-db-data == true
 - node.labels.${STACK_NAME?Variable not set}.app-db-data == true

 pgadmin:
 image: dpage/pgadmin4
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 depends_on:
 - db
Expand All@@ -93,16 +93,16 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME}-pgadmin-http.middlewares=${STACK_NAME}-https-redirect
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME}-pgadmin.loadbalancer.server.port=5050
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.rule=Host(`pgadmin.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-pgadmin-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-pgadmin.loadbalancer.server.port=5050

 queue:
 image: rabbitmq:3
Expand All@@ -114,7 +114,7 @@ services:
 flower:
 image: mher/flower
 networks:
 - ${TRAEFIK_PUBLIC_NETWORK}
 - ${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - default
 env_file:
 - .env
Expand All@@ -126,26 +126,26 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG}
 - traefik.http.routers.${STACK_NAME}-flower-http.rule=Host(`flower.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-flower-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME}-flower-http.middlewares=${STACK_NAME}-https-redirect
 - traefik.http.routers.${STACK_NAME}-flower-https.rule=Host(`flower.${DOMAIN}`)
 - traefik.http.routers.${STACK_NAME}-flower-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME}-flower-https.tls=true
 - traefik.http.routers.${STACK_NAME}-flower-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME}-flower.loadbalancer.server.port=5555
 - traefik.docker.network=${TRAEFIK_PUBLIC_NETWORK?Variable not set}
 - traefik.constraint-label=${TRAEFIK_PUBLIC_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.rule=Host(`flower.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.entrypoints=http
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-http.middlewares=${STACK_NAME?Variable not set}-https-redirect
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.rule=Host(`flower.${DOMAIN?Variable not set}`)
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.entrypoints=https
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls=true
 - traefik.http.routers.${STACK_NAME?Variable not set}-flower-https.tls.certresolver=le
 - traefik.http.services.${STACK_NAME?Variable not set}-flower.loadbalancer.server.port=5555

 backend:
 image: '${DOCKER_IMAGE_BACKEND}:${TAG-latest}'
 image: '${DOCKER_IMAGE_BACKEND?Variable not set}:${TAG-latest}'
 depends_on:
 - db
 env_file:
 - .env
 environment:
 - SERVER_NAME=${DOMAIN}
 - SERVER_HOST=https://${DOMAIN}
 - SERVER_NAME=${DOMAIN?Variable not set}
 - SERVER_HOST=https://${DOMAIN?Variable not set}
 # Allow explicit env var override for tests
 - SMTP_HOST=${SMTP_HOST}
 build:
Expand All@@ -156,40 +156,40 @@ services:
 deploy:
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME}-backend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-backend-http.rule=PathPrefix(`/api`) || PathPrefix(`/docs`) || PathPrefix(`/redoc`)
 - traefik.http.services.${STACK_NAME?Variable not set}-backend.loadbalancer.server.port=80

 celeryworker:
 image: '${DOCKER_IMAGE_CELERYWORKER}:${TAG-latest}'
 image: '${DOCKER_IMAGE_CELERYWORKER?Variable not set}:${TAG-latest}'
 depends_on:
 - db
 - queue
 env_file:
 - .env
 environment:
 - SERVER_NAME=${DOMAIN}
 - SERVER_HOST=https://${DOMAIN}
 - SERVER_NAME=${DOMAIN?Variable not set}
 - SERVER_HOST=https://${DOMAIN?Variable not set}
 # Allow explicit env var override for tests
 - SMTP_HOST=${SMTP_HOST}
 - SMTP_HOST=${SMTP_HOST?Variable not set}
 build:
 context: ./backend
 dockerfile: celeryworker.dockerfile
 args:
 INSTALL_DEV: ${INSTALL_DEV-false}

 frontend:
 image: '${DOCKER_IMAGE_FRONTEND}:${TAG-latest}'
 image: '${DOCKER_IMAGE_FRONTEND?Variable not set}:${TAG-latest}'
 build:
 context: ./frontend
 args:
 FRONTEND_ENV: ${FRONTEND_ENV-production}
 deploy:
 labels:
 - traefik.enable=true
 - traefik.constraint-label-stack=${TRAEFIK_TAG}
 - traefik.http.routers.${STACK_NAME}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME}-frontend.loadbalancer.server.port=80
 - traefik.constraint-label-stack=${TRAEFIK_TAG?Variable not set}
 - traefik.http.routers.${STACK_NAME?Variable not set}-frontend-http.rule=PathPrefix(`/`)
 - traefik.http.services.${STACK_NAME?Variable not set}-frontend.loadbalancer.server.port=80

volumes:
 app-db-data:
Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/scripts/build-push.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
sh ./scripts/build.sh

Expand Down

2 changes: 1 addition & 1 deletion
{{cookiecutter.project_slug}}/scripts/build.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
# Exit in case of error
set -e

TAG=${TAG} \
TAG=${TAG?Variable not set} \
FRONTEND_ENV=${FRONTEND_ENV-production} \
docker-compose \
-f docker-compose.yml \
Expand Down

10 changes: 5 additions & 5 deletions
{{cookiecutter.project_slug}}/scripts/deploy.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,14 +3,14 @@
# Exit in case of error
set -e

DOMAIN=${DOMAIN} \
TRAEFIK_TAG=${TRAEFIK_TAG} \
STACK_NAME=${STACK_NAME} \
TAG=${TAG} \
DOMAIN=${DOMAIN?Variable not set} \
TRAEFIK_TAG=${TRAEFIK_TAG?Variable not set} \
STACK_NAME=${STACK_NAME?Variable not set} \
TAG=${TAG?Variable not set} \
docker-compose \
-f docker-compose.yml \
config > docker-stack.yml

docker-auto-labels docker-stack.yml

docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME}"
docker stack deploy -c docker-stack.yml --with-registry-auth "${STACK_NAME?Variable not set}"