Browse Source

Add user guide for share network subnets

This patch adds documentation in the user guide module to make it
fit into the introduced share network with multiple subnets change.

Change-Id: I829f2e915ba2e20f15af639cccff99b6bba33a24
Partial-Bug: #1843953
(cherry picked from commit 9ee7482697)
(cherry picked from commit 9468f38506)
tags/9.1.3
silvacarloss 9 months ago
committed by Carlos Eduardo
parent
commit
5c9fb522a4
3 changed files with 429 additions and 0 deletions
  1. +2
    -0
      doc/source/user/index.rst
  2. +307
    -0
      doc/source/user/share-network-operations.rst
  3. +120
    -0
      doc/source/user/share-network-subnet-operations.rst

+ 2
- 0
doc/source/user/index.rst View File

@@ -20,4 +20,6 @@ User

API
create-and-manage-shares
share-network-operations
share-network-subnet-operations
troubleshooting-asynchronous-failures

+ 307
- 0
doc/source/user/share-network-operations.rst View File

@@ -0,0 +1,307 @@
.. _share_network:

================================
Create and manage share networks
================================

A share network stores network information to create and manage shares. A share
network provides a way to designate a network to export shares upon. In the
most common use case, you can create a share network with a private OpenStack
(neutron) network that you own. If the share network is an isolated network,
manila can provide hard guarantees of network and data isolation for your
shared file systems in a multi-tenant cloud. In some clouds, however, shares
cannot be exported directly upon private project networks; and the cloud may
have provider networks that are designated for use with share networks.

In either case, as long as the underlying network is connected to the clients
(virtual machines, containers or bare metals), there will exist a direct path
to communicate with shares exported on the share networks.

Create share networks
~~~~~~~~~~~~~~~~~~~~~

#. Create a share network.

.. code-block:: console

$ manila share-network-create \
--name sharenetwork1 \
--description "Share Network created for demo purposes" \
--neutron-net-id c297b020-025a-4f3e-8120-57ea90404afb \
--neutron-subnet-id 29ecfbd5-a9be-467e-8b4a-3415d1f82888
+-------------------+-----------------------------------------+
| Property | Value |
+-------------------+-----------------------------------------+
| name | sharenetwork1 |
| segmentation_id | None |
| created_at | 2019-07-02T11:14:06.228816 |
| neutron_subnet_id | 29ecfbd5-a9be-467e-8b4a-3415d1f82888 |
| updated_at | None |
| network_type | None |
| neutron_net_id | c297b020-025a-4f3e-8120-57ea90404afb |
| ip_version | None |
| cidr | None |
| project_id | 907004508ef4447397ce6741a8f037c1 |
| id | feed6a6c-f9e0-45ba-9a2b-0db76bde63e1 |
| description | Share Network created for demo purposes |
+-------------------+-----------------------------------------+

#. Show the created share network.

.. code-block:: console

$ manila share-network-show sharenetwork1
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
| id | feed6a6c-f9e0-45ba-9a2b-0db76bde63e1 |
| name | sharenetwork1 |
| project_id | 5b23075b4b504261a5987b18588f86cf |
| created_at | 2019-10-09T04:19:31.000000 |
| updated_at | None |
| neutron_net_id | c297b020-025a-4f3e-8120-57ea90404afb |
| neutron_subnet_id | 29ecfbd5-a9be-467e-8b4a-3415d1f82888 |
| network_type | None |
| segmentation_id | None |
| cidr | None |
| ip_version | None |
| description | None |
| gateway | None |
| mtu | None |
+-------------------+--------------------------------------+

.. note::
Since API version 2.51, a share network is able to span multiple
subnets in different availability zones and the network information
will be stored on each subnet. To accommodate adding multiple subnets,
the share network create command was updated to accept an availability
zone as parameter. This parameter will be used in the share network
creation process which also creates a new subnet. If you do not specify
an availability zone, the created subnet will be considered default by
the Shared File Systems service. A default subnet is expected to be
available in all availability zones of the cloud. So when you are
creating a share network, the output will be similar to:

.. code-block:: console

