mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2025-12-31 01:10:20 -06:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): better service startup explanation

Browse Source 
Co-authored-by: Martin <github@diemattels.at>
This commit is contained in:
kobergj
2024-11-29 15:37:39 +01:00
committed by GitHub
parent bfc626d276
commit 47bd5735e4
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/services/general-info/new-service-checklist.md
View File

@@ -28,8 +28,11 @@ Use this checklist with copy/paste in your PR - right from the beginning. It ren
- [ ] If new global envvars are introduced, the name must start with `OCIS_`.
- [ ] Add the service to the makefile in the ocis repo root.
- [ ] Service startup:
- For automatic startup: `ocis/pkg/runtime` (service/service.go)
- Exclude from automatic startup, add it to the `populate optional services` block
- add it to `ocis/pkg/command/services.go`
- Include for automatic startup:
- add it to `ocis/pkg/runtime/service/service.go`
- Exclude from automatic startup:
- add it to the `populate optional services` block in `ocis/pkg/runtime/service/service.go`
- Add the service config to `ocis-pkg/config/defaultconfig.go`
- [ ] If the service is using service accounts, add it to `ocis/pkg/init/init.go`
- [ ] Check that the service properly responds to `ocis <service-name> health` and has `/healthz` and `/readyz` endpoints