commit 72491b4

Merge: d34b5dc 788b18f Author: Michael Barz <[email protected]> Date: Fri Oct 30 09:47:27 2020 +0100 Merge pull request #770 from owncloud/document-version-cmd [Docs-only] add version command to docs
owncloud · Oct 30, 2020 · 69d8ecc · 69d8ecc
1 parent b1e9041
commit 69d8ecc
Show file tree

Hide file tree

Showing 12 changed files with 276 additions and 220 deletions.
diff --git a/extensions/accounts/getting-started.md b/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/extensions/konnectd/configuration.md b/extensions/konnectd/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2020-10-29T12:23:47+0000"
+date: "2020-10-30T09:35:49+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis-konnectd
 geekdocEditPath: edit/master/docs

diff --git a/extensions/konnectd/getting-started.md b/extensions/konnectd/getting-started.md
@@ -42,17 +42,24 @@ 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
 
 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/extensions/ocs/getting-started.md b/extensions/ocs/getting-started.md
@@ -42,17 +42,24 @@ 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
 
 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/extensions/proxy/configuration.md b/extensions/proxy/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2020-10-29T12:23:50+0000"
+date: "2020-10-30T09:35:52+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis-proxy
 geekdocEditPath: edit/master/docs
@@ -57,6 +57,15 @@ Usage: `ocis-proxy [global options] command [command options] [arguments...]`
 
 ## Sub Commands
 
+### ocis-proxy health
+
+Check health status
+
+Usage: `ocis-proxy health [command options] [arguments...]`
+
+--debug-addr | $PROXY_DEBUG_ADDR  
+: Address to debug endpoint. Default: `0.0.0.0:9109`.
+
 ### ocis-proxy server
 
 Start integrated server
@@ -141,12 +150,3 @@ Usage: `ocis-proxy version [command options] [arguments...]`
 --service-name | $PROXY_SERVICE_NAME  
 : Service name. Default: `proxy`.
 
-### ocis-proxy health
-
-Check health status
-
-Usage: `ocis-proxy health [command options] [arguments...]`
-
---debug-addr | $PROXY_DEBUG_ADDR  
-: Address to debug endpoint. Default: `0.0.0.0:9109`.
-
diff --git a/extensions/proxy/getting-started.md b/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/extensions/settings/getting-started.md b/extensions/settings/getting-started.md
@@ -160,17 +160,24 @@ 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
 
 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`.