docs: Update cli docs

distribworks · May 15, 2020 · 2c05755 · 2c05755
1 parent 2b937d1
commit 2c05755
Show file tree

Hide file tree

Showing 18 changed files with 125 additions and 120 deletions.
diff --git a/website/content/cli/dkron.md b/website/content/cli/dkron.md
@@ -1,5 +1,5 @@
 ---
-date: 2019-10-10
+date: 2020-05-15
 title: "dkron"
 slug: dkron
 url: /cli/dkron/
@@ -30,4 +30,4 @@ If a machine fails (the leader), a follower will take over and keep running the
 * [dkron raft](/cli/dkron_raft/)	 - Command to perform some raft operations
 * [dkron version](/cli/dkron_version/)	 - Show version
 
-###### Auto generated by spf13/cobra on 10-Oct-2019
+###### Auto generated by spf13/cobra on 15-May-2020
diff --git a/website/content/cli/dkron_agent.md b/website/content/cli/dkron_agent.md
@@ -1,5 +1,5 @@
 ---
-date: 2019-10-10
+date: 2020-05-15
 title: "dkron agent"
 slug: dkron_agent
 url: /cli/dkron_agent/
@@ -20,41 +20,42 @@ dkron agent [flags]
 ### Options
 
 ```
-      --advertise-addr string        Address used to advertise to other nodes in the cluster. By default, the bind address is advertised. The value supports go-sockaddr/template format.
-      --advertise-rpc-port int       Use the value of rpc-port by default
-      --bind-addr string             Specifies which address the agent should bind to for network services, including the internal gossip protocol and RPC mechanism. This should be specified in IP format, and can be used to easily bind all network services to the same address. The value supports go-sockaddr/template format. (default "0.0.0.0:8946")
-      --bootstrap-expect int         Provides the number of expected servers in the datacenter. Either this value should not be provided or the value must agree with other servers in the cluster. When provided, Dkron waits until the specified number of servers are available and then bootstraps the cluster. This allows an initial leader to be elected automatically. This flag requires server mode.
-      --data-dir string              Specifies the directory to use for server-specific data, including the replicated log. By default, this is the top-level data-dir, like [/var/lib/dkron] (default "dkron.data")
-      --datacenter string            Specifies the data center of the local agent. All members of a datacenter should share a local LAN connection. (default "dc1")
-      --dog-statsd-addr string       DataDog Agent address
-      --dog-statsd-tags strings      Datadog tags, specified as key:value
-      --enable-prometheus            Enable serving prometheus metrics at /metrics
-      --encrypt string               Key for encrypting network traffic. Must be a base64-encoded 16-byte key
-  -h, --help                         help for agent
-      --http-addr string             Address to bind the UI web server to. Only used when server. The value supports go-sockaddr/template format. (default ":8080")
-      --join strings                 An initial agent to join with. This flag can be specified multiple times
-      --log-level string             Log level (debug|info|warn|error|fatal|panic) (default "info")
-      --mail-from string             From email address to use
-      --mail-host string             Mail server host address to use for notifications
-      --mail-password string         Mail server password to use
-      --mail-payload string          Notification mail payload
-      --mail-port uint16             Mail server port
-      --mail-subject-prefix string   Notification mail subject prefix (default "[Dkron]")
-      --mail-username string         Mail server username used for authentication
-      --node-name string             Name of this node. Must be unique in the cluster (default "pris.local")
-      --profile string               Profile is used to control the timing profiles used (default "lan")
-      --raft-multiplier int          An integer multiplier used by servers to scale key Raft timing parameters. Omitting this value or setting it to 0 uses default timing described below. Lower values are used to tighten timing and increase sensitivity while higher values relax timings and reduce sensitivity. Tuning this affects the time it takes to detect leader failures and to perform leader elections, at the expense of requiring more network and CPU resources for better performance. By default, Dkron will use a lower-performance timing that's suitable for minimal Dkron servers, currently equivalent to setting this to a value of 5 (this default may be changed in future versions of Dkron, depending if the target minimum server profile changes). Setting this to a value of 1 will configure Raft to its highest-performance mode is recommended for production Dkron servers. The maximum allowed value is 10. (default 1)
-      --region string                Specifies the region the Dkron agent is a member of. A region typically maps to a geographic region, for example us, with potentially multiple zones, which map to datacenters such as us-west and us-east (default "global")
-      --retry-interval string        Time to wait between join attempts. (default "30s")
-      --retry-join strings           Address of an agent to join at start time with retries enabled. Can be specified multiple times.
-      --retry-max int                Maximum number of join attempts. Defaults to 0, which will retry indefinitely.
-      --rpc-port int                 RPC Port used to communicate with clients. Only used when server. The RPC IP Address will be the same as the bind address (default 6868)
-      --server                       This node is running in server mode
-      --statsd-addr string           Statsd address
-      --tag strings                  Tag can be specified multiple times to attach multiple key/value tag pairs to the given node, specified as key=value
-      --webhook-header strings       Headers to use when calling the webhook URL. Can be specified multiple times
-      --webhook-payload string       Body of the POST request to send on webhook call
-      --webhook-url string           Webhook url to call for notifications
+      --advertise-addr string           Address used to advertise to other nodes in the cluster. By default, the bind address is advertised. The value supports go-sockaddr/template format.
+      --advertise-rpc-port int          Use the value of rpc-port by default
+      --bind-addr string                Specifies which address the agent should bind to for network services, including the internal gossip protocol and RPC mechanism. This should be specified in IP format, and can be used to easily bind all network services to the same address. The value supports go-sockaddr/template format. (default "{{ GetPrivateIP }}:8946")
+      --bootstrap-expect int            Provides the number of expected servers in the datacenter. Either this value should not be provided or the value must agree with other servers in the cluster. When provided, Dkron waits until the specified number of servers are available and then bootstraps the cluster. This allows an initial leader to be elected automatically. This flag requires server mode.
+      --data-dir string                 Specifies the directory to use for server-specific data, including the replicated log. By default, this is the top-level data-dir, like [/var/lib/dkron] (default "dkron.data")
+      --datacenter string               Specifies the data center of the local agent. All members of a datacenter should share a local LAN connection. (default "dc1")
+      --dog-statsd-addr string          DataDog Agent address
+      --dog-statsd-tags strings         Datadog tags, specified as key:value
+      --enable-prometheus               Enable serving prometheus metrics
+      --encrypt string                  Key for encrypting network traffic. Must be a base64-encoded 16-byte key
+  -h, --help                            help for agent
+      --http-addr string                Address to bind the UI web server to. Only used when server. The value supports go-sockaddr/template format. (default ":8080")
+      --join strings                    An initial agent to join with. This flag can be specified multiple times
+      --log-level string                Log level (debug|info|warn|error|fatal|panic) (default "info")
+      --mail-from string                From email address to use
+      --mail-host string                Mail server host address to use for notifications
+      --mail-password string            Mail server password to use
+      --mail-payload string             Notification mail payload
+      --mail-port uint16                Mail server port
+      --mail-subject-prefix string      Notification mail subject prefix (default "[Dkron]")
+      --mail-username string            Mail server username used for authentication
+      --node-name string                Name of this node. Must be unique in the cluster (default "pris.local")
+      --profile string                  Profile is used to control the timing profiles used (default "lan")
+      --raft-multiplier int             An integer multiplier used by servers to scale key Raft timing parameters. Omitting this value or setting it to 0 uses default timing described below. Lower values are used to tighten timing and increase sensitivity while higher values relax timings and reduce sensitivity. Tuning this affects the time it takes to detect leader failures and to perform leader elections, at the expense of requiring more network and CPU resources for better performance. By default, Dkron will use a lower-performance timing that's suitable for minimal Dkron servers, currently equivalent to setting this to a value of 5 (this default may be changed in future versions of Dkron, depending if the target minimum server profile changes). Setting this to a value of 1 will configure Raft to its highest-performance mode is recommended for production Dkron servers. The maximum allowed value is 10. (default 1)
+      --region string                   Specifies the region the Dkron agent is a member of. A region typically maps to a geographic region, for example us, with potentially multiple zones, which map to datacenters such as us-west and us-east (default "global")
+      --retry-interval string           Time to wait between join attempts. (default "30s")
+      --retry-join strings              Address of an agent to join at start time with retries enabled. Can be specified multiple times.
+      --retry-max int                   Maximum number of join attempts. Defaults to 0, which will retry indefinitely.
+      --rpc-port int                    RPC Port used to communicate with clients. Only used when server. The RPC IP Address will be the same as the bind address (default 6868)
+      --serf-reconnect-timeout string   This is the amount of time to attempt to reconnect to a failed node before giving up and considering it completely gone. In Kubernetes, you might need this to about 5s, because there is no reason to try reconnects for default 24h value. Also Raft behaves oddly if node is not reaped and returned with same ID, but different IP. Format there: https://golang.org/pkg/time/#ParseDuration (default "24h")
+      --server                          This node is running in server mode
+      --statsd-addr string              Statsd address
+      --tag strings                     Tag can be specified multiple times to attach multiple key/value tag pairs to the given node, specified as key=value
+      --webhook-headers strings         Headers to use when calling the webhook URL. Can be specified multiple times
+      --webhook-payload string          Body of the POST request to send on webhook call
+      --webhook-url string              Webhook url to call for notifications
 ```
 
 ### Options inherited from parent commands
