Skip to content

Commit 87f81a0

Browse files
committed
README: Update for clarity and helpfulness
1 parent dc12b65 commit 87f81a0

1 file changed

Lines changed: 18 additions & 5 deletions

File tree

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,28 @@ docker build -t telemetry2:latest . && \
6161
docker compose up
6262
```
6363

64-
### Deploying
64+
### Deploying with Kubernetes
6565

66-
#### One-time only: Setting up the schema
66+
#### Uploading to GitHub Container Registry (GHCR)
6767

68-
You shouldn't need to this, since it's already been done, but, before the app be used on the server, the relevant database needs to get set up with the schema from `sql/schema.sql`. @TheBizzle has scripts and YAML files laying around, showing how he did this, and can produce them upon request.
68+
To publish the Docker images from this repository for use on the cluster, navigate to [this GitHub Actions page](https://github.com/NetLogo/telemetry2/actions/workflows/publish-image.yaml) and click "Run workflow". After choosing the branch/tag that you want to publish, confirming your selection, and waiting less than a minute, the image should become available [here](https://github.com/NetLogo/telemetry2/pkgs/container/telemetry2).
6969

70-
#### Uploading to GitHub Container Registry (GHCR)
70+
#### One-time only: Configure variables and secrets
71+
72+
You shouldn't need to do this, since it's already been done, but, before the app can be used on the server, a few "secret" values need to be defined in Kubernetes:
73+
74+
* `pg-pretalx-credentials` (for root DB user)
75+
* `PGUSER`
76+
* `PGPASSWORD`
77+
* `telemetry2-db-credentials` (for the DB account that will be created for this app)
78+
* `PGUSER`
79+
* `PGPASSWORD`
80+
81+
#### One-time only: Setting up the schema
82+
83+
This is also already done on the real server, but note that setting up a fresh instance of this requires applying the schema from `sql/schema.sql`.
7184

72-
To publish the Docker images for use on the cluster, navigate to [this GitHub Actions page](https://github.com/NetLogo/telemetry2/actions/workflows/publish-image.yaml) and click "Run workflow". After choosing the branch/tag that you want to publish, confirming your selection, and waiting less than a minute, the image should become available [here](https://github.com/NetLogo/telemetry2/pkgs/container/telemetry2).
85+
The file for it is `kubernetes/00-initialize-db.yaml`. Note that it assumes a Postgres DB name of `postgres-pretalx`. It also assumes the presence of the secrets mentioned in the previous step.
7386

7487
#### Launching the containers
7588

0 commit comments

Comments
 (0)