Skip to content
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.

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

feat (deploy): Replace wdqs-proxy with Traefik configuration #767

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion .github/actions/pull-ghcr/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ runs:
"elasticsearch"
"wdqs"
"wdqs-frontend"
"wdqs-proxy"
"quickstatements"
)

Expand Down
1 change: 0 additions & 1 deletion .github/workflows/_build_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ jobs:
- elasticsearch
- wdqs
- wdqs-frontend
- wdqs-proxy
- quickstatements

steps:
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/build_publish_image_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ on:
- 'quickstatements@*'
- 'wdqs@*'
- 'wdqs-frontend@*'
- 'wdqs-proxy@*'
- 'wikibase@*'

permissions:
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/create_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ on:
- quickstatements
- wdqs
- wdqs-frontend
- wdqs-proxy
- wikibase
- All projects (images and deploy) with unreleased changes
dry_run:
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,6 @@ WIKIBASE_CLIENT_URL=http://wikibase-client
QUICKSTATEMENTS_URL=http://quickstatements
WDQS_FRONTEND_URL=http://wdqs-frontend
WDQS_URL=http://wdqs:9999
WDQS_PROXY_URL=http://wdqs-proxy
MW_ADMIN_NAME=
MW_ADMIN_PASS=
MW_SCRIPT_PATH=/w
Expand Down
4 changes: 1 addition & 3 deletions build/wdqs-frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ services:
wdqs-frontend:
image: wikibase/wdqs-frontend
depends_on:
- wdqs-proxy
- wdqs
restart: unless-stopped
ports:
- 8834:80
Expand All @@ -146,8 +146,6 @@ services:
- "traefik.http.routers.wdqs-frontend.rule=Host(`query.example`)"
- "traefik.http.routers.wdqs-frontend.entrypoints=websecure"
- "traefik.http.routers.wdqs-frontend.tls.certresolver=letsencrypt"
environment:
WDQS_HOST: wdqs-proxy
healthcheck:
test: curl --silent --fail localhost
interval: 10s
Expand Down
14 changes: 0 additions & 14 deletions build/wdqs-proxy/Dockerfile

This file was deleted.

175 changes: 0 additions & 175 deletions build/wdqs-proxy/README.md

This file was deleted.

2 changes: 0 additions & 2 deletions build/wdqs-proxy/build.env

This file was deleted.

21 changes: 0 additions & 21 deletions build/wdqs-proxy/dockerhub.md

This file was deleted.

14 changes: 0 additions & 14 deletions build/wdqs-proxy/entrypoint.sh

This file was deleted.

11 changes: 0 additions & 11 deletions build/wdqs-proxy/package.json

This file was deleted.

34 changes: 0 additions & 34 deletions build/wdqs-proxy/wdqs.template

This file was deleted.

11 changes: 1 addition & 10 deletions build/wdqs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ You'll need one instance of the image to execute the updater started using `/run

### WDQS Proxy for public facing setups

By default, WDQS exposes some endpoints and methods that reveal internal details or functionality that might allow for abuse of the system. Wikibase Suite offers the [WDQS-proxy](../WDQS-proxy/README.md) which filters out all long-running or unwanted requests.

When running WDQS in a setup without WDQS-proxy, **please consider disabling these endpoints in some other way**.
By default, WDQS exposes some endpoints and methods that reveal internal details or functionality that might allow for abuse of the system. Wikibase Suite Deploy includes a Traefik-based proxy setup which filters out all long-running or unwanted requests. When running WDQS in a setup without a proxy, **please consider disabling these endpoints in some other way**.

### Environment variables

Expand Down Expand Up @@ -141,13 +139,6 @@ services:
soft: 32768
hard: 32768

wdqs-proxy:
image: wikibase/wdqs-proxy
depends_on:
wdqs:
condition: service_healthy
restart: unless-stopped

volumes:
wikibase-image-data:
mysql-data:
Expand Down
1 change: 0 additions & 1 deletion deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ WBS Deploy consists of the following services:
- **[Elasticsearch](https://hub.docker.com/r/wikibase/elasticsearch)** Search service used by MediaWiki.
- **[WDQS](https://hub.docker.com/r/wikibase/wdqs)** Wikidata Query Service to process SPARQL queries.
- **[WDQS Frontend](https://hub.docker.com/r/wikibase/wdqs-frontend)** Web front end for SPARQL queries.
- **[WDQS Proxy](https://hub.docker.com/r/wikibase/wdqs-proxy)** A middle layer for WDQS which serves to filter requests and make the service more secure.
- **[WDQS Updater](https://www.mediawiki.org/wiki/Wikidata_Query_Service/User_Manual#runUpdate.sh)** Keeps the WDQS data in sync with Wikibase.
- **[Quickstatements](https://hub.docker.com/r/wikibase/quickstatements)** A web-based tool to import and manipulate large amounts of data.
- **[Traefik](https://hub.docker.com/_/traefik)** A reverse proxy that handles TLS termination and SSL certificate renewal through ACME.
Expand Down
Loading
Loading