From 788b18f3a790fba207dcc2b3702e65c48de90bbe Mon Sep 17 00:00:00 2001 From: David Christofas Date: Wed, 28 Oct 2020 17:43:46 +0100 Subject: [PATCH] [Docs-only] add version command to docs Signed-off-by: David Christofas --- docs/extensions/accounts/getting-started.md | 9 ++++++++- docs/extensions/konnectd/getting-started.md | 11 +++++++++-- docs/extensions/ocs/getting-started.md | 11 +++++++++-- docs/extensions/proxy/getting-started.md | 9 ++++++++- docs/extensions/settings/getting-started.md | 11 +++++++++-- docs/extensions/store/getting-started.md | 11 +++++++++-- docs/extensions/thumbnails/getting-started.md | 7 +++++++ docs/extensions/webdav/getting-started.md | 11 +++++++++-- 8 files changed, 68 insertions(+), 12 deletions(-) diff --git a/docs/extensions/accounts/getting-started.md b/docs/extensions/accounts/getting-started.md index 42c48962ef..79842c93fb 100644 --- a/docs/extensions/accounts/getting-started.md +++ b/docs/extensions/accounts/getting-started.md @@ -57,5 +57,12 @@ The program provides a few sub-commands on execution. The available configuratio The server command is used to start the grpc server. For further help please execute: {{< highlight txt >}} -ocis-accounts server --help +accounts server --help {{< / highlight >}} + +### Version +The version command lists the versions of all running instances. For further help please execute: + +{{< highlight txt >}} +accounts version --help +{{< /highlight >}} diff --git a/docs/extensions/konnectd/getting-started.md b/docs/extensions/konnectd/getting-started.md index 9806264eef..61eef70d9c 100644 --- a/docs/extensions/konnectd/getting-started.md +++ b/docs/extensions/konnectd/getting-started.md @@ -42,7 +42,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-konnectd server --help +konnectd server --help {{< / highlight >}} ### Health @@ -50,9 +50,16 @@ ocis-konnectd 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-konnectd health --help +konnectd health --help {{< / highlight >}} +### Version +The version command lists the versions of all running instances. For further help please execute: + +{{< highlight txt >}} +konnectd 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 `KONNECTD_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9134/metrics`. diff --git a/docs/extensions/ocs/getting-started.md b/docs/extensions/ocs/getting-started.md index 7a740bbc3f..c8466cda1e 100644 --- a/docs/extensions/ocs/getting-started.md +++ b/docs/extensions/ocs/getting-started.md @@ -42,7 +42,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-ocs server --help +ocs server --help {{< / highlight >}} ### Health @@ -50,9 +50,16 @@ ocis-ocs 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-ocs health --help +ocs health --help {{< / highlight >}} +### Version +The version command lists the versions of all running instances. For further help please execute: + +{{< highlight txt >}} +ocs 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 `OCS_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9114/metrics`. diff --git a/docs/extensions/proxy/getting-started.md b/docs/extensions/proxy/getting-started.md index 32cfe5f1c3..67a23addfd 100644 --- a/docs/extensions/proxy/getting-started.md +++ b/docs/extensions/proxy/getting-started.md @@ -42,5 +42,12 @@ The program provides a few sub-commands on execution. The available configuratio The server command is used to start the http server. For further help please execute: {{< highlight txt >}} -ocis-proxy server --help +proxy server --help {{< / highlight >}} + +### Version +The version command lists the versions of all running instances. For further help please execute: + +{{< highlight txt >}} +proxy version --help +{{< /highlight >}} diff --git a/docs/extensions/settings/getting-started.md b/docs/extensions/settings/getting-started.md index c662902374..de39ce398c 100644 --- a/docs/extensions/settings/getting-started.md +++ b/docs/extensions/settings/getting-started.md @@ -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`. diff --git a/docs/extensions/store/getting-started.md b/docs/extensions/store/getting-started.md index c806fd489a..6be81110d7 100644 --- a/docs/extensions/store/getting-started.md +++ b/docs/extensions/store/getting-started.md @@ -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-store server --help +store server --help {{< / highlight >}} ### Health @@ -168,9 +168,16 @@ ocis-store 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-store health --help +store health --help {{< / highlight >}} +### Version +The version command lists the versions of all running instances. For further help please execute: + +{{< highlight txt >}} +store 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 `STORE_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9460/metrics`. diff --git a/docs/extensions/thumbnails/getting-started.md b/docs/extensions/thumbnails/getting-started.md index e867637775..544e29c527 100644 --- a/docs/extensions/thumbnails/getting-started.md +++ b/docs/extensions/thumbnails/getting-started.md @@ -189,6 +189,13 @@ The health command is used to execute a health check, if the exit code equals ze {{ Name }} health --help {{< / highlight >}} +### Version +The version command lists the versions of all running instances. For further help please execute: + +{{< highlight txt >}} +{{ Name }} 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 `THUMBNAILS_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9114/metrics`. diff --git a/docs/extensions/webdav/getting-started.md b/docs/extensions/webdav/getting-started.md index 66f274c508..812a4eb995 100644 --- a/docs/extensions/webdav/getting-started.md +++ b/docs/extensions/webdav/getting-started.md @@ -157,7 +157,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-webdav server --help +webdav server --help {{< / highlight >}} #### Health @@ -165,9 +165,16 @@ ocis-webdav 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-webdav health --help +webdav health --help {{< / highlight >}} +### Version +The version command lists the versions of all running instances. For further help please execute: + +{{< highlight txt >}} +webdav 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 `WEBDAV_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9119/metrics`.