@@ -67,4 +68,4 @@ dkron agent [flags]
 
 * [dkron](/cli/dkron/)	 - Open source distributed job scheduling system
 
-###### Auto generated by spf13/cobra on 10-Oct-2019
+###### Auto generated by spf13/cobra on 15-May-2020
diff --git a/website/content/cli/dkron_doc.md b/website/content/cli/dkron_doc.md
@@ -1,5 +1,5 @@
 ---
-date: 2019-10-10
+date: 2020-05-15
 title: "dkron doc"
 slug: dkron_doc
 url: /cli/dkron_doc/
@@ -37,4 +37,4 @@ dkron doc [flags]
 
 * [dkron](/cli/dkron/)	 - Open source distributed job scheduling system
 
-###### Auto generated by spf13/cobra on 10-Oct-2019
+###### Auto generated by spf13/cobra on 15-May-2020
diff --git a/website/content/cli/dkron_keygen.md b/website/content/cli/dkron_keygen.md
@@ -1,5 +1,5 @@
 ---
-date: 2019-10-10
+date: 2020-05-15
 title: "dkron keygen"
 slug: dkron_keygen
 url: /cli/dkron_keygen/
@@ -34,4 +34,4 @@ dkron keygen [flags]
 
 * [dkron](/cli/dkron/)	 - Open source distributed job scheduling system
 
