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 cea8d20 commit b9ae4e0
Show file tree
Hide file tree
Showing 4 changed files with 85 additions and 4 deletions.
38 changes: 38 additions & 0 deletions website/content/pro/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,42 @@
title: Dkron Pro
---

## Getting started

Dkron Pro provides a backend store out of the box, based on etcd.

To configure the storage a sample `etcd.conf.yaml` file is provided in `/etc/dkron` path. Editing the file, allows to configure several options for the embedded store.

The location of the store configuration can be set in the command line or in the dkron config file `/etc/dkron/dkron.yml` using `etcd-config-file-path` parameter.

### Starting a single node

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.
- 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`

Simple as that, now it is time to add some jobs:

```bash
curl localhost:8080/v1/jobs -XPOST -d '{
"name": "job1",
"schedule": "@every 10s",
"timezone": "Europe/Berlin",
"owner": "Platform Team",
"owner_email": "platform@example.com",
"disabled": false,
"tags": {
"dkron_server": "true"
},
"concurrency": "allow",
"executor": "shell",
"executor_config": {
"command": "date"
}
}`
```
{{% children style="card" depth="2" description="true" %}}
25 changes: 25 additions & 0 deletions website/content/pro/clustering.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Clustering
---

## Configure a cluster

Run in HA mode, good for companies.

Configure the peers to join:

```yaml
# dkron.yml
join:
- 10.19.3.9
- 10.19.4.64
- 10.19.7.215
```
```yaml
# etcd.conf.yaml
# Initial cluster configuration for bootstrapping.
initial-cluster: dkron1=https://10.19.3.9:2380,dkron2=https://10.19.4.64:2380,dkron3=https://10.19.7.215:2380
```
With this configuration Dkron Pro should start in cluster mode with embedded storage.
22 changes: 22 additions & 0 deletions website/content/pro/ssl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Using SSL
---

### Using SSL

By default Dkron Pro runs with automatically generated SSL certificates, this is enough if 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
```
4 changes: 0 additions & 4 deletions website/content/pro/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,3 @@ title: Embedded storage
Dkron Pro has an embedded distributed KV store engine based on etcd. This works out of the box on each node dkron server is started.

This ensures a dead easy install and setup, basically run dkron and you will have a full working node and at the same time provides you with a fully tested well supported store for its use with dkron.

## Configuration

The embedded etcd instance configuration can be tunned using the standard etcd config yaml file located in `config/etcd.conf.yml` but several reserved parameters are autoconfigured by dkron. Refer to the [official etcd documentation](https://coreos.com/etcd/docs/latest/v2/configuration.html)

0 comments on commit b9ae4e0

Please sign in to comment.