docs: update readme

This commit is contained in:
Benjamin Labrecque
2026-07-17 14:29:39 +02:00
parent fe6c86490b
commit 2a9e546ac7
3 changed files with 86 additions and 1076 deletions
+31 -17
View File
@@ -1,17 +1,35 @@
# SLS HLA Framework
## Getting started
Install [uv](https://docs.astral.sh/uv/)
## CLI
Using the CLI:
```
cd cli
uv sync
source .venv/bin/activate
agebd --help
```
### Adding a new service
```
agebd service add --help
```
## Environments
The services are deployed to 2 environments:
- `prod`
- network: `machine`
- host: `sls-vserv-bd-hla01`
- path: `/sls/bd/hla/prod/`
- `dev`
- network: `office`
- host: `sls-vserv-bd-hla01-dev`
- path: `/sls/bd/hla/dev/`
| Environment | Network | Host | Deploy path on host |
|---|---|---|---|
|`prod` | `machine`| `sls-vserv-bd-hla01` | `/sls/bd/hla/prod/` |
| `dev` | `office` | `sls-vserv-bd-hla01-dev` | `/sls/bd/hla/dev/` |
### Process Variables (PVs)
@@ -45,15 +63,11 @@ i.e. there is no `dev` PV.
For python services there are 3 environments. The python environment is set through the env variable `AGEBD_ENV`.
- `prod`: used when deployed to `prod`
- PVs: uses `prod` PVs
- `AGEBD_ENV=prod`
- `dev`: used when deployed to `dev`
- PVs: uses `dev` PVs
- `AGEBD_ENV=dev`
- `local`: used when running code locally
- PVs: uses fake/mock python objects as PVs, no access to real PVs
- `AGEBD_ENV=local`
| Environment | PVs |
|---|---|
| `AGEBD_ENV=prod` | uses `prod` PVs |
| `AGEBD_ENV=dev` | uses `dev` PVs |
| `AGEBD_ENV=local` | uses fake/mock python objects as PVs, no access to real PVs |
## Hosts overview