$ manila share-network-create \
--name sharenetwork1 \
--description "Share Network created for demo purposes" \
--availability-zone manila-zone-0
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Property | Value |
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | feed6a6c-f9e0-45ba-9a2b-0db76bde63e1 |
| name | sharenetwork1 |
| project_id | 8c2962a4832743469a336f7c179f7d34 |
| created_at | 2019-10-09T04:19:31.000000 |
| updated_at | None |
| description | Share Network created for demo purposes |
| share_network_subnets | [{'id': '900d9ddc-7062-404e-8ef5-f63b84782d89', 'availability_zone': 'manila-zone-0', 'created_at': '2019-10-09T04:19:31.000000', 'updated_at': None, 'segmentation_id': None, 'neutron_subnet_id': None, 'neutron_net_id': None, 'ip_version': None, 'cidr': None, 'network_type': None, 'mtu': None, 'gateway': None}] |
+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

List share networks
~~~~~~~~~~~~~~~~~~~

#. List share networks.

.. code-block:: console

$ manila share-network-list
+--------------------------------------+---------------+
| id | name |
+--------------------------------------+---------------+
| feed6a6c-f9e0-45ba-9a2b-0db76bde63e1 | sharenetwork1 |
+--------------------------------------+---------------+

Update share networks
~~~~~~~~~~~~~~~~~~~~~

#. Update the share network data.

.. code-block:: console

$ manila share-network-update sharenetwork1 \
--neutron-net-id a27160ca-5595-4c62-bf54-a04fb7b14316 \
--neutron-subnet-id f043f4b0-c05e-493f-bbe9-99689e2187d2
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
| id | feed6a6c-f9e0-45ba-9a2b-0db76bde63e1 |
| name | sharenetwork1 |
| project_id | 5b23075b4b504261a5987b18588f86cf |
| created_at | 2019-10-09T04:19:31.000000 |
| updated_at | 2019-10-10T17:14:08.970945 |
| neutron_net_id | a27160ca-5595-4c62-bf54-a04fb7b14316 |
| neutron_subnet_id | f043f4b0-c05e-493f-bbe9-99689e2187d2 |
| network_type | None |
| segmentation_id | None |
| cidr | None |
| ip_version | None |
| description | None |
| gateway | None |
| mtu | None |
+-------------------+--------------------------------------+

#. Show details of the updated share network.

.. code-block:: console

$ manila share-network-show sharenetwork1
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
| id | feed6a6c-f9e0-45ba-9a2b-0db76bde63e1 |
| name | sharenetwork1 |
| project_id | 5b23075b4b504261a5987b18588f86cf |
| created_at | 2019-10-09T04:19:31.000000 |
| updated_at | 2019-10-10T17:14:09.000000 |
| neutron_net_id | a27160ca-5595-4c62-bf54-a04fb7b14316 |
| neutron_subnet_id | f043f4b0-c05e-493f-bbe9-99689e2187d2 |
| network_type | None |
| segmentation_id | None |
| cidr | None |
| ip_version | None |
| description | None |
| gateway | None |
| mtu | None |
+-------------------+--------------------------------------+

.. note::
You cannot update the ``neutron_net_id`` and ``neutron_subnet_id`` of
a share network that has shares exported onto it.

.. note::
From API version 2.51, updating the ``neutron_net_id`` and
``neutron_subnet_id`` is possible only for a default subnet. Non default
subnets cannot be updated after they are created. You may delete the
subnet in question, and re-create it. The output will look as shown
below:

.. code-block:: console

$ manila share-network-update sharenetwork1 \
--neutron-net-id a27160ca-5595-4c62-bf54-a04fb7b14316 \
--neutron-subnet-id f043f4b0-c05e-493f-bbe9-99689e2187d2
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Property | Value |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | feed6a6c-f9e0-45ba-9a2b-0db76bde63e1 |
| name | sharenetwork1 |
| project_id | 8c2962a4832743469a336f7c179f7d34 |
| created_at | 2019-10-09T04:19:31.000000 |
| updated_at | 2019-10-10T17:14:09.000000 |
| description | Share Network created for demo purposes |
| share_network_subnets | [{'id': '900d9ddc-7062-404e-8ef5-f63b84782d89', 'availability_zone': None, 'created_at': '2019-10-09T04:19:31.000000', 'updated_at': '2019-10-09T07:39:59.000000', 'segmentation_id': None, 'neutron_net_id': 'a27160ca-5595-4c62-bf54-a04fb7b14316', 'neutron_subnet_id': 'f043f4b0-c05e-493f-bbe9-99689e2187d2', 'ip_version': None, 'cidr': None, 'network_type': None, 'mtu': None, 'gateway': None}] |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Share network show
~~~~~~~~~~~~~~~~~~

