aboutsummaryrefslogtreecommitdiff
path: root/doc/source/reference/storage/manila-pure-guide.rst
blob: 9cb3e756aebb46d6dbf47086e7291c857e496fa3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
.. _manila-pure-guide:

==========================================================
Pure Storage FlashBlade File Services Driver for OpenStack
==========================================================

Overview
~~~~~~~~
The Pure Storage FlashBlade File Services Driver for OpenStack
provides NFS Shared File Systems to OpenStack.


Requirements
------------
- Pure Storage FlashBlade

- Purity//FB v2.3.0 or higher


Supported shared file systems and operations
--------------------------------------------
The driver supports NFS shares.

The following operations are supported:

- Create a share.

- Delete a share.

- Allow share access.

- Deny share access.

- Create a snapshot.

- Delete a snapshot.

- Revert from snapshot.

- Extend a share.

- Shrink a share.


Preparation and Deployment
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. important ::

   It is mandatory that FlashBlade management interface is reachable from the
   Shared File System node through the admin network, while the selected
   EVS data interface is reachable from OpenStack Cloud, such as through
   Neutron flat networking.


Configuration on Kolla deployment
---------------------------------

Enable Shared File Systems service and FlashBlade driver in
``/etc/kolla/globals.yml``

.. code-block:: yaml

   enable_manila: true
   enable_manila_backend_flashblade: true

Configure the OpenStack networking so it can reach FlashBlade Management
interface and FlashBlade Data interface.

To configure two physical networks, physnet1 and physnet2, with
ports eth1 and eth2 associated respectively:

In ``/etc/kolla/globals.yml`` set:

.. code-block:: yaml

   neutron_bridge_name: "br-ex,br-ex2"
   neutron_external_interface: "eth1,eth2"

.. note::

   ``eth1`` is used to Neutron external interface and ``eth2`` is
   used to FlashBlade data interface.

FlashBlade back end configuration
---------------------------------

In ``/etc/kolla/globals.yml`` uncomment and set:

.. code-block:: yaml

   manila_flashblade_mgmt_vip: "172.24.44.15"
   manila_flashblade_data_vip: "172.24.45.22"
   manila_flashblade_api: "<API token for admin-privilaged user>"

Configuration on FlashBlade
---------------------------

Create the FlashBlade data network in Kolla OpenStack:

List the available tenants:

.. code-block:: console

   $ openstack project list

Create a network to the given tenant (service), providing the tenant ID,
a name for the network, the name of the physical network over which the
virtual network is implemented, and the type of the physical mechanism by
which the virtual network is implemented:

.. code-block:: console

   $ openstack network create --project <SERVICE_ID> \
     --provider-physical-network physnet2 \
     --provider-network-type flat \
     flashblade_network

*Optional* - List available networks:

.. code-block:: console

   $ openstack network list

Create a subnet to the same tenant (service), the gateway IP of this subnet,
a name for the subnet, the network ID created before, and the CIDR of
subnet:

.. code-block:: console

   $ openstack subnet create --project <SERVICE_ID>  --gateway <GATEWAY> \
     --subnet_range <SUBNET_CIDR> flashblade_subnet

*Optional* - List available subnets:

.. code-block:: console

   $ openstack subnet list

Add the subnet interface to a router, providing the router ID and subnet
ID created before:

.. code-block:: console

   $ openstack router add submet <ROUTER_ID> <SUBNET_ID>

Create a share
~~~~~~~~~~~~~~

Create a default share type before running manila-share service:

.. code-block:: console

   $ openstack share type create default_share_flashblade False

   +--------------------------------------+--------------------------+------------+------------+--------------------------------------+-------------------------+
   | ID                                   | Name                     | visibility | is_default | required_extra_specs                 | optional_extra_specs    |
   +--------------------------------------+--------------------------+------------+------------+--------------------------------------+-------------------------+
   | 3e54c8a2-1e50-455e-89a0-96bb52876c35 | default_share_flashblade | public     | -          | driver_handles_share_servers : False | snapshot_support : True |
   +--------------------------------------+--------------------------+------------+------------+--------------------------------------+-------------------------+

Create a NFS share using the FlashBlade back end:

.. code-block:: console

   $ openstack share create --name <myflashbladeshare \
     --description "My Manila share" \
     --share-type default_share_flashblade \
     NFS 1

Verify Operation:

.. code-block:: console

   $ openstack share list

   +--------------------------------------+-------------------+------+-------------+-----------+-----------+--------------------------+-----------------+-------------------+
   | ID                                   | Name              | Size | Share Proto | Status    | Is Public | Share Type Name          | Host            | Availability Zone |
   +--------------------------------------+-------------------+------+-------------+-----------+-----------+--------------------------+-----------------+-------------------+
   | 721c0a6d-eea6-41af-8c10-72cd98985203 | myflashbladeshare | 1    | NFS         | available | False     | default_share_flashblade | control@fb1#FB1 | nova              |
   +--------------------------------------+-------------------+------+-------------+-----------+-----------+--------------------------+-----------------+-------------------+

