← Back to branch summary

~johnsca/charms/trusty/rsyslog-forwarder-ha/cwr

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Matt Bruzek
  • Date: 2014-08-28 22:12:00 UTC
  • mfrom: (7.1.1 rsyslog-forwarder-ha)
  • Revision ID: matthew.bruzek@canonical.com-20140828221200-jry79jua2bs4d01a
[niedbalski] Modified README.md for CS markdown compatiblity.

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.md
1
1
# General
2
2
 
3
 
This Charm provides support for adding a [rsyslog](http://www.rsyslog.org) forwarder listener to any service
4
 
in addition this charm allows to have multiple rsyslog aggregators servers offering currently 2 replication
 
3
This Charm provides support for adding a [rsyslog](http://www.rsyslog.org) forwarder listener to any service.
 
4
In addition, this charm allows to have multiple rsyslog aggregators servers using two different replication
5
5
modes ( fanout, failover ).
6
6
 
 
7
By default the 'fanout' replication mode is going to be used, which means that all the
 
8
syslog messages will be forwarder to any aggregator server using UDP port 514.
 
9
 
 
10
Failover mode will forward all the syslog messages to the primary rsyslog server and
 
11
in case of failure will use the secondary rsyslog server.
 
12
 
 
13
In you want to choose to failover mode, this will require that your current
 
14
rsyslog server is binded to TCP port 514.
 
15
 
7
16
# Usage method
8
17
 
9
18
This is a subordinate charm, which means it requires to have a service to hook in. On this
10
19
example we are going to deploy mysql
11
20
 
12
 
```shell
13
21
    juju deploy mysql
14
 
```
15
22
 
16
23
Then you must deploy this charm
17
24
 
18
 
```shell
19
25
    juju deploy rsyslog-forwarder-ha
20
 
```
21
26
 
22
27
Once your service is running, you can relate this charm:
23
28
 
24
 
```shell
25
29
    juju add-relation rsyslog-forwarder-ha mysql
26
 
```
27
30
 
28
31
Then you can deploy your rsyslog aggregators servers:
29
32
 
30
 
```shell
31
33
    juju deploy rsyslog primary
32
34
    juju deploy rsyslog secondary
33
 
```
34
35
 
35
36
Once your rsyslog aggregators are ready, you can relate them with your forwarder.
36
37
 
37
 
```shell
38
38
    juju add-relation rsyslog-forwarder-ha primary
39
39
    juju add-relation rsyslog-forwarder-ha secondary
40
 
```
41
 
 
42
 
By default the 'fanout' replication mode is going to be used, which means that all the
43
 
syslog messages will be forwarder to any aggregator server using UDP port 514.
44
 
 
45
 
In you want to choose to failover mode, this will require that your current
46
 
rsyslog servers is binded to TCP port 514.
 
40
 
47
41
 
48
42
Once you have your rsyslog ports opened. You can change the replication-mode variable
49
43
on your rsyslog-forwarder-ha charm.
50
44
 
51
 
```shell
52
45
    juju set rsyslog-forwarder-ha replication-mode="failover"
53
 
```
54
46
 
55
47
# Contact Information
56
48