clean README.md

.github/workflows/deploy.yml

@@ -4,7 +4,7 @@
 #
 # To configure this workflow, set up secrets in your workspace:
 # 1. GCP_PROJECT with the name of the project
-# 2. GKE_SA_KEY with the Base64 encoded JSON service account key (https://github.com/GoogleCloudPlatform/github-actions/tree/docs/service-account-key/setup-gcloud#inputs).
+# 2. GCP_SA_KEY with the Base64 encoded JSON service account key (https://github.com/GoogleCloudPlatform/github-actions/tree/docs/service-account-key/setup-gcloud#inputs).
 # 3. AIVEN_*
 
 name: sitewatch deploy

README.md

@@ -2,7 +2,7 @@
 
 ![Retool demo](./sitewatch.gif)
 
-**(The UI is made in [Retool](https://retool.com/), drag-and-drop build-your-own-admin-UI service. It's very easy.)**
+**(The UI above was quickly made in [Retool](https://retool.com/), drag-and-drop build-your-own-admin-UI service.)**
 
 `sitewatch` is an experiment to play with:
 
@@ -14,6 +14,8 @@
 - [Posgres](https://www.postgresql.org/): LISTEN/NOTIFY
 - [Retool](https://retool.com/): quickly build admin UI
 
+It's also a template for a Python daemon running on Google Cloud.
+
 ## Start hacking
 
 Prerequisites:
@@ -22,29 +24,39 @@ Prerequisites:
 * [poetry](https://python-poetry.org/docs/#installation)
 * Docker
 * [Google Cloud SDK](https://cloud.google.com/sdk/docs/install)
+* [jq](https://stedolan.github.io/jq/)
+* Aiven project with Kafka and Postgres running
 
 Setup:
 ```
 poetry env use python3.9
 poetry install
 ```
 
-Start server directly:
+Load Aiven credentials and service URIs to `.env/` (replace `pg-123456` and `kafka-123456` with correct service names in Aiven):
 ```
-./start
+poetry run avn user login
+./save-aiven-creds pg-123456 kafka-123456
 ```
 
-Build and start Docker container:
+Start services directly:
 ```
-./docker-start
+./start watch
+./start report
+```
+
+Build and start services via Docker container:
+```
+./docker-start watch
+./docker-start report
 ```
 
 Lint and test:
 ```
 ./lint && ./test
 ```
 
-To update the snapshots (in case of "snapshots failed" error):
+To update test snapshots (in case of "snapshots failed" error):
 ```
 ./test.sh --snapshot-update
 ```
@@ -56,28 +68,32 @@ Format code with [black](https://github.com/ambv/black):
 
 ## Deploy
 
-Create Kafka and Postgres services on [Aiven](aiven.io). Add `report-topic` topic in Kafka. Note project name and services' names. For example: `project-12345`, `pg-123456`, `kafka-123456`.
-
-Install [jq](https://stedolan.github.io/jq/).
+Dependencies:
 
-Create Aiven access token and save it to `.env/`:
+* [Aiven](https://aiven.io): Kafka and Postgres
+* Google Cloud: [Containers](https://cloud.google.com/compute/docs/containers)
 
-```
-poetry run avn user access-token create --description 'google cloud container' --json | jq -r '.[0].full_token' > .env/AIVEN_TOKEN
-```
+Service is automatically deployed on each commit to `main` branch via GitHub Actions [deploy.yml](.github/workflows/deploy.yml) workflow. The workflow requires the following repository secrets to be defined:
 
-Configure Google Cloud SDK:
+| Secret name | Description |
+| --- | --- |
+| `AIVEN_TOKEN` | Aiven API token |
+| `AIVEN_EMAIL` | Aiven user email |
+| `AIVEN_PROJECT` | Aiven project name, e.g. `project-12345` |
+| `AIVEN_PG_SERVICE` | Aiven Postgres service name, e.g. `pg-123456` |
+| `AIVEN_KAFKA_SERVICE` | Aiven Kafka service name, e.g. `kafka-123456`. Should have `report-topic` topic. |
+| `GCP_PROJECT` | Google Cloud project name |
+| `GCP_SA_KEY` | Google Cloud service account key, see `deploy.yml` for details. |
 
+Getting `AIVEN_TOKEN`:
 ```
-gcloud init
-gcloud config set run/region europe-north1
+poetry run avn user access-token create --description 'google cloud container' --json | jq -r '.[0].full_token'
 ```
 
-*to be continued*
-
 ## View container logs on Compute Engine
 
 ```
+gcloud init
 ./logs watch
 ./logs report
 ```