.. _shared_file_systems_share_networks:

==============
Share networks
==============

Share network is an entity that encapsulates interaction with the OpenStack
Networking service. If the share driver that you selected runs in a mode
requiring Networking service interaction, specify the share network when
creating a share network.

How to create share network
~~~~~~~~~~~~~~~~~~~~~~~~~~~

List networks in a tenant, run:

.. code:: console

   $ neutron net-list
   +--------------+---------+---------------------------------------+
   | id           | name    | subnets                               |
   +--------------+---------+---------------------------------------+
   | bee7411d-... | public  | 884a6564-0f11-... 2001:db8::/64       |
   |              |         | e6da81fa-5d5f-... 172.24.4.0/24       |
   | 5ed5a854-... | private | 74dcfb5a-b4d7-... 10.0.0.0/24         |
   |              |         | cc297be2-5213-... fd7d:177d:a48b::/64 |
   +--------------+---------+---------------------------------------+

A share network stores network information that share servers can use where
shares are hosted. You can associate a share with a single share network.
When you create or update a share, you can optionally specify the ID of a share
network through which instances can access the share.

When you create a share network, you can specify only one type of network:

- OpenStack Networking (neutron). Specify a network ID and subnet ID.
  In this case ``manila.network.nova_network_plugin.NeutronNetworkPlugin``
  will be used.

- Legacy networking (nova-network). Specify a network ID.
  In this case ``manila.network.nova_network_plugin.NoveNetworkPlugin``
  will be used.

For more information about supported plug-ins for share networks, see
:ref:`shared_file_systems_network_plugins`.

A share network has these attributes:

- The IP block in Classless Inter-Domain Routing (CIDR) notation from which to
  allocate the network.

- The IP version of the network.

- The network type, which is `vlan`, `vxlan`, `gre`, or `flat`.

If the network uses segmentation, a segmentation identifier. For example, VLAN,
VXLAN, and GRE networks use segmentation.

To create a share network with private network and subnetwork, run:

.. code:: console

   $ manila share-network-create --neutron-net-id 5ed5a854-21dc-4ed3-870a-117b7064eb21 --neutron-subnet-id 74dcfb5a-b4d7-4855-86f5-a669729428dc --name my_share_net --description "My first share network"
   +-------------------+--------------------------------------+
   | Property          | Value                                |
   +-------------------+--------------------------------------+
   | name              | my_share_net                         |
   | segmentation_id   | None                                 |
   | created_at        | 2015-09-24T12:06:32.602174           |
   | neutron_subnet_id | 74dcfb5a-b4d7-4855-86f5-a669729428dc |
   | updated_at        | None                                 |
   | network_type      | None                                 |
   | neutron_net_id    | 5ed5a854-21dc-4ed3-870a-117b7064eb21 |
   | ip_version        | None                                 |
   | nova_net_id       | None                                 |
   | cidr              | None                                 |
   | project_id        | 20787a7ba11946adad976463b57d8a2f     |
   | id                | 5c3cbabb-f4da-465f-bc7f-fadbe047b85a |
   | description       | My first share network               |
   +-------------------+--------------------------------------+

The ``segmentation_id``, ``cidr``, ``ip_version``, and ``network_type``
share network attributes are automatically set to the values determined by the
network provider.

Check network list, run:

.. code:: console

   $ manila share-network-list
   +--------------------------------------+--------------+
   | id                                   | name         |
   +--------------------------------------+--------------+
   | 5c3cbabb-f4da-465f-bc7f-fadbe047b85a | my_share_net |
   +--------------------------------------+--------------+

If you configured the Generic driver with ``driver_handles_share_servers =
True`` (with the share servers) and had already some operations in the Shared
File Systems service, you can see ``manila_service_network`` in the neutron
list of networks. This network was created by Generic driver for inner usage.

.. code:: console

   $ neutron net-list
   +--------------+------------------------+------------------------------------+
   | id           | name                   | subnets                            |
   +--------------+------------------------+------------------------------------+
   | 3b5a629a-e...| manila_service_network | 4f366100-50... 10.254.0.0/28       |
   | bee7411d-d...| public                 | 884a6564-01... 2001:db8::/64       |
   |              |                        | e6da81fa-55... 172.24.4.0/24       |
   | 5ed5a854-2...| private                | 74dcfb5a-bd... 10.0.0.0/24         |
   |              |                        | cc297be2-51... fd7d:177d:a48b::/64 |
   +--------------+------------------------+------------------------------------+

You also can see detailed information about the share network including
``network_type``, ``segmentation_id`` fields:

.. code:: console

   $ neutron net-show manila_service_network
   +---------------------------+--------------------------------------+
   | Field                     | Value                                |
   +---------------------------+--------------------------------------+
   | admin_state_up            | True                                 |
   | id                        | 3b5a629a-e7a1-46a3-afb2-ab666fb884bc |
   | mtu                       | 0                                    |
   | name                      | manila_service_network               |
   | port_security_enabled     | True                                 |
   | provider:network_type     | vxlan                                |
   | provider:physical_network |                                      |
   | provider:segmentation_id  | 1068                                 |
   | router:external           | False                                |
   | shared                    | False                                |
   | status                    | ACTIVE                               |
   | subnets                   | 4f366100-5108-4fa2-b5b1-989a121c1403 |
   | tenant_id                 | 24c6491074e942309a908c674606f598     |
   +---------------------------+--------------------------------------+

You also can add and remove the security services to the share network. For
details, see :ref:`shared_file_systems_security_services`.