Skip to content

Commit 7973d5d

Browse files
sgottisgotti
committed
Merge pull request sorintlab#534 from sgotti/doc_update_generated_commands_doc
doc: update generated commands doc
2 parents bb38ea1 + 4bd695c commit 7973d5d

12 files changed

+199
-187
lines changed

‎doc/commands/stolon-keeper.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -13,31 +13,32 @@ stolon-keeper [flags]
1313
### Options
1414

1515
```
16-
--cluster-name string cluster name
17-
--data-dir string data directory
18-
-h, --help help for stolon-keeper
19-
--kube-resource-kind string the k8s resource kind to be used to store stolon clusterdata and do sentinel leader election (only "configmap" is currently supported)
20-
--log-color enable color in log output (default if attached to a terminal)
21-
--log-level string debug, info (default), warn or error (default "info")
22-
--pg-bin-path string absolute path to postgresql binaries. If empty they will be searched in the current PATH
23-
--pg-listen-address string postgresql instance listening address
24-
--pg-port string postgresql instance listening port (default "5432")
25-
--pg-repl-auth-method string postgres replication user auth method. Default is md5. (default "md5")
26-
--pg-repl-password string postgres replication user password. Only one of --pg-repl-password or --pg-repl-passwordfile must be provided. Must be the same for all keepers.
27-
--pg-repl-passwordfile string postgres replication user password file. Only one of --pg-repl-password or --pg-repl-passwordfile must be provided. Must be the same for all keepers.
28-
--pg-repl-username string postgres replication user name. Required. It'll be created on db initialization. Must be the same for all keepers.
29-
--pg-su-auth-method string postgres superuser auth method. Default is md5. (default "md5")
30-
--pg-su-password string postgres superuser password. Only one of --pg-su-password or --pg-su-passwordfile must be provided. Must be the same for all keepers.
31-
--pg-su-passwordfile string postgres superuser password file. Only one of --pg-su-password or --pg-su-passwordfile must be provided. Must be the same for all keepers)
32-
--pg-su-username string postgres superuser user name. Used for keeper managed instance access and pg_rewind based synchronization. It'll be created on db initialization. Defaults to the name of the effective user running stolon-keeper. Must be the same for all keepers. (default "motaboy")
33-
--store-backend string store backend type (etcdv2/etcd, etcdv3, consul or kubernetes)
34-
--store-ca-file string verify certificates of HTTPS-enabled store servers using this CA bundle
35-
--store-cert-file string certificate file for client identification to the store
36-
--store-endpoints string a comma-delimited list of store endpoints (use https scheme for tls communication) (defaults: http://127.0.0.1:2379 for etcd, http://127.0.0.1:8500 for consul)
37-
--store-key string private key file for client identification to the store
38-
--store-prefix string the store base prefix (default "stolon/cluster")
39-
--store-skip-tls-verify skip store certificate verification (insecure!!!)
40-
--uid string keeper uid (must be unique in the cluster and can contain only lower-case letters, numbers and the underscore character). If not provided a random uid will be generated.
16+
--cluster-name string cluster name
17+
--data-dir string data directory
18+
-h, --help help for stolon-keeper
19+
--kube-resource-kind string the k8s resource kind to be used to store stolon clusterdata and do sentinel leader election (only "configmap" is currently supported)
20+
--log-color enable color in log output (default if attached to a terminal)
21+
--log-level string debug, info (default), warn or error (default "info")
22+
--metrics-listen-address string metrics listen address i.e "0.0.0.0:8080" (disabled by default)
23+
--pg-bin-path string absolute path to postgresql binaries. If empty they will be searched in the current PATH
24+
--pg-listen-address string postgresql instance listening address
25+
--pg-port string postgresql instance listening port (default "5432")
26+
--pg-repl-auth-method string postgres replication user auth method. Default is md5. (default "md5")
27+
--pg-repl-password string postgres replication user password. Only one of --pg-repl-password or --pg-repl-passwordfile must be provided. Must be the same for all keepers.
28+
--pg-repl-passwordfile string postgres replication user password file. Only one of --pg-repl-password or --pg-repl-passwordfile must be provided. Must be the same for all keepers.
29+
--pg-repl-username string postgres replication user name. Required. It'll be created on db initialization. Must be the same for all keepers.
30+
--pg-su-auth-method string postgres superuser auth method. Default is md5. (default "md5")
31+
--pg-su-password string postgres superuser password. Only one of --pg-su-password or --pg-su-passwordfile must be provided. Must be the same for all keepers.
32+
--pg-su-passwordfile string postgres superuser password file. Only one of --pg-su-password or --pg-su-passwordfile must be provided. Must be the same for all keepers)
33+
--pg-su-username string postgres superuser user name. Used for keeper managed instance access and pg_rewind based synchronization. It'll be created on db initialization. Defaults to the name of the effective user running stolon-keeper. Must be the same for all keepers. (default "motaboy")
34+
--store-backend string store backend type (etcdv2/etcd, etcdv3, consul or kubernetes)
35+
--store-ca-file string verify certificates of HTTPS-enabled store servers using this CA bundle
36+
--store-cert-file string certificate file for client identification to the store
37+
--store-endpoints string a comma-delimited list of store endpoints (use https scheme for tls communication) (defaults: http://127.0.0.1:2379 for etcd, http://127.0.0.1:8500 for consul)
38+
--store-key string private key file for client identification to the store
39+
--store-prefix string the store base prefix (default "stolon/cluster")
40+
--store-skip-tls-verify skip store certificate verification (insecure!!!)
41+
--uid string keeper uid (must be unique in the cluster and can contain only lower-case letters, numbers and the underscore character). If not provided a random uid will be generated.
4142
```
4243