.. code-block:: console

   $ openstack share show myflashbladeshare

   +-----------------------------+-----------------------------------------------------------------+
   | Property                    | Value                                                           |
   +-----------------------------+-----------------------------------------------------------------+
   | status                      | available                                                       |
   | share_type_name             | default_share_flashblade                                        |
   | description                 | My Manila share                                                 |
   | availability_zone           | nova                                                            |
   | share_network_id            | None                                                            |
   | export_locations            |                                                                 |
   |                             | path = 172.24.53.1:/shares/45ed6670-688b-4cf0-bfe7-34956648fb84 |
   |                             | preferred = False                                               |
   |                             | is_admin_only = False                                           |
   |                             | id = e81e716f-f1bd-47b2-8a56-2c2f9e33a98e                       |
   |                             | share_instance_id = 45ed6670-688b-4cf0-bfe7-34956648fb84        |
   | share_server_id             | None                                                            |
   | host                        | control@fb1#FB1                                                 |
   | access_rules_status         | active                                                          |
   | snapshot_id                 | None                                                            |
   | is_public                   | False                                                           |
   | task_state                  | None                                                            |
   | snapshot_support            | True                                                            |
   | id                          | 721c0a6d-eea6-41af-8c10-72cd98985203                            |
   | size                        | 1                                                               |
   | user_id                     | ba7f6d543713488786b4b8cb093e7873                                |
   | name                        | myflashbladeshare                                               |
   | share_type                  | 3e54c8a2-1e50-455e-89a0-96bb52876c35                            |
   | has_replicas                | False                                                           |
   | replication_type            | None                                                            |
   | created_at                  | 2016-10-14T14:50:47.000000                                      |
   | share_proto                 | NFS                                                             |
   | consistency_group_id        | None                                                            |
   | source_cgsnapshot_member_id | None                                                            |
   | project_id                  | c3810d8bcc3346d0bdc8100b09abbbf1                                |
   | metadata                    | {}                                                              |
   +-----------------------------+-----------------------------------------------------------------+

.. _flashblade_configure_multiple_back_ends:

Configure multiple back ends
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

An administrator can configure an instance of Manila to provision shares from
one or more back ends. Each back end leverages an instance of a vendor-specific
implementation of the Manila driver API.

The name of the back end is declared as a configuration option
share_backend_name within a particular configuration stanza that contains the
related configuration options for that back end.

So, in the case of an multiple back ends deployment, it is necessary to change
the default share backends before deployment.

Modify the file ``/etc/kolla/config/manila.conf`` and add the contents:

.. path /etc/kolla/config/manila.conf
.. code-block:: ini

   [DEFAULT]
   enabled_share_backends = generic,fb1,fb2

Modify the file ``/etc/kolla/config/manila-share.conf`` and add the contents:

.. path /etc/kolla/config/manila-share.conf
.. code-block:: ini

   [generic]
   share_driver = manila.share.drivers.generic.GenericShareDriver
   interface_driver = manila.network.linux.interface.OVSInterfaceDriver
   driver_handles_share_servers = True
   service_instance_password = manila
   service_instance_user = manila
   service_image_name = manila-service-image
   share_backend_name = GENERIC

   [fb1]
   share_backend_name = FB1
   share_driver = manila.share.drivers.purestorage.flashblade.FlashBladeShareDriver
   driver_handles_share_servers = False
   flashblade_mgmt_vip = <fb1_mgmt_ip>
   flashblade_data_vip = <fb1_data_ip>
   flashblade_api = <FB1 API token>

   [fb2]
   share_backend_name = FB2
   share_driver = manila.share.drivers.purestorage.flashblade.FlashBladeShareDriver
   driver_handles_share_servers = False
   flashblade_mgmt_vip = <fb2_mgmt_ip>
   flashblade_data_vip = <fb2_data_ip>
   flashblade_api = <FB2 API token>

For more information about how to manage shares, see the
:manila-doc:`Manage shares <user/create-and-manage-shares.html>`.

For details on how to use the Pure Storage FlashBlade, refer to the
`Pure Storage Manila Reference Guide <https://docs.openstack.org/manila/latest/configuration/shared-file-systems/drivers/purestorage-flashblade-driver.html>`_.

The use of this backend requires that the ``purity_fb`` SDK package is
installed in the ``manila-share`` container. To do this follow the steps
outlined in the `kolla image building guide <https://docs.openstack.org/kolla/latest/admin/image-building.html>`_
particularly the ``Package Customisation`` and ``Custom Repos`` sections.