feat: deploy cities labeler

This commit is contained in:
gov committed 2026-11-04 16:55:41 -05:00
1 parent 98121c0195
commit f998954be9
7 files changed
+124 -1

No files matched your search

+10
View File
@@ -61,6 +61,16 @@ jobs:
echo "pds_email_smtp_url: ${{ secrets.SMTP_URL }}" >> vars/main.yml echo "pds_email_smtp_url: ${{ secrets.SMTP_URL }}" >> vars/main.yml
fi fi
echo "pds_email_from_address: techops@cosocial.ca" >> vars/main.yml echo "pds_email_from_address: techops@cosocial.ca" >> vars/main.yml
# Optional: cities labeler
if [ -n "${{ vars.PDS_CITIES_HOSTNAME }}" ]; then
cat >> vars/main.yml <<EOF
pds_cities_enabled: true
pds_cities_repo: ${{ vars.PDS_CITIES_REPO }}
pds_cities_hostname: ${{ vars.PDS_CITIES_HOSTNAME }}
pds_cities_app_password: ${{ secrets.PDS_CITIES_APP_PASSWORD }}
pds_cities_signing_key: ${{ secrets.PDS_CITIES_SIGNING_KEY }}
EOF
fi
- name: Run playbook - name: Run playbook
run: | run: |
+18
View File
@@ -107,6 +107,20 @@ Requires a recent PDS image (telemetry added in `@atproto/pds` 0.5.26, distro ta
| `pds_telemetry_enabled` | `false` | Enable OpenTelemetry + monitoring stack | | `pds_telemetry_enabled` | `false` | Enable OpenTelemetry + monitoring stack |
| `pds_grafana_image_tag` | `13.1.1` | Grafana Docker image tag (pinned — no floating major tag) | | `pds_grafana_image_tag` | `13.1.1` | Grafana Docker image tag (pinned — no floating major tag) |
### Cities labeler
Optional. Deploys [atproto-cosocial-labeler](https://git.cosocial.info/CoSocial-Canada/atproto-cosocial-labeler) (city badges requested over Bluesky DMs) to `/pds/cities`, behind Caddy at `pds_cities_hostname`. Its label database lives in `cities/data`, so it's included in PDS backups.
| Variable | Required | Default | Description |
|---|---|---|---|
| `pds_cities_enabled` | no | — | Deploy the cities labeler |
| `pds_cities_repo` | yes (if enabled) | — | Git URL of the labeler repo |
| `pds_cities_version` | no | `main` | Branch, tag, or commit to deploy |
| `pds_cities_hostname` | yes (if enabled) | — | Public DNS name for the labeler service (needs an A record) |
| `pds_cities_handle` | no | `cities.<pds_hostname>` | Labeler account handle |
| `pds_cities_app_password` | yes (if enabled) | — | Labeler account app password with DM access |
| `pds_cities_signing_key` | yes (if enabled) | — | Label signing key (hex); its public key must match the labeler's DID document |
### Backup service ### Backup service
| Variable | Required | Default | Description | | Variable | Required | Default | Description |
@@ -207,6 +221,8 @@ Auto-deploys on push to `main`. Set up these in Gitea repo settings (Settings >
| `PDS_TELEMETRY_ENABLED` | *(optional)* Set to `true` to enable telemetry + monitoring stack | | `PDS_TELEMETRY_ENABLED` | *(optional)* Set to `true` to enable telemetry + monitoring stack |
| `PDS_SERVICE_NAME` | *(optional)* PDS display name for branding | | `PDS_SERVICE_NAME` | *(optional)* PDS display name for branding |
| `PDS_PRIMARY_COLOR` | *(optional)* Primary color (hex) for branding | | `PDS_PRIMARY_COLOR` | *(optional)* Primary color (hex) for branding |
| `PDS_CITIES_HOSTNAME` | *(optional)* Set to deploy the cities labeler at this hostname |
| `PDS_CITIES_REPO` | *(with cities)* Git URL of the labeler repo |
Outgoing emails are sent from `techops@cosocial.ca` (fixed in the workflow). Outgoing emails are sent from `techops@cosocial.ca` (fixed in the workflow).
@@ -218,5 +234,7 @@ Outgoing emails are sent from `techops@cosocial.ca` (fixed in the workflow).
| `OVH_S3_ACCESS_KEY` | OVH S3 access key for blob storage | | `OVH_S3_ACCESS_KEY` | OVH S3 access key for blob storage |
| `OVH_S3_SECRET_KEY` | OVH S3 secret key for blob storage | | `OVH_S3_SECRET_KEY` | OVH S3 secret key for blob storage |
| `SMTP_URL` | *(optional)* SMTP URL with credentials (e.g., `smtps://user:pass@smtp.example.com/`) | | `SMTP_URL` | *(optional)* SMTP URL with credentials (e.g., `smtps://user:pass@smtp.example.com/`) |
| `PDS_CITIES_APP_PASSWORD` | *(with cities)* Labeler account app password with DM access |
| `PDS_CITIES_SIGNING_KEY` | *(with cities)* Label signing key (hex) |
The workflow installs Ansible, writes the SSH key from a secret, generates `inventory.yml` and `vars/main.yml` from vars and secrets, and runs the playbook. The workflow installs Ansible, writes the SSH key from a secret, generates `inventory.yml` and `vars/main.yml` from vars and secrets, and runs the playbook.
+48 -1
View File
@@ -192,6 +192,41 @@
when: pds_operator_enabled is defined and pds_operator_enabled | bool when: pds_operator_enabled is defined and pds_operator_enabled | bool
notify: restart operator notify: restart operator
- name: Clone cities labeler repo
git:
repo: "{{ pds_cities_repo }}"
dest: "{{ pds_data_dir }}/cities"
version: "{{ pds_cities_version | default('main') }}"
update: yes
force: no
when: pds_cities_enabled is defined and pds_cities_enabled | bool
notify: restart cities
- name: Create cities labeler data directory
file:
path: "{{ pds_data_dir }}/cities/data"
state: directory
owner: "1000"
group: "1000"
mode: "0755"
when: pds_cities_enabled is defined and pds_cities_enabled | bool
- name: Deploy cities labeler .env
template:
src: templates/cities-labeler.env.j2
dest: "{{ pds_data_dir }}/cities/.env"
mode: "0600"
when: pds_cities_enabled is defined and pds_cities_enabled | bool
notify: restart cities
- name: Deploy cities labeler compose
template:
src: templates/cities-labeler-compose.yaml.j2
dest: "{{ pds_data_dir }}/cities/compose.yaml"
mode: "0644"
when: pds_cities_enabled is defined and pds_cities_enabled | bool
notify: restart cities
- name: Create monitoring directories - name: Create monitoring directories
file: file:
path: "{{ item }}" path: "{{ item }}"
@@ -248,7 +283,7 @@
shell: cd {{ pds_data_dir }}/monitoring && docker compose up -d shell: cd {{ pds_data_dir }}/monitoring && docker compose up -d
when: pds_telemetry_enabled is defined and pds_telemetry_enabled | bool when: pds_telemetry_enabled is defined and pds_telemetry_enabled | bool
- name: Flush handlers (operator + monitoring) - name: Flush handlers (operator + cities + monitoring)
meta: flush_handlers meta: flush_handlers
- name: Operator health check - name: Operator health check
@@ -260,6 +295,15 @@
delay: 10 delay: 10
when: pds_operator_enabled is defined and pds_operator_enabled | bool when: pds_operator_enabled is defined and pds_operator_enabled | bool
- name: Cities labeler health check
uri:
url: "https://{{ pds_cities_hostname }}/xrpc/_health"
method: GET
status_code: 200
retries: 5
delay: 10
when: pds_cities_enabled is defined and pds_cities_enabled | bool
handlers: handlers:
- name: apply changes - name: apply changes
shell: cd {{ pds_data_dir }} && docker compose up -d && docker restart caddy shell: cd {{ pds_data_dir }} && docker compose up -d && docker restart caddy
@@ -269,3 +313,6 @@
- name: restart operator - name: restart operator
shell: cd {{ pds_data_dir }}/operator && docker compose up -d --build shell: cd {{ pds_data_dir }}/operator && docker compose up -d --build
- name: restart cities
shell: cd {{ pds_data_dir }}/cities && docker compose up -d --build
+9
View File
@@ -24,3 +24,12 @@
reverse_proxy http://localhost:8787 reverse_proxy http://localhost:8787
} }
{% endif %} {% endif %}
{% if pds_cities_enabled is defined and pds_cities_enabled | bool %}
{{ pds_cities_hostname }} {
log {
output stdout
format json
}
reverse_proxy http://localhost:4100
}
{% endif %}
+27
View File
@@ -0,0 +1,27 @@
name: cities-labeler
# Cities labeler — deployed by Ansible to
# {{ pds_data_dir }}/cities/compose.yaml
services:
app:
build: .
env_file: .env
ports:
- "127.0.0.1:4100:4100"
# the host's /etc/hosts maps the PDS hostname to 127.0.1.1 (cloud-init
# manage_etc_hosts), which Docker propagates to container DNS — pin the
# real address so the labeler can log in to the PDS
extra_hosts:
- "{{ pds_hostname }}:{{ hostvars[inventory_hostname].ansible_default_ipv4.address }}"
volumes:
# bind mount keeps the label database under /pds — captured by the backup tarball
- ./data:/data
# runs unprivileged; ./data must be owned by uid 1000
user: "1000:1000"
read_only: true
cap_drop:
- ALL
security_opt:
- no-new-privileges:true
restart: unless-stopped
+3
View File
@@ -0,0 +1,3 @@
LABELER_HANDLE={{ pds_cities_handle | default('cities.' ~ pds_hostname) }}
LABELER_APP_PASSWORD={{ pds_cities_app_password }}
SIGNING_KEY_HEX={{ pds_cities_signing_key }}
+9
View File
@@ -56,3 +56,12 @@ pds_operator_enabled: true
pds_operator_repo: https://tangled.org/brookie.blog/pds-operator pds_operator_repo: https://tangled.org/brookie.blog/pds-operator
pds_operator_version: main pds_operator_version: main
pds_operator_hostname: pds-operator.cosocial.ca pds_operator_hostname: pds-operator.cosocial.ca
# Cities labeler (DM-driven city badges, serves labels at pds_cities_hostname)
# pds_cities_enabled: true
# pds_cities_repo: https://git.cosocial.info/CoSocial-Canada/atproto-cosocial-labeler.git
# pds_cities_version: main
# pds_cities_hostname: cities-labeler.cosocial.ca
# pds_cities_handle: cities.pds.cosocial.ca
# pds_cities_app_password: CHANGE_ME # app password with DM access
# pds_cities_signing_key: CHANGE_ME # SIGNING_KEY_HEX; its public key is in the labeler's DID doc