43-
###### Auto generated by spf13/cobra on 23-Feb-2018
44+
###### Auto generated by spf13/cobra on 19-Jul-2018

‎doc/commands/stolon-proxy.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,25 @@ stolon-proxy [flags]
1313
### Options
1414

1515
```
16-
--cluster-name string cluster name
17-
-h, --help help for stolon-proxy
18-
--kube-resource-kind string the k8s resource kind to be used to store stolon clusterdata and do sentinel leader election (only "configmap" is currently supported)
19-
--listen-address string proxy listening address (default "127.0.0.1")
20-
--log-color enable color in log output (default if attached to a terminal)
21-
--log-level string debug, info (default), warn or error (default "info")
22-
--port string proxy listening port (default "5432")
23-
--stop-listening stop listening on store error (default true)
24-
--store-backend string store backend type (etcdv2/etcd, etcdv3, consul or kubernetes)
25-
--store-ca-file string verify certificates of HTTPS-enabled store servers using this CA bundle
26-
--store-cert-file string certificate file for client identification to the store
27-
--store-endpoints string a comma-delimited list of store endpoints (use https scheme for tls communication) (defaults: http://127.0.0.1:2379 for etcd, http://127.0.0.1:8500 for consul)
28-
--store-key string private key file for client identification to the store
29-
--store-prefix string the store base prefix (default "stolon/cluster")
30-
--store-skip-tls-verify skip store certificate verification (insecure!!!)
31-
--tcp-keepalive-count int set tcp keepalive probe count number
32-
--tcp-keepalive-idle int set tcp keepalive idle (seconds)
33-
--tcp-keepalive-interval int set tcp keepalive interval (seconds)
16+
--cluster-name string cluster name
17+
-h, --help help for stolon-proxy
18+
--kube-resource-kind string the k8s resource kind to be used to store stolon clusterdata and do sentinel leader election (only "configmap" is currently supported)
19+
--listen-address string proxy listening address (default "127.0.0.1")
20+
--log-color enable color in log output (default if attached to a terminal)
21+
--log-level string debug, info (default), warn or error (default "info")
22+
--metrics-listen-address string metrics listen address i.e "0.0.0.0:8080" (disabled by default)
23+
--port string proxy listening port (default "5432")
24+
--stop-listening stop listening on store error (default true)
25+
--store-backend string store backend type (etcdv2/etcd, etcdv3, consul or kubernetes)
26+
--store-ca-file string verify certificates of HTTPS-enabled store servers using this CA bundle
27+
--store-cert-file string certificate file for client identification to the store
28+
--store-endpoints string a comma-delimited list of store endpoints (use https scheme for tls communication) (defaults: http://127.0.0.1:2379 for etcd, http://127.0.0.1:8500 for consul)
29+
--store-key string private key file for client identification to the store
30+
--store-prefix string the store base prefix (default "stolon/cluster")
31+
--store-skip-tls-verify skip store certificate verification (insecure!!!)
32+
--tcp-keepalive-count int set tcp keepalive probe count number
33+
--tcp-keepalive-idle int set tcp keepalive idle (seconds)
34+
--tcp-keepalive-interval int set tcp keepalive interval (seconds)
3435
```
3536

