Gitiles
Code Review Sign In
gerrit.mcp.mirantis.com / salt-formulas / glusterfs / 6395b5fcb560bdc56501b0598d8804df5430b77e / . / README.rst
blob: cb8172546182ac53bd976244488b2aa9cc729a0a [file] [log] [blame]
OlgaGusarenkoa67b5c32018-07-30 17:58:11 +0300[diff] [blame]1=====
2Usage
3=====
Filip Pytloun6828ea52015-07-30 14:47:24 +0200[diff] [blame]4
OlgaGusarenkoa67b5c32018-07-30 17:58:11 +0300[diff] [blame]5Installs and configures GlusterFS server and client.
Filip Pytloun6828ea52015-07-30 14:47:24 +0200[diff] [blame]6
7Available states
8================
9
OlgaGusarenkoa67b5c32018-07-30 17:58:11 +0300[diff] [blame]10* ``glusterfs.server``
11 Sets up GlusterFS server (including both service and setup)
Filip Pytloun6828ea52015-07-30 14:47:24 +0200[diff] [blame]12
OlgaGusarenkoa67b5c32018-07-30 17:58:11 +0300[diff] [blame]13* ``glusterfs.server.service``
14 Sets up and start GlusterFS server service
Filip Pytloun6828ea52015-07-30 14:47:24 +0200[diff] [blame]15
OlgaGusarenkoa67b5c32018-07-30 17:58:11 +0300[diff] [blame]16* ``glusterfs.server.setup``
17 Sets up GlusterFS peers and volumes
Filip Pytloun888c3db2015-09-07 13:45:09 +0200[diff] [blame]18
OlgaGusarenkoa67b5c32018-07-30 17:58:11 +0300[diff] [blame]19* ``glusterfs.client``
20 Sets up GlusterFS client
Filip Pytloun6828ea52015-07-30 14:47:24 +0200[diff] [blame]21
Alexandr Lovtsov22394f42019-04-18 16:52:06 +0300[diff] [blame]22* ``glusterfs.update.server``
23 Update GlusterFS on servers
24
25* ``glusterfs.update.client``
26 Update GlusterFS on clients
27
28* ``glusterfs.update.op_version``
29 Update GlusterFS cluster.op-version option
30
31* ``glusterfs.orchestrate.update``
32 Orchestrate an update of GlusterFS process
33
Filip Pytloun6828ea52015-07-30 14:47:24 +0200[diff] [blame]34Available metadata
35==================
36
OlgaGusarenkoa67b5c32018-07-30 17:58:11 +0300[diff] [blame]37* ``metadata.glusterfs.server``
38 Sets up basic server
Filip Pytloun6828ea52015-07-30 14:47:24 +0200[diff] [blame]39
OlgaGusarenkoa67b5c32018-07-30 17:58:11 +0300[diff] [blame]40* ``metadata.glusterfs.client``
41 Sets up client only
Filip Pytloun6828ea52015-07-30 14:47:24 +0200[diff] [blame]42
OlgaGusarenkoa67b5c32018-07-30 17:58:11 +0300[diff] [blame]43Example Reclass
Filip Pytloun6828ea52015-07-30 14:47:24 +0200[diff] [blame]44===============
45
OlgaGusarenkoa67b5c32018-07-30 17:58:11 +0300[diff] [blame]46Example for distributed Glance images storage where every control node is
Filip Pytloun6828ea52015-07-30 14:47:24 +0200[diff] [blame]47gluster peer.
48
49.. code-block:: yaml
50
51 classes:
52 - service.glusterfs.server
53 - service.glusterfs.client
54
55 _param:
56 cluster_node01_address: 192.168.1.21
57 cluster_node02_address: 192.168.1.22
58 cluster_node03_address: 192.168.1.23
59 parameters:
60 glusterfs:
61 server:
62 peers:
63 - ${_param:cluster_node01_address}
64 - ${_param:cluster_node02_address}
65 - ${_param:cluster_node03_address}
66 volumes:
67 glance:
68 storage: /srv/glusterfs/glance
69 replica: 3
70 bricks:
71 - ${_param:cluster_node01_address}:/srv/glusterfs/glance
72 - ${_param:cluster_node02_address}:/srv/glusterfs/glance
73 - ${_param:cluster_node03_address}:/srv/glusterfs/glance
Filip Pytloun7dfd5d42015-07-30 16:08:27 +0200[diff] [blame]74 options:
75 cluster.readdir-optimize: On
76 nfs.disable: On
77 network.remote-dio: On
78 diagnostics.client-log-level: WARNING
79 diagnostics.brick-log-level: WARNING
Filip Pytloun6828ea52015-07-30 14:47:24 +0200[diff] [blame]80 client:
81 volumes:
82 glance:
83 path: /var/lib/glance/images
84 server: ${_param:cluster_node01_address}
85 user: glance
86 group: glance
87
88Example pillar
89==============
90
91Server
92------
93
94.. code-block:: yaml
95
96 glusterfs:
97 server:
98 peers:
99 - 192.168.1.21
100 - 192.168.1.22
101 - 192.168.1.23
102 volumes:
103 glance:
104 storage: /srv/glusterfs/glance
105 replica: 3
106 bricks:
107 - 172.168.1.21:/srv/glusterfs/glance
108 - 172.168.1.21:/srv/glusterfs/glance
109 - 172.168.1.21:/srv/glusterfs/glance
Bogdan Radulescu3f27ebd2015-12-04 16:55:42 +0000[diff] [blame]110 enabled: true
Filip Pytloun6828ea52015-07-30 14:47:24 +0200[diff] [blame]111
Martin Polreichb3e1f562018-06-01 13:36:55 +0200[diff] [blame]112Server with forced peer UUID (for peer recovery)
113------------------------------------------------
114
115.. code-block:: yaml
116
117 glusterfs:
118 server:
119 recover_peers:
120 kvm03.testserver.local:
121 enabled: true
122 uuid: ab6ac060-68f1-4f0b-8de4-70241dfb2279
123
124
Filip Pytloun6828ea52015-07-30 14:47:24 +0200[diff] [blame]125Client
126------
127
128.. code-block:: yaml
129
130 glusterfs:
131 client:
132 volumes:
133 glance:
134 path: /var/lib/glance/images
135 server: 192.168.1.21
136 user: glance
137 group: glance
Bogdan Radulescu3f27ebd2015-12-04 16:55:42 +0000[diff] [blame]138 enabled: true
Filip Pytloun6828ea52015-07-30 14:47:24 +0200[diff] [blame]139
140Read more
141=========
142
143* https://www.gluster.org/