-###### Auto generated by spf13/cobra on 10-Oct-2019
+###### Auto generated by spf13/cobra on 15-May-2020
diff --git a/website/content/cli/dkron_leave.md b/website/content/cli/dkron_leave.md
@@ -1,5 +1,5 @@
 ---
-date: 2019-10-10
+date: 2020-05-15
 title: "dkron leave"
 slug: dkron_leave
 url: /cli/dkron_leave/
@@ -22,7 +22,7 @@ dkron leave [flags]
 
 ```
   -h, --help              help for leave
-      --rpc-addr string   gRPC address of the agent (default "127.0.0.1:6868")
+      --rpc-addr string   gRPC address of the agent (default "{{ GetPrivateIP }}:6868")
 ```
 
 ### Options inherited from parent commands
@@ -35,4 +35,4 @@ dkron leave [flags]
 
 * [dkron](/cli/dkron/)	 - Open source distributed job scheduling system
 
-###### Auto generated by spf13/cobra on 10-Oct-2019
+###### Auto generated by spf13/cobra on 15-May-2020
diff --git a/website/content/cli/dkron_raft.md b/website/content/cli/dkron_raft.md
@@ -1,5 +1,5 @@
 ---
-date: 2019-10-10
+date: 2020-05-15
 title: "dkron raft"
 slug: dkron_raft
 url: /cli/dkron_raft/