36-
###### Auto generated by spf13/cobra on 23-Feb-2018
37+
###### Auto generated by spf13/cobra on 19-Jul-2018

‎doc/commands/stolon-sentinel.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,20 @@ stolon-sentinel [flags]
1313
### Options
1414

1515
```
16-
--cluster-name string cluster name
17-
-h, --help help for stolon-sentinel
18-
--initial-cluster-spec string a file providing the initial cluster specification, used only at cluster initialization, ignored if cluster is already initialized
19-
--kube-resource-kind string the k8s resource kind to be used to store stolon clusterdata and do sentinel leader election (only "configmap" is currently supported)
20-
--log-color enable color in log output (default if attached to a terminal)
21-
--log-level string debug, info (default), warn or error (default "info")
22-
--store-backend string store backend type (etcdv2/etcd, etcdv3, consul or kubernetes)
23-
--store-ca-file string verify certificates of HTTPS-enabled store servers using this CA bundle
24-
--store-cert-file string certificate file for client identification to the store
25-
--store-endpoints string a comma-delimited list of store endpoints (use https scheme for tls communication) (defaults: http://127.0.0.1:2379 for etcd, http://127.0.0.1:8500 for consul)
26-
--store-key string private key file for client identification to the store
27-
--store-prefix string the store base prefix (default "stolon/cluster")
28-
--store-skip-tls-verify skip store certificate verification (insecure!!!)
16+
--cluster-name string cluster name
17+
-h, --help help for stolon-sentinel
18+
--initial-cluster-spec string a file providing the initial cluster specification, used only at cluster initialization, ignored if cluster is already initialized
19+
--kube-resource-kind string the k8s resource kind to be used to store stolon clusterdata and do sentinel leader election (only "configmap" is currently supported)
20+
--log-color enable color in log output (default if attached to a terminal)
21+
--log-level string debug, info (default), warn or error (default "info")
22+
--metrics-listen-address string metrics listen address i.e "0.0.0.0:8080" (disabled by default)
23+
--store-backend string store backend type (etcdv2/etcd, etcdv3, consul or kubernetes)
24+
--store-ca-file string verify certificates of HTTPS-enabled store servers using this CA bundle
25+
--store-cert-file string certificate file for client identification to the store
26+
--store-endpoints string a comma-delimited list of store endpoints (use https scheme for tls communication) (defaults: http://127.0.0.1:2379 for etcd, http://127.0.0.1:8500 for consul)
27+
--store-key string private key file for client identification to the store
28+
--store-prefix string the store base prefix (default "stolon/cluster")
29+
--store-skip-tls-verify skip store certificate verification (insecure!!!)
2930
```
3031

31-
###### Auto generated by spf13/cobra on 23-Feb-2018
32+
###### Auto generated by spf13/cobra on 19-Jul-2018

‎doc/commands/stolonctl.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,21 @@ stolonctl [flags]
1313
### Options
1414

1515
```
16-
--cluster-name string cluster name
17-
-h, --help help for stolonctl
18-
--kube-context string name of the kubeconfig context to use
19-
--kube-namespace string name of the kubernetes namespace to use
20-
--kube-resource-kind string the k8s resource kind to be used to store stolon clusterdata and do sentinel leader election (only "configmap" is currently supported)
21-
--kubeconfig string path to kubeconfig file. Overrides $KUBECONFIG
22-
--log-level string debug, info (default), warn or error (default "info")
23-
--store-backend string store backend type (etcdv2/etcd, etcdv3, consul or kubernetes)
24-
--store-ca-file string verify certificates of HTTPS-enabled store servers using this CA bundle
25-
--store-cert-file string certificate file for client identification to the store
26-
--store-endpoints string a comma-delimited list of store endpoints (use https scheme for tls communication) (defaults: http://127.0.0.1:2379 for etcd, http://127.0.0.1:8500 for consul)
27-
--store-key string private key file for client identification to the store
28-
--store-prefix string the store base prefix (default "stolon/cluster")
29-
--store-skip-tls-verify skip store certificate verification (insecure!!!)
16+
--cluster-name string cluster name
17+
-h, --help help for stolonctl
18+
--kube-context string name of the kubeconfig context to use
19+
--kube-namespace string name of the kubernetes namespace to use
20+
--kube-resource-kind string the k8s resource kind to be used to store stolon clusterdata and do sentinel leader election (only "configmap" is currently supported)
21+
--kubeconfig string path to kubeconfig file. Overrides $KUBECONFIG
22+
--log-level string debug, info (default), warn or error (default "info")
23+
--metrics-listen-address string metrics listen address i.e "0.0.0.0:8080" (disabled by default)
24+
--store-backend string store backend type (etcdv2/etcd, etcdv3, consul or kubernetes)
25+
--store-ca-file string verify certificates of HTTPS-enabled store servers using this CA bundle
26+
--store-cert-file string certificate file for client identification to the store
27+
--store-endpoints string a comma-delimited list of store endpoints (use https scheme for tls communication) (defaults: http://127.0.0.1:2379 for etcd, http://127.0.0.1:8500 for consul)
28+
--store-key string private key file for client identification to the store
29+
--store-prefix string the store base prefix (default "stolon/cluster")
30+
--store-skip-tls-verify skip store certificate verification (insecure!!!)
3031
```
3132

