blob: 3f60542c0fe0eaa480c0bd8166a0deab3c8b42f1 [file] [log] [blame]
marco70723542016-06-14 20:25:31 +02001
2==================================
3zookeeper
4==================================
5
6Service zookeeper description
7
8Sample pillars
9==============
10
11Single zookeeper service
12
13.. code-block:: yaml
14
15 zookeeper:
16 server:
17 enabled: true
18 members:
19 - host: ${_param:single_address}
20 id: 1
21
22Cluster zookeeper service
23
24.. code-block:: yaml
25
26 zookeeper:
27 server:
28 enabled: true
29 members:
30 - host: ${_param:cluster_node01_address}
31 id: 1
32 - host: ${_param:cluster_node02_address}
33 id: 2
34 - host: ${_param:cluster_node03_address}
35 id: 3
36
Jiri Broulikf7ce71d2017-07-06 13:51:20 +020037Backup client with ssh/rsync remote host
38
39.. code-block:: yaml
40
41 zookeeper:
42 backup:
43 client:
44 enabled: true
45 full_backups_to_keep: 3
46 hours_before_full: 24
47 target:
48 host: cfg01
Jiri Broulik49111492018-03-05 12:11:27 +010049 backup_dir: server-home-dir
Jiri Broulikf7ce71d2017-07-06 13:51:20 +020050
51 .. note:: full_backups_to_keep param states how many backup will be stored locally on zookeeper client.
52 More options to relocate local backups can be done using salt-formula-backupninja.
53
54Backup client with local backup only
55
56.. code-block:: yaml
57
58 zookeeper:
59 backup:
60 client:
61 enabled: true
62 full_backups_to_keep: 3
63 hours_before_full: 24
64
65 .. note:: full_backups_to_keep param states how many backup will be stored locally on zookeeper client
66
Jiri Broulikf7ce71d2017-07-06 13:51:20 +020067Backup server rsync
68
69.. code-block:: yaml
70
71 zookeeper:
72 backup:
73 server:
74 enabled: true
75 hours_before_full: 24
76 full_backups_to_keep: 5
77 key:
78 zookeeper_pub_key:
79 enabled: true
80 key: ssh_rsa
81
Jiri Broulik2756b322018-02-28 16:21:46 +010082Backup server without strict client restriction
83
84.. code-block:: yaml
85
86 zookeeper:
87 backup:
88 restrict_clients: false
89
Jiri Broulikf7ce71d2017-07-06 13:51:20 +020090Client restore from local backup:
91
92.. code-block:: yaml
93
94 zookeeper:
95 backup:
96 client:
97 enabled: true
98 full_backups_to_keep: 3
99 hours_before_full: 24
100 target:
101 host: cfg01
102 restore_latest: 1
103 restore_from: local
104
105 .. note:: restore_latest param with a value of 1 means to restore db from the last full backup. 2 would mean to restore second latest full backup.
106
107
108Client restore from remote backup:
109
110.. code-block:: yaml
111
112 zookeeper:
113 backup:
114 client:
115 enabled: true
116 full_backups_to_keep: 3
117 hours_before_full: 24
118 target:
119 host: cfg01
120 restore_latest: 1
121 restore_from: remote
122
123 .. note:: restore_latest param with a value of 1 means to restore db from the last full backup. 2 would mean to restore second latest full backup.
124
125
marco70723542016-06-14 20:25:31 +0200126Read more
127=========
128
129* links
Filip Pytloundf51ee22017-02-02 13:02:03 +0100130
131Documentation and Bugs
132======================
133
134To learn how to install and update salt-formulas, consult the documentation
135available online at:
136
137 http://salt-formulas.readthedocs.io/
138
139In the unfortunate event that bugs are discovered, they should be reported to
140the appropriate issue tracker. Use Github issue tracker for specific salt
141formula:
142
143 https://github.com/salt-formulas/salt-formula-zookeeper/issues
144
145For feature requests, bug reports or blueprints affecting entire ecosystem,
146use Launchpad salt-formulas project:
147
148 https://launchpad.net/salt-formulas
149
150You can also join salt-formulas-users team and subscribe to mailing list:
151
152 https://launchpad.net/~salt-formulas-users
153
154Developers wishing to work on the salt-formulas projects should always base
155their work on master branch and submit pull request against specific formula.
156
157 https://github.com/salt-formulas/salt-formula-zookeeper
158
159Any questions or feedback is always welcome so feel free to join our IRC
160channel:
161
162 #salt-formulas @ irc.freenode.net