mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-01-06 04:09:40 -06:00
Code Issues Packages Projects Releases Wiki Activity

[Docs-only] add version command to docs

Browse Source 
Signed-off-by: David Christofas <dchristofas@owncloud.com>
This commit is contained in:
David Christofas
2020-10-28 17:43:46 +01:00
parent e686c6786b
commit 788b18f3a7
8 changed files with 68 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/extensions/settings/getting-started.md
View File

@@ -160,7 +160,7 @@ The program provides a few sub-commands on execution. The available configuratio
The server command is used to start the http and debug server on two addresses within a single process. The http server is serving the general webservice while the debug server is used for health check, readiness check and to server the metrics mentioned below. For further help please execute:
{{< highlight txt >}}
ocis-settings server --help
settings server --help
{{< / highlight >}}
### Health
@@ -168,9 +168,16 @@ ocis-settings server --help
The health command is used to execute a health check, if the exit code equals zero the service should be up and running, if the exist code is greater than zero the service is not in a healthy state. Generally this command is used within our Docker containers, it could also be used within Kubernetes.
{{< highlight txt >}}
ocis-settings health --help
settings health --help
{{< / highlight >}}
### Version
The version command lists the versions of all running instances. For further help please execute:
{{< highlight txt >}}
settings version --help
{{< /highlight >}}
## Metrics
This service provides some [Prometheus](https://prometheus.io/) metrics through the debug endpoint, you can optionally secure the metrics endpoint by some random token, which got to be configured through one of the flag `--debug-token` or the environment variable `SETTINGS_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9194/metrics`.