3233
### SEE ALSO
@@ -40,4 +41,4 @@ stolonctl [flags]
4041
* [stolonctl update](stolonctl_update.md) - Update a cluster specification
4142
* [stolonctl version](stolonctl_version.md) - Display the version
4243

43-
###### Auto generated by spf13/cobra on 23-Feb-2018
44+
###### Auto generated by spf13/cobra on 19-Jul-2018

‎doc/commands/stolonctl_clusterdata.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,24 @@ stolonctl clusterdata [flags]
2020
### Options inherited from parent commands
2121

2222
```
23-
--cluster-name string cluster name
24-
--kube-context string name of the kubeconfig context to use
25-
--kube-namespace string name of the kubernetes namespace to use
26-
--kube-resource-kind string the k8s resource kind to be used to store stolon clusterdata and do sentinel leader election (only "configmap" is currently supported)
27-
--kubeconfig string path to kubeconfig file. Overrides $KUBECONFIG
28-
--log-level string debug, info (default), warn or error (default "info")
29-
--store-backend string store backend type (etcdv2/etcd, etcdv3, consul or kubernetes)
30-
--store-ca-file string verify certificates of HTTPS-enabled store servers using this CA bundle
31-
--store-cert-file string certificate file for client identification to the store
32-
--store-endpoints string a comma-delimited list of store endpoints (use https scheme for tls communication) (defaults: http://127.0.0.1:2379 for etcd, http://127.0.0.1:8500 for consul)
33-
--store-key string private key file for client identification to the store
34-
--store-prefix string the store base prefix (default "stolon/cluster")
35-
--store-skip-tls-verify skip store certificate verification (insecure!!!)
23+
--cluster-name string cluster name
24+
--kube-context string name of the kubeconfig context to use
25+
--kube-namespace string name of the kubernetes namespace to use
26+
--kube-resource-kind string the k8s resource kind to be used to store stolon clusterdata and do sentinel leader election (only "configmap" is currently supported)
27+
--kubeconfig string path to kubeconfig file. Overrides $KUBECONFIG
28+
--log-level string debug, info (default), warn or error (default "info")
29+
--metrics-listen-address string metrics listen address i.e "0.0.0.0:8080" (disabled by default)
30+
--store-backend string store backend type (etcdv2/etcd, etcdv3, consul or kubernetes)
31+
--store-ca-file string verify certificates of HTTPS-enabled store servers using this CA bundle
32+
--store-cert-file string certificate file for client identification to the store
33+
--store-endpoints string a comma-delimited list of store endpoints (use https scheme for tls communication) (defaults: http://127.0.0.1:2379 for etcd, http://127.0.0.1:8500 for consul)
34+
--store-key string private key file for client identification to the store
35+
--store-prefix string the store base prefix (default "stolon/cluster")
36+
--store-skip-tls-verify skip store certificate verification (insecure!!!)
3637
```
3738

3839
### SEE ALSO
3940

4041
* [stolonctl](stolonctl.md) - stolon command line client
4142

42-
###### Auto generated by spf13/cobra on 23-Feb-2018
43+
###### Auto generated by spf13/cobra on 19-Jul-2018

0 commit comments

Comments
 (0)