Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Victor Castell committed Nov 14, 2018
1 parent b9ae4e0 commit 1622070
Show file tree
Hide file tree
Showing 9 changed files with 51 additions and 36 deletions.
2 changes: 1 addition & 1 deletion website/content/basics/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Simply download the packaged archive for your platform from the [downloads page]

## Configuration

See the [configuration section](configuration).
See the [configuration section](/basics/configuration).

## Usage

Expand Down
20 changes: 18 additions & 2 deletions website/content/pro/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ The location of the store configuration can be set in the command line or in the

### Starting a single node

Works out of the box, good for non HA installations
Works out of the box, good for non HA installations.

- System service: If no changes are done to the default config files dkron will start as a service in single mode.
- System service: If no changes are done to the default config files, dkron will start as a service in single mode.
- Command line: Running a single node with default config can be done by running: `dkron agent --server`

Check your server is working: `curl localhost:8080/v1`
Expand All @@ -40,4 +40,20 @@ curl localhost:8080/v1/jobs -XPOST -d '{
}`
```
## Configuration
Dkron Pro uses the [same parameters](/basics/configuration) as Dkron OSS and add some extra parameters.
### Command line options
* `--etcd-config-file-path` - Etcd node config
* `--username` - Authentication username
* `--password` - Authentication password
* `--cert-file` - Path to the client server TLS cert file
* `--key-file` - Path to the client server TLS key file
* `--client-crl-file` - Path to the client certificate revocation list file
* `--trusted-ca-file` - Path to the client server TLS trusted CA cert file
* `--client-cert-auth` - Enable client cert authentication
* `--auto-tls` - Client TLS using generated certificates
{{% children style="card" depth="2" description="true" %}}
3 changes: 2 additions & 1 deletion website/content/pro/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ title: Authorization

Dkron Pro has the ability to be configured to use HTTP basic auth.

Set this parameters in your dkron config file:
Authentication can be set using these parameters in the dkron config file:

```yaml
# dkron.yml
username: foo
password: bar
```
Expand Down
6 changes: 4 additions & 2 deletions website/content/pro/clustering.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: Clustering

## Configure a cluster

Run in HA mode, good for companies.
Dkron can run in HA mode, avoiding SPOFs, this mode provides better scalability and better reliability for users that wants a high level of confidence in the cron jobs they need to run.

Configure the peers to join:
To form a cluster, server nodes need to know the address of its peers as in the following example:

```yaml
# dkron.yml
Expand All @@ -16,6 +16,8 @@ join:
- 10.19.7.215
```
On the other side, the embedded store also needs to know its peers, it needs its own configuration as in the following example:
```yaml
# etcd.conf.yaml
# Initial cluster configuration for bootstrapping.
Expand Down
8 changes: 4 additions & 4 deletions website/content/pro/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
title: Docker executor
---

Docker executor can run docker jobs
Docker executor can launch docker based cron jobs using the docker command of the target node.

## Configuration
This executor needs a recent version of docker to be available and configured in the target node.

To run a docker job create a job config with the following executor:
## Configuration

Example:
To run a docker job create a job config with the docker executor as in this example:

```json
"executor": "docker",
Expand Down
4 changes: 2 additions & 2 deletions website/content/pro/ecs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: AWS ECS Executor

The ECS exeutor is capable of launching tasks in ECS clusters, then listen to a stream of CloudWatch Logs and return the output.

To configure a job to be run in ECS you can use either a JSON Task definition template or an already defined task in ECS.
To configure a job to be run in ECS, the executor needs a JSON Task definition template or an already defined task in ECS.

To allow the ECS Task runner to run tasks, the machine running Dkron needs to have the appropriate permissions configured in AWS IAM:

Expand All @@ -29,7 +29,7 @@ To allow the ECS Task runner to run tasks, the machine running Dkron needs to ha
}
```

Then configure a job to be run with the ECS executor:
To configure a job to be run with the ECS executor:

Example using an existing taskdef

Expand Down
4 changes: 3 additions & 1 deletion website/content/pro/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
title: Elasticsearch processor
---

The Elasticsearch processor can fordward execution logs to an ES cluster.
The Elasticsearch processor can fordward execution logs to an ES cluster. It need an already available Elasticsearch installation that is visible in the same network of the target node.

The output logs of the job execution will be stored in the indicated ES instace.

## Configuration

Expand Down
18 changes: 17 additions & 1 deletion website/content/pro/encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,26 @@
title: Encryption
---

SSL encryption is used for communicating dkron pro and the embedded store, and between storage nodes itself. Also client auth is enabled, so only dkron pro clients can talk to the embedded store. This means that no other software running on your local network will be able to talk to dkron's etcd server.
SSL encryption is used for communicating dkron pro and the embedded store, and between storage nodes itself. Also if client auth is enabled, only dkron pro clients can talk to the embedded store. This means that no other software running on your local network will be able to talk to dkron's etcd server.

This ensures that no unexpected usage of the Dkron's store will happen, unless it is another Dkron pro instance.

SSL encryption is enabled by default in Dkron Pro and can not be disabled, you don't need to do nothing to use it.

By default Dkron Pro runs with automatically generated SSL certificates, this is enough for using it in a trusted environment but to have a better grade of confidence, it is recommended to run Dkron Pro with custom SSL certificates.

Follow [this tutorial](https://coreos.com/os/docs/latest/generate-self-signed-certificates.html) to generate autosigned SSL certificates for your instances.

{{% notice note %}}
You don't need a client certificate for Dkron server, just add "client auth" usage to your server cert.
{{% /notice %}}

```yaml
# dkron.yaml
auto-tls: false # Set to false to use custom certs
key-file: server-key.pem
cert-file: server.pem
trusted-ca-file: ca.pem
client-cert-auth: true # Enable it to only allow certs signed by the same CA
```
22 changes: 0 additions & 22 deletions website/content/pro/ssl.md

This file was deleted.

0 comments on commit 1622070

Please sign in to comment.