#. Show details of a share network.

.. code-block:: console

$ manila share-network-show sharenetwork1
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
| id | feed6a6c-f9e0-45ba-9a2b-0db76bde63e1 |
| name | sharenetwork1 |
| project_id | 5b23075b4b504261a5987b18588f86cf |
| created_at | 2019-10-09T04:19:31.000000 |
| updated_at | 2019-10-10T17:14:09.000000 |
| neutron_net_id | fake_updated_net_id |
| neutron_subnet_id | fake_updated_subnet_id |
| network_type | None |
| segmentation_id | None |
| cidr | None |
| ip_version | None |
| description | None |
| gateway | None |
| mtu | None |
+-------------------+--------------------------------------+

.. note::
Since API version 2.51, the ``share-network-show`` command also shows
a list of subnets contained in the share network as show below.

.. code-block:: console

+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Property | Value |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | feed6a6c-f9e0-45ba-9a2b-0db76bde63e1 |
| name | sharenetwork1 |
| project_id | 8c2962a4832743469a336f7c179f7d34 |
| created_at | 2019-10-09T04:19:31.000000 |
| updated_at | None |
| description | Share Network created for demo purposes |
| share_network_subnets | [{'id': '900d9ddc-7062-404e-8ef5-f63b84782d89', 'availability_zone': None, 'created_at': '2019-10-09T04:19:31.000000', 'updated_at': '2019-10-09T07:39:59.000000', 'segmentation_id': None, 'neutron_net_id': 'fake_updated_net_id', 'neutron_subnet_id': 'fake_updated_subnet_id', 'ip_version': None, 'cidr': None, 'network_type': None, 'mtu': None, 'gateway': None}] |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Add security service/s
~~~~~~~~~~~~~~~~~~~~~~

#. Add a pre existent security service in a given share network.

.. code-block:: console

$ manila share-network-security-service-add \
sharenetwork1 \
my_sec_service
$ manila share-network-security-service-list sharenetwork1
+--------------------------------------+----------------+--------+------+
| id | name | status | type |
+--------------------------------------+----------------+--------+------+
| 50303c35-2c53-4d37-a0d9-61dfe3789569 | my_sec_service | new | ldap |
+--------------------------------------+----------------+--------+------+

List share network security services
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#. List all the security services existent in a share network.

.. code-block:: console

$ manila share-network-security-service-list sharenetwork1
+--------------------------------------+----------------+--------+------+
| id | name | status | type |
+--------------------------------------+----------------+--------+------+
| 50303c35-2c53-4d37-a0d9-61dfe3789569 | my_sec_service | new | ldap |
+--------------------------------------+----------------+--------+------+

Remove a security service from a share network
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#. Remove a security service from a given share network.

.. code-block:: console

$ manila share-network-security-service-remove \
sharenetwork1 \
my_sec_service
$ manila share-network-security-service-list sharenetwork1
+----+------+--------+------+
| id | name | status | type |
+----+------+--------+------+
+----+------+--------+------+

Delete share networks
~~~~~~~~~~~~~~~~~~~~~

#. Delete a share network.

.. code-block:: console

$ manila share-network-delete sharenetwork1

#. List all share networks

.. code-block:: console

$ manila share-network-list
+--------------------------------------+---------------+
| id | name |
+--------------------------------------+---------------+
+--------------------------------------+---------------+

+ 120
- 0
doc/source/user/share-network-subnet-operations.rst View File

@@ -0,0 +1,120 @@
.. _share_network_subnet:

=======================================
Create and manage share network subnets
=======================================

A share network subnet stores network information to create and manage shares.
To create and manage your share network subnets, you can use ``manila`` client
commands. You can create multiple subnets in a share network, and if you do
not specify an availability zone, the subnet you are creating will be
considered default by the Shared File Systems service. The default subnet
spans all availability zones. You cannot have more than one default subnet
per share network.

