Files
GuestOps/docs/deployment.md
T
2026-10-22 16:07:33 +01:00

82 lines
2.6 KiB
Markdown

# GuestOps deployment
GuestOps is deployed by the central Futuresens Ansible repository. Sandbox is
`https://sandbox-guestops.futuresens.co.uk` and production is
`https://guestops.futuresens.co.uk`.
## Prepare a version
The .NET version in `Directory.Build.props` and the frontend version in
`web/package.json` must match. Test the committed revision, then package it:
```sh
dotnet run --project tests/GuestOps.Tests
python3 -m unittest discover -s tests -p "test_*.py"
cd web && npm ci && npm run build && cd ..
python3 deploy/package_release.py \
--ref FULL_COMMIT_OR_TAG \
--output-directory ../ansible/playbooks/files/guestops
```
For version `0.2.2`, this creates `guestops_0.2.2.tar.gz`. The archive contains
self-contained Linux x64 API and worker applications, including the built
frontend. Published version files are immutable; change the application version
before making another archive.
## Configure Ansible
The server group needs only the application switch, version and subdomain:
```yaml
hasguestops: true
guestopsversion: "0.2.2"
guestopssubdomain: "sandbox-guestops"
```
Production uses `guestopssubdomain: "guestops"`. The native services use the
existing MongoDB service on `127.0.0.1:27017`. Google sending,
automatic live replies, AI, PMS connections, and payment connections remain
disabled until they are configured separately.
## Deploy
Deploy sandbox first:
```sh
ansible-playbook playbooks/guestops.yml -K \
--extra-vars "thehost=sandbox"
```
After acceptance, deploy the same versioned archive to production:
```sh
ansible-playbook playbooks/guestops.yml -K \
--extra-vars "thehost=dbserver"
```
The playbook stops the existing systemd services, replaces `/srv/guestops`,
renders its environment configuration, starts the self-contained API and worker,
configures an HTTP Nginx site when a certificate does not yet exist, and verifies
local readiness. Port 8080 remains loopback-only and
`/var/lib/guestops/keys` survives redeployment.
On the first deployment, create the certificate after the HTTP site is available:
```sh
sudo certbot --nginx \
-d sandbox-guestops.futuresens.co.uk \
--non-interactive \
--agree-tos \
-m dmccallum@futuresens.co.uk \
--redirect
```
For production, use `-d guestops.futuresens.co.uk`. Certbot updates the existing
Nginx site and manages renewal. Later GuestOps deployments detect the certificate
and leave that Certbot-managed site unchanged.
To roll back, select an older retained native `guestopsversion` (version 0.2.2 or
later) in group vars and run the same playbook. MongoDB backup, Filebeat, certificate
renewal, and host monitoring are provided by the existing central infrastructure.