Merge lp:~niedbalski/charms/precise/rsyslog-forwarder-ha/markdown-modified into lp:charms/rsyslog-forwarder-ha

Proposed by Jorge Niedbalski
Status: Merged
Merged at revision: 8
Proposed branch: lp:~niedbalski/charms/precise/rsyslog-forwarder-ha/markdown-modified
Merge into: lp:charms/rsyslog-forwarder-ha
Diff against target: 71 lines (+12/-20)
1 file modified
README.md (+12/-20)
To merge this branch: bzr merge lp:~niedbalski/charms/precise/rsyslog-forwarder-ha/markdown-modified
Reviewer Review Type Date Requested Status
charmers Pending
Review via email: mp+232567@code.launchpad.net

Description of the change

- Modified README.md to be compatible with CS markdown.

To post a comment you must log in.

Preview Diff

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

Subscribers

People subscribed via source and target branches

to all changes: