-
Notifications
You must be signed in to change notification settings - Fork 386
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Victor Castell
committed
Jan 21, 2019
1 parent
6868ce4
commit a1ffbc9
Showing
6 changed files
with
223 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: "Pro CLI" | ||
weight: 90 | ||
icon: "<b>1. </b>" | ||
--- | ||
|
||
{{% children style="h2" depth="3" description="true" %}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
date: 2019-01-21 | ||
title: "dkron" | ||
slug: dkron | ||
url: /cli/dkron/ | ||
--- | ||
## dkron | ||
|
||
Professional distributed job scheduling system | ||
|
||
### Synopsis | ||
|
||
Dkron is a system service that runs scheduled jobs at given intervals or times, | ||
just like the cron unix service but distributed in several machines in a cluster. | ||
If a machine fails (the leader), a follower will take over and keep running the scheduled jobs without human intervention. | ||
|
||
### Options | ||
|
||
``` | ||
--config string config file (default is /etc/dkron/dkron.yml) | ||
-h, --help help for dkron | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [dkron agent](/cli/dkron_agent/) - Start a dkron agent | ||
* [dkron doc](/cli/dkron_doc/) - Generate Markdown documentation for the Dkron CLI. | ||
* [dkron keygen](/cli/dkron_keygen/) - Generates a new encryption key | ||
* [dkron version](/cli/dkron_version/) - Show version | ||
|
||
###### Auto generated by spf13/cobra on 21-Jan-2019 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
--- | ||
date: 2019-01-21 | ||
title: "dkron agent" | ||
slug: dkron_agent | ||
url: /cli/dkron_agent/ | ||
--- | ||
## dkron agent | ||
|
||
Start a dkron agent | ||
|
||
### Synopsis | ||
|
||
Start a dkron agent that schedule jobs, listen for executions and run executors. | ||
It also runs a web UI. | ||
|
||
``` | ||
dkron agent [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
--advertise-addr string Address used to advertise to other nodes in the cluster. By default, the bind address is advertised. | ||
--advertise-rpc-port int Use the value of rpc-port by default. | ||
--auto-tls Client TLS using generated certificates (default true) | ||
--backend string store backend (default "boltdb") | ||
--backend-machine strings store backend machines addresses (default [./dkron.db]) | ||
--bind-addr string Address to bind network listeners to. (default "0.0.0.0:8946") | ||
--cert-file string Path to the client server TLS cert file | ||
--client-cert-auth Enable client cert authentication | ||
--client-crl-file string Path to the client certificate revocation list file | ||
--dog-statsd-addr string DataDog Agent address. | ||
--dog-statsd-tags strings Datadog tags, specified as key:value | ||
--encrypt string Key for encrypting network traffic. Must be a base64-encoded 16-byte key. | ||
--etcd-config-file-path string etcd node config (default "/etc/dkron/etcd.conf.yml") | ||
-h, --help help for agent | ||
--http-addr string Address to bind the UI web server to. Only used when server. (default ":8080") | ||
--join strings An initial agent to join with. This flag can be specified multiple times. | ||
--key-file string Path to the client server TLS key file | ||
--keyspace string The keyspace to use. A prefix under all data is stored for this instance. (default "dkron") | ||
--log-level string Log level (debug, info, warn, error, fatal, panic), defaults to info (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") | ||
--password string authentication password | ||
--profile string Profile is used to control the timing profiles used. The default if not provided is lan. (default "lan") | ||
--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 | ||
--trusted-ca-file string Path to the client server TLS trusted CA cert file | ||
--username string authentication username | ||
--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. | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--config string config file (default is /etc/dkron/dkron.yml) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [dkron](/cli/dkron/) - Professional distributed job scheduling system | ||
|
||
###### Auto generated by spf13/cobra on 21-Jan-2019 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
date: 2019-01-21 | ||
title: "dkron doc" | ||
slug: dkron_doc | ||
url: /cli/dkron_doc/ | ||
--- | ||
## dkron doc | ||
|
||
Generate Markdown documentation for the Dkron CLI. | ||
|
||
### Synopsis | ||
|
||
Generate Markdown documentation for the Dkron CLI. | ||
This command is, mostly, used to create up-to-date documentation | ||
of Dkron's command-line interface for http://dkron.io/. | ||
It creates one Markdown file per command with front matter suitable | ||
for rendering in Hugo. | ||
|
||
``` | ||
dkron doc [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
--dir string the directory to write the doc. (default "/tmp/dkrondoc/") | ||
-h, --help help for doc | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--config string config file (default is /etc/dkron/dkron.yml) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [dkron](/cli/dkron/) - Professional distributed job scheduling system | ||
|
||
###### Auto generated by spf13/cobra on 21-Jan-2019 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
date: 2019-01-21 | ||
title: "dkron keygen" | ||
slug: dkron_keygen | ||
url: /cli/dkron_keygen/ | ||
--- | ||
## dkron keygen | ||
|
||
Generates a new encryption key | ||
|
||
### Synopsis | ||
|
||
Generates a new encryption key that can be used to configure the | ||
agent to encrypt traffic. The output of this command is already | ||
in the proper format that the agent expects. | ||
|
||
``` | ||
dkron keygen [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for keygen | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--config string config file (default is /etc/dkron/dkron.yml) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [dkron](/cli/dkron/) - Professional distributed job scheduling system | ||
|
||
###### Auto generated by spf13/cobra on 21-Jan-2019 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
date: 2019-01-21 | ||
title: "dkron version" | ||
slug: dkron_version | ||
url: /cli/dkron_version/ | ||
--- | ||
## dkron version | ||
|
||
Show version | ||
|
||
### Synopsis | ||
|
||
Show the version | ||
|
||
``` | ||
dkron version [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for version | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--config string config file (default is /etc/dkron/dkron.yml) | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [dkron](/cli/dkron/) - Professional distributed job scheduling system | ||
|
||
###### Auto generated by spf13/cobra on 21-Jan-2019 |