Create a subnet in an existing share network
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#. Create a subnet related to the given share network

.. code-block:: console

$ manila share-network-subnet-create \
sharenetwork1 \
--availability-zone manila-zone-0 \
--neutron-net-id a27160ca-5595-4c62-bf54-a04fb7b14316 \
--neutron-subnet-id f043f4b0-c05e-493f-bbe9-99689e2187d2
+--------------------+--------------------------------------+
| Property | Value |
+--------------------+--------------------------------------+
| id | be3ae5ad-a22c-494f-840e-5e3526e34e0f |
| availability_zone | manila-zone-0 |
| share_network_id | 35f44d3c-8888-429e-b8c7-8a29dead6e5b |
| share_network_name | sharenetwork1 |
| created_at | 2019-10-09T04:54:48.000000 |
| segmentation_id | None |
| neutron_subnet_id | f043f4b0-c05e-493f-bbe9-99689e2187d2 |
| updated_at | None |
| neutron_net_id | a27160ca-5595-4c62-bf54-a04fb7b14316 |
| ip_version | None |
| cidr | None |
| network_type | None |
| mtu | None |
| gateway | None |
+--------------------+--------------------------------------+


#. Show the share network to verify if the created subnet is attached

.. code-block:: console

$ manila share-network-show sharenetwork1
+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Property | Value |
+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | 35f44d3c-8888-429e-b8c7-8a29dead6e5b |
| name | sharenetwork1 |
| project_id | 8c2962a4832743469a336f7c179f7d34 |
| created_at | 2019-10-09T04:19:31.000000 |
| updated_at | None |
| description | Share Network created for demo purposes |
| share_network_subnets | [{'id': 'be3ae5ad-a22c-494f-840e-5e3526e34e0f', 'availability_zone': 'manila-zone-0', 'created_at': '2019-10-09T04:54:48.000000', 'updated_at': None, 'segmentation_id': None, 'neutron_net_id': 'a27160ca-5595-4c62-bf54-a04fb7b14316', 'neutron_subnet_id': 'f043f4b0-c05e-493f-bbe9-99689e2187d2', 'ip_version': None, 'cidr': None, 'network_type': None, 'mtu': None, 'gateway': None}] |
+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


Show a share network subnet
~~~~~~~~~~~~~~~~~~~~~~~~~~~

#. Show an existent subnet in a given share network

.. code-block:: console

$ manila share-network-subnet-show \
sharenetwork1 \
be3ae5ad-a22c-494f-840e-5e3526e34e0f
+--------------------+--------------------------------------+
| Property | Value |
+--------------------+--------------------------------------+
| id | be3ae5ad-a22c-494f-840e-5e3526e34e0f |
| availability_zone | manila-zone-0 |
| share_network_id | 35f44d3c-8888-429e-b8c7-8a29dead6e5b |
| share_network_name | sharenetwork1 |
| created_at | 2019-10-09T04:54:48.000000 |
| segmentation_id | None |
| neutron_subnet_id | f043f4b0-c05e-493f-bbe9-99689e2187d2 |
| updated_at | None |
| neutron_net_id | a27160ca-5595-4c62-bf54-a04fb7b14316 |
| ip_version | None |
| cidr | None |
| network_type | None |
| mtu | None |
| gateway | None |
+--------------------+--------------------------------------+

Delete a share network subnet
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#. Delete a specific share network subnet

.. code-block:: console

$ manila share-network-subnet-delete \
sharenetwork1 \
be3ae5ad-a22c-494f-840e-5e3526e34e0f

#. Verify that it has been deleted

.. code-block:: console

$ manila share-network-show sharenetwork1
+-----------------------+-----------------------------------------+
| Property | Value |
+-----------------------+-----------------------------------------+
| id | 35f44d3c-8888-429e-b8c7-8a29dead6e5b |
| name | sharenetwork1 |
| project_id | 8c2962a4832743469a336f7c179f7d34 |
| created_at | 2019-10-09T04:19:31.000000 |
| updated_at | None |
| description | Share Network created for demo purposes |
| share_network_subnets | [] |
+-----------------------+-----------------------------------------+

Loading…
Cancel
Save