@@ -16,7 +16,7 @@ Command to perform some raft operations
 
 ```
   -h, --help              help for raft
-      --rpc-addr string   gRPC address of the agent (default "127.0.0.1:6868")
+      --rpc-addr string   gRPC address of the agent. (default "{{ GetPrivateIP }}:6868")
 ```
 
 ### Options inherited from parent commands
@@ -31,4 +31,4 @@ Command to perform some raft operations
 * [dkron raft list-peers](/cli/dkron_raft_list-peers/)	 - Command to list raft peers
 * [dkron raft remove-peer](/cli/dkron_raft_remove-peer/)	 - Command to list raft peers
 
-###### Auto generated by spf13/cobra on 10-Oct-2019
+###### Auto generated by spf13/cobra on 15-May-2020
diff --git a/website/content/cli/dkron_raft_list-peers.md b/website/content/cli/dkron_raft_list-peers.md
@@ -1,5 +1,5 @@
 ---
-date: 2019-10-10
+date: 2020-05-15
 title: "dkron raft list-peers"
 slug: dkron_raft_list-peers
 url: /cli/dkron_raft_list-peers/
@@ -26,11 +26,11 @@ dkron raft list-peers [flags]
 
 ```
       --config string     config file path
-      --rpc-addr string   gRPC address of the agent (default "127.0.0.1:6868")
+      --rpc-addr string   gRPC address of the agent. (default "{{ GetPrivateIP }}:6868")
 ```
 
 ### SEE ALSO
 
 * [dkron raft](/cli/dkron_raft/)	 - Command to perform some raft operations
 
-###### Auto generated by spf13/cobra on 10-Oct-2019
+###### Auto generated by spf13/cobra on 15-May-2020
diff --git a/website/content/cli/dkron_raft_remove-peer.md b/website/content/cli/dkron_raft_remove-peer.md
@@ -1,5 +1,5 @@
 ---
-date: 2019-10-10
+date: 2020-05-15
 title: "dkron raft remove-peer"
 slug: dkron_raft_remove-peer
 url: /cli/dkron_raft_remove-peer/
@@ -27,11 +27,11 @@ dkron raft remove-peer [flags]
 
 ```
       --config string     config file path
-      --rpc-addr string   gRPC address of the agent (default "127.0.0.1:6868")
+      --rpc-addr string   gRPC address of the agent. (default "{{ GetPrivateIP }}:6868")
 ```
 
 ### SEE ALSO
 
 * [dkron raft](/cli/dkron_raft/)	 - Command to perform some raft operations
 
-###### Auto generated by spf13/cobra on 10-Oct-2019
+###### Auto generated by spf13/cobra on 15-May-2020
diff --git a/website/content/cli/dkron_version.md b/website/content/cli/dkron_version.md
@@ -1,5 +1,5 @@
 ---
-date: 2019-10-10
+date: 2020-05-15
 title: "dkron version"
 slug: dkron_version
 url: /cli/dkron_version/
@@ -32,4 +32,4 @@ dkron version [flags]
 
 * [dkron](/cli/dkron/)	 - Open source distributed job scheduling system
 
-###### Auto generated by spf13/cobra on 10-Oct-2019
+###### Auto generated by spf13/cobra on 15-May-2020
diff --git a/website/content/pro/cli/dkron.md b/website/content/pro/cli/dkron.md
@@ -1,5 +1,5 @@
 ---
-date: 2019-08-26
+date: 2020-05-15
 title: "dkron"
 slug: dkron
 url: /pro/cli/dkron/
@@ -30,4 +30,4 @@ If a machine fails (the leader), a follower will take over and keep running the
 * [dkron raft](/pro/cli/dkron_raft/)	 - Command to perform some raft operations
 * [dkron version](/pro/cli/dkron_version/)	 - Show version
 
-###### Auto generated by spf13/cobra on 26-Aug-2019
+###### Auto generated by spf13/cobra on 15-May-2020