blob: 2fa486cd6e2e4e779bf6d974e2d4bb9de8be64b0 [file] [log] [blame]
Vasyl Saienko7a4ae402018-01-30 16:37:14 +02001==============
2Manila Formula
3==============
4
5Manila is an OpenStack project to provide Shared Filesystems as a service”.
6
7Sample pillars
8==============
9
10Single manila service
11
12.. code-block:: yaml
13
14 manila:
15 common:
16 database:
17 engine: mysql
18 host: 10.20.0.101
19 port: 3306
20 name: manila
21 user: manila
22 password: segreto
23 identity:
24 engine: keystone
25 host: 10.20.0.101
26 port: 35357
27 user: manila
28 password: segreto
29 region: RegionOne
30 tenant: service
31 endpoint_type: internalURL
32 cache:
33 engine: memcached
34 members:
35 - host: 10.20.0.102
36 port: 11211
37 - host: 10.20.0.103
38 port: 11211
39 - host: 10.20.0.104
40 port: 11211
41 api:
42 bind:
43 host: 10.20.0.102
44
45
Vasyl Saienkobf5c1202018-03-01 22:24:14 +020046Backend configuration
47=====================
48
49
Vasyl Saienkoae9441c2018-03-02 12:08:54 +020050Nexenta driver
Vasyl Saienkobf5c1202018-03-01 22:24:14 +020051
52.. code-block:: yaml
53
54 manila:
55 share:
56 enabled_share_backends:
57 nexenta:
58 name: nexenta
59 type: nexenta
60 enabled: true
61 dhss: false
62 nexenta_host: 1.2.3.4
63 nexenta_password: secretpassword
64 nexenta_user: nonexistent
65 nexenta_volume: volume1
66
Vasyl Saienkoae9441c2018-03-02 12:08:54 +020067Glusterfs driver
68
69.. code-block:: yaml
70
71
72 manila:
73 share:
74 enabled_share_backends:
75 glusterfs:
76 name: glusterfs
77 type: glusterfs
78 enabled: true
79 share_driver: manila.share.drivers.glusterfs_native.GlusterfsNativeShareDriver
80 dhss: false
81 glusterfs_ganesha_server_ip: 1.2.3.4
82 glusterfs_ganesha_server_password: secretpassword
83 glusterfs_ganesha_server_username: nonexistent
84 glusterfs_mount_point_base: state_path/mnt
85 glusterfs_server_password: secretpassword
86 glusterfs_path_to_private_key: /path/to/key
87 glusterfs_nfs_server_type: glusterfs
88 glusterfs_share_layout: share_layout
89 glusterfs_target: remove:target
90 glusterfs_servers:
91 - server1
92 - server2
93 glusterfs_volume_pattern: manila-share-volume-d+$
94
Vasyl Saienko0343ebf2018-04-12 11:33:28 +030095Client usage:
96=============
97
98The `manila.client` state provides ability to manage manila resources.
99
100Manage `share_type`
101
102.. code-block:: yaml
103
104
105 manila:
106 client:
107 enabled: true
108 server:
109 admin_identity:
110 share_type:
111 default:
112 extra_specs:
113 driver_handles_share_servers: false
Vasyl Saienkoae9441c2018-03-02 12:08:54 +0200114
sgarbuze8677fc2018-05-15 16:37:17 +0300115Enhanced logging with logging.conf
116----------------------------------
117
118By default logging.conf is disabled.
119
120That is possible to enable per-binary logging.conf with new variables:
121 * openstack_log_appender - set it to true to enable log_config_append for all OpenStack services;
122 * openstack_fluentd_handler_enabled - set to true to enable FluentHandler for all Openstack services.
123
124Only WatchedFileHandler and FluentHandler are available.
125
126Also it is possible to configure this with pillar:
127
128.. code-block:: yaml
129
130 manila:
131 common:
132 logging:
133 log_appender: true
134 log_handlers:
135 watchedfile:
136 enabled: true
137 fluentd:
138 enabled: true
139
Oleksandr Shyshko9de56382018-09-07 17:32:21 +0300140Enable x509 and ssl communication between Manila and Galera cluster.
141---------------------
142By default communication between Manila and Galera is unsecure.
143
144manila:
145 common:
146 database:
147 x509:
148 enabled: True
149
150You able to set custom certificates in pillar:
151
152manila:
153 common:
154 database:
155 x509:
156 cacert: (certificate content)
157 cert: (certificate content)
158 key: (certificate content)
159
160You can read more about it here:
161 https://docs.openstack.org/security-guide/databases/database-access-control.html
162
Vasyl Saienko7a4ae402018-01-30 16:37:14 +0200163More information
164================
165
166* https://wiki.openstack.org/wiki/Telemetry
167* https://docs.openstack.org/developer/manila/
168* https://github.com/openstack/manila
169* https://bugs.launchpad.net/manila
170
171
172Documentation and Bugs
173======================
174
175To learn how to install and update salt-formulas, consult the documentation
176available online at:
177
178 http://salt-formulas.readthedocs.io/
179
180In the unfortunate event that bugs are discovered, they should be reported to
181the appropriate issue tracker. Use GitHub issue tracker for specific salt
182formula:
183
184 https://github.com/salt-formulas/salt-formula-manila/issues
185
186For feature requests, bug reports or blueprints affecting entire ecosystem,
187use Launchpad salt-formulas project:
188
189 https://launchpad.net/salt-formulas
190
191Developers wishing to work on the salt-formulas projects should always base
192their work on master branch and submit pull request against specific formula.
193
194You should also subscribe to mailing list (salt-formulas@freelists.org):
195
196 https://www.freelists.org/list/salt-formulas
197
198Any questions or feedback is always welcome so feel free to join our IRC
199channel:
200
201 #salt-formulas @ irc.freenode.net