diff --git a/doc/install-guide-debconf/source/conf.py b/doc/install-guide-debconf/source/conf.py index 61b3f138f1..6dede50ec7 100644 --- a/doc/install-guide-debconf/source/conf.py +++ b/doc/install-guide-debconf/source/conf.py @@ -102,6 +102,7 @@ exclude_patterns = ['common/cli*', 'common/nova*', 'common/get-started-data-processing.rst', 'common/get-started-object-storage.rst', 'common/get-started-orchestration.rst', + 'common/get-started-shared-file-systems.rst', 'common/get-started-telemetry.rst', 'common/dashboard-customizing.rst', 'shared/note_configuration_vary_by_distribution.rst'] diff --git a/doc/install-guide-debconf/source/index.rst b/doc/install-guide-debconf/source/index.rst index 670abf8ced..e6e184b23c 100644 --- a/doc/install-guide-debconf/source/index.rst +++ b/doc/install-guide-debconf/source/index.rst @@ -44,7 +44,6 @@ Contents neutron.rst horizon.rst cinder.rst - manila.rst launch-instance.rst Appendix diff --git a/doc/install-guide-debconf/source/launch-instance-manila-dhss-false-option1.rst b/doc/install-guide-debconf/source/launch-instance-manila-dhss-false-option1.rst deleted file mode 120000 index 3589d45aaf..0000000000 --- a/doc/install-guide-debconf/source/launch-instance-manila-dhss-false-option1.rst +++ /dev/null @@ -1 +0,0 @@ -../../install-guide/source/launch-instance-manila-dhss-false-option1.rst \ No newline at end of file diff --git a/doc/install-guide-debconf/source/launch-instance-manila-dhss-true-option2.rst b/doc/install-guide-debconf/source/launch-instance-manila-dhss-true-option2.rst deleted file mode 120000 index 978d54aaf2..0000000000 --- a/doc/install-guide-debconf/source/launch-instance-manila-dhss-true-option2.rst +++ /dev/null @@ -1 +0,0 @@ -../../install-guide/source/launch-instance-manila-dhss-true-option2.rst \ No newline at end of file diff --git a/doc/install-guide-debconf/source/launch-instance-manila.rst b/doc/install-guide-debconf/source/launch-instance-manila.rst deleted file mode 120000 index 415e2df2ea..0000000000 --- a/doc/install-guide-debconf/source/launch-instance-manila.rst +++ /dev/null @@ -1 +0,0 @@ -../../install-guide/source/launch-instance-manila.rst \ No newline at end of file diff --git a/doc/install-guide-debconf/source/manila-controller-install.rst b/doc/install-guide-debconf/source/manila-controller-install.rst deleted file mode 100644 index 8a7db79542..0000000000 --- a/doc/install-guide-debconf/source/manila-controller-install.rst +++ /dev/null @@ -1,243 +0,0 @@ -.. _manila-controller: - -Install and configure controller node -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This section describes how to install and configure the Shared File Systems -service, code-named manila, on the controller node. This service requires at -least one additional share node that manages file storage drivers. - -Prerequisites -------------- - -Before you install and configure the Share File System service, you -must create a database, service credentials, and API endpoints. - -#. To create the database, complete these steps: - - * Use the database access client to connect to the database server as the - ``root`` user: - - .. code-block:: console - - $ mysql -u root -p - - * Create the ``manila`` database: - - .. code-block:: console - - CREATE DATABASE manila; - - * Grant proper access to the ``manila`` database: - - .. code-block:: console - - GRANT ALL PRIVILEGES ON manila.* TO 'manila'@'localhost' \ - IDENTIFIED BY 'MANILA_DBPASS'; - GRANT ALL PRIVILEGES ON manila.* TO 'manila'@'%' \ - IDENTIFIED BY 'MANILA_DBPASS'; - - Replace ``MANILA_DBPASS`` with a suitable password. - - * Exit the database access client. - -#. Source the ``admin`` credentials to gain access to admin-only CLI commands: - - .. code-block:: console - - $ . admin-openrc - -#. To create the service credentials, complete these steps: - - * Create a ``manila`` user: - - .. code-block:: console - - $ openstack user create --domain default --password-prompt manila - User Password: - Repeat User Password: - +-----------+----------------------------------+ - | Field | Value | - +-----------+----------------------------------+ - | domain_id | e0353a670a9e496da891347c589539e9 | - | enabled | True | - | id | 83a3990fc2144100ba0e2e23886d8acc | - | name | manila | - +-----------+----------------------------------+ - - * Add the ``admin`` role to the ``manila`` user: - - .. code-block:: console - - $ openstack role add --project service --user manila admin - - .. note:: - - This command provides no output. - - * Create the ``manila`` and ``manilav2`` service entities: - - .. code-block:: console - - $ openstack service create --name manila \ - --description "OpenStack Shared File Systems" share - +-------------+----------------------------------+ - | Field | Value | - +-------------+----------------------------------+ - | description | OpenStack Shared File Systems | - | enabled | True | - | id | 82378b5a16b340aa9cc790cdd46a03ba | - | name | manila | - | type | share | - +-------------+----------------------------------+ - - .. code-block:: console - - $ openstack service create --name manilav2 \ - --description "OpenStack Shared File Systems" sharev2 - +-------------+----------------------------------+ - | Field | Value | - +-------------+----------------------------------+ - | description | OpenStack Shared File Systems | - | enabled | True | - | id | 30d92a97a81a4e5d8fd97a32bafd7b88 | - | name | manilav2 | - | type | sharev2 | - +-------------+----------------------------------+ - - .. note:: - - The Share File System services require two service entities. - -#. Create the Shared File Systems service API endpoints: - - .. code-block:: console - - $ openstack endpoint create --region RegionOne \ - share public http://controller:8786/v1/%\(tenant_id\)s - +--------------+-----------------------------------------+ - | Field | Value | - +--------------+-----------------------------------------+ - | enabled | True | - | id | 0bd2bbf8d28b433aaea56a254c69f69d | - | interface | public | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 82378b5a16b340aa9cc790cdd46a03ba | - | service_name | manila | - | service_type | share | - | url | http://controller:8786/v1/%(tenant_id)s | - +--------------+-----------------------------------------+ - - $ openstack endpoint create --region RegionOne \ - share internal http://controller:8786/v1/%\(tenant_id\)s - +--------------+-----------------------------------------+ - | Field | Value | - +--------------+-----------------------------------------+ - | enabled | True | - | id | a2859b5732cc48b5b083dd36dafb6fd9 | - | interface | internal | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 82378b5a16b340aa9cc790cdd46a03ba | - | service_name | manila | - | service_type | share | - | url | http://controller:8786/v1/%(tenant_id)s | - +--------------+-----------------------------------------+ - - $ openstack endpoint create --region RegionOne \ - share admin http://controller:8786/v1/%\(tenant_id\)s - +--------------+-----------------------------------------+ - | Field | Value | - +--------------+-----------------------------------------+ - | enabled | True | - | id | f7f46df93a374cc49c0121bef41da03c | - | interface | admin | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 82378b5a16b340aa9cc790cdd46a03ba | - | service_name | manila | - | service_type | share | - | url | http://controller:8786/v1/%(tenant_id)s | - +--------------+-----------------------------------------+ - - .. code-block:: console - - $ openstack endpoint create --region RegionOne \ - sharev2 public http://controller:8786/v2/%\(tenant_id\)s - +--------------+-----------------------------------------+ - | Field | Value | - +--------------+-----------------------------------------+ - | enabled | True | - | id | d63cc0d358da4ea680178657291eddc1 | - | interface | public | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 30d92a97a81a4e5d8fd97a32bafd7b88 | - | service_name | manilav2 | - | service_type | sharev2 | - | url | http://controller:8786/v2/%(tenant_id)s | - +--------------+-----------------------------------------+ - - $ openstack endpoint create --region RegionOne \ - sharev2 internal http://controller:8786/v2/%\(tenant_id\)s - +--------------+-----------------------------------------+ - | Field | Value | - +--------------+-----------------------------------------+ - | enabled | True | - | id | afc86e5f50804008add349dba605da54 | - | interface | internal | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 30d92a97a81a4e5d8fd97a32bafd7b88 | - | service_name | manilav2 | - | service_type | sharev2 | - | url | http://controller:8786/v2/%(tenant_id)s | - +--------------+-----------------------------------------+ - - $ openstack endpoint create --region RegionOne \ - sharev2 admin http://controller:8786/v2/%\(tenant_id\)s - +--------------+-----------------------------------------+ - | Field | Value | - +--------------+-----------------------------------------+ - | enabled | True | - | id | e814a0cec40546e98cf0c25a82498483 | - | interface | admin | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 30d92a97a81a4e5d8fd97a32bafd7b88 | - | service_name | manilav2 | - | service_type | sharev2 | - | url | http://controller:8786/v2/%(tenant_id)s | - +--------------+-----------------------------------------+ - - .. note:: - - The Share File System services require endpoints for each service - entity. - -Install and configure components --------------------------------- - -#. Install the packages: - - .. code-block:: console - - # apt-get install manila-api manila-scheduler \ - python-manilaclient - - Respond to prompts for - :doc:`database management `, - :doc:`Identity service credentials `, - :doc:`service endpoint registration `, - and :doc:`message broker credentials `. - -Finalize installation ---------------------- - -* Restart the Share File Systems services: - - .. code-block:: console - - # service manila-scheduler restart - # service manila-api restart diff --git a/doc/install-guide-debconf/source/manila-next-steps.rst b/doc/install-guide-debconf/source/manila-next-steps.rst deleted file mode 120000 index 1bf8388c27..0000000000 --- a/doc/install-guide-debconf/source/manila-next-steps.rst +++ /dev/null @@ -1 +0,0 @@ -../../install-guide/source/manila-next-steps.rst \ No newline at end of file diff --git a/doc/install-guide-debconf/source/manila-share-install-dhss-false-option1.rst b/doc/install-guide-debconf/source/manila-share-install-dhss-false-option1.rst deleted file mode 120000 index 119dc46596..0000000000 --- a/doc/install-guide-debconf/source/manila-share-install-dhss-false-option1.rst +++ /dev/null @@ -1 +0,0 @@ -../../install-guide/source/manila-share-install-dhss-false-option1.rst \ No newline at end of file diff --git a/doc/install-guide-debconf/source/manila-share-install-dhss-true-option2.rst b/doc/install-guide-debconf/source/manila-share-install-dhss-true-option2.rst deleted file mode 120000 index 32c97092c6..0000000000 --- a/doc/install-guide-debconf/source/manila-share-install-dhss-true-option2.rst +++ /dev/null @@ -1 +0,0 @@ -../../install-guide/source/manila-share-install-dhss-true-option2.rst \ No newline at end of file diff --git a/doc/install-guide-debconf/source/manila-share-install.rst b/doc/install-guide-debconf/source/manila-share-install.rst deleted file mode 120000 index 0bd9c3ae3c..0000000000 --- a/doc/install-guide-debconf/source/manila-share-install.rst +++ /dev/null @@ -1 +0,0 @@ -../../install-guide/source/manila-share-install.rst \ No newline at end of file diff --git a/doc/install-guide-debconf/source/manila-verify.rst b/doc/install-guide-debconf/source/manila-verify.rst deleted file mode 120000 index 89f8a42634..0000000000 --- a/doc/install-guide-debconf/source/manila-verify.rst +++ /dev/null @@ -1 +0,0 @@ -../../install-guide/source/manila-verify.rst \ No newline at end of file diff --git a/doc/install-guide-debconf/source/manila.rst b/doc/install-guide-debconf/source/manila.rst deleted file mode 120000 index 6d6e023495..0000000000 --- a/doc/install-guide-debconf/source/manila.rst +++ /dev/null @@ -1 +0,0 @@ -../../install-guide/source/manila.rst \ No newline at end of file diff --git a/doc/install-guide/source/conf.py b/doc/install-guide/source/conf.py index 7457d23078..6616243457 100644 --- a/doc/install-guide/source/conf.py +++ b/doc/install-guide/source/conf.py @@ -102,6 +102,7 @@ exclude_patterns = ['common/cli*', 'common/nova*', 'common/get-started-data-processing.rst', 'common/get-started-object-storage.rst', 'common/get-started-orchestration.rst', + 'common/get-started-shared-file-systems.rst', 'common/get-started-telemetry.rst', 'common/dashboard-customizing.rst', 'shared/note_configuration_vary_by_distribution.rst'] diff --git a/doc/install-guide/source/index.rst b/doc/install-guide/source/index.rst index e020356019..de4095fff6 100644 --- a/doc/install-guide/source/index.rst +++ b/doc/install-guide/source/index.rst @@ -100,7 +100,6 @@ Contents neutron.rst horizon.rst cinder.rst - manila.rst additional-services.rst launch-instance.rst diff --git a/doc/install-guide/source/launch-instance-manila-dhss-false-option1.rst b/doc/install-guide/source/launch-instance-manila-dhss-false-option1.rst deleted file mode 100644 index 03f0998755..0000000000 --- a/doc/install-guide/source/launch-instance-manila-dhss-false-option1.rst +++ /dev/null @@ -1,169 +0,0 @@ -.. _launch-instance-manila-option1: - -Option 1 - Create shares without share servers management support -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Create a share type -------------------- - -Disable DHSS before creating a share using the LVM driver. - -#. Source the admin credentials to gain access to admin-only CLI commands: - - .. code-block:: console - - $ . admin-openrc - -#. Create a default share type with DHSS disabled: - - .. code-block:: console - - $ manila type-create default_share_type False - +----------------------+--------------------------------------+ - | Property | Value | - +----------------------+--------------------------------------+ - | required_extra_specs | driver_handles_share_servers : False | - | Name | default_share_type | - | Visibility | public | - | is_default | - | - | ID | 3df065c8-6ca4-4b80-a5cb-e633c0439097 | - | optional_extra_specs | snapshot_support : True | - +----------------------+--------------------------------------+ - -Create a share --------------- - -#. Source the ``demo`` credentials to perform - the following steps as a non-administrative project: - - .. code-block:: console - - $ . demo-openrc - -#. Create a NFS share: - - .. code-block:: console - - $ manila create NFS 1 --name share1 - +-----------------------------+--------------------------------------+ - | Property | Value | - +-----------------------------+--------------------------------------+ - | status | creating | - | share_type_name | default_share_type | - | description | None | - | availability_zone | None | - | share_network_id | None | - | host | | - | access_rules_status | active | - | snapshot_id | None | - | is_public | False | - | task_state | None | - | snapshot_support | True | - | id | 55c401b3-3112-4294-aa9f-3cc355a4e361 | - | size | 1 | - | name | share1 | - | share_type | c6dfcfc6-9920-420e-8b0a-283d578efef5 | - | has_replicas | False | - | replication_type | None | - | created_at | 2016-03-30T19:10:33.000000 | - | share_proto | NFS | - | consistency_group_id | None | - | source_cgsnapshot_member_id | None | - | project_id | 3a46a53a377642a284e1d12efabb3b5a | - | metadata | {} | - +-----------------------------+--------------------------------------+ - -#. After some time, the share status should change from ``creating`` - to ``available``: - - .. code-block:: console - - $ manila list - +--------------------------------------+--------+------+-------------+-----------+-----------+--------------------+-----------------------------+-------------------+ - | ID | Name | Size | Share Proto | Status | Is Public | Share Type Name | Host | Availability Zone | - +--------------------------------------+--------+------+-------------+-----------+-----------+--------------------+-----------------------------+-------------------+ - | 55c401b3-3112-4294-aa9f-3cc355a4e361 | share1 | 1 | NFS | available | False | default_share_type | storage@lvm#lvm-single-pool | nova | - +--------------------------------------+--------+------+-------------+-----------+-----------+--------------------+-----------------------------+-------------------+ - -#. Determine export IP address of the share: - - .. code-block:: console - - $ manila show share1 - +-----------------------------+------------------------------------------------------------------------------------+ - | Property | Value | - +-----------------------------+------------------------------------------------------------------------------------+ - | status | available | - | share_type_name | default_share_type | - | description | None | - | availability_zone | nova | - | share_network_id | None | - | export_locations | | - | | path = 10.0.0.41:/var/lib/manila/mnt/share-8e13a98f-c310-41df-ac90-fc8bce4910b8 | - | | id = 3c8d0ada-cadf-48dd-85b8-d4e8c3b1e204 | - | | preferred = False | - | host | storage@lvm#lvm-single-pool | - | access_rules_status | active | - | snapshot_id | None | - | is_public | False | - | task_state | None | - | snapshot_support | True | - | id | 55c401b3-3112-4294-aa9f-3cc355a4e361 | - | size | 1 | - | name | share1 | - | share_type | c6dfcfc6-9920-420e-8b0a-283d578efef5 | - | has_replicas | False | - | replication_type | None | - | created_at | 2016-03-30T19:10:33.000000 | - | share_proto | NFS | - | consistency_group_id | None | - | source_cgsnapshot_member_id | None | - | project_id | 3a46a53a377642a284e1d12efabb3b5a | - | metadata | {} | - +-----------------------------+------------------------------------------------------------------------------------+ - -#. Configure user access to the new share before attempting to mount it via - the network: - - .. code-block:: console - - $ manila access-allow share1 ip INSTANCE_IP_ADDRESS - +--------------+--------------------------------------+ - | Property | Value | - +--------------+--------------------------------------+ - | share_id | 55c401b3-3112-4294-aa9f-3cc355a4e361 | - | access_type | ip | - | access_to | 10.0.0.41 | - | access_level | rw | - | state | new | - | id | f88eab01-7197-44bf-ad0f-d6ca6f99fc96 | - +--------------+--------------------------------------+ - - Replace ``INSTANCE_IP_ADDRESS`` with the IP address of the instance. - - .. note:: - - The instance must have connectivity to the management IP address on - the storage node. - -Mount the share from an instance --------------------------------- - -#. Create a folder where the mount will be placed: - - .. code-block:: console - - $ mkdir ~/test_folder - -#. Mount the NFS share in the instance using the export location of the share: - - .. code-block:: console - - # mount -t nfs 10.0.0.41:/var/lib/manila/mnt/share-b94a4dbf-49e2-452c-b9c7-510277adf5c6 ~/test_folder - -For more information about how to manage shares, see the -`Manage shares -`__ in -OpenStack End User Guide. - -Return to :ref:`launch-instance`. diff --git a/doc/install-guide/source/launch-instance-manila-dhss-true-option2.rst b/doc/install-guide/source/launch-instance-manila-dhss-true-option2.rst deleted file mode 100644 index 86c91a426d..0000000000 --- a/doc/install-guide/source/launch-instance-manila-dhss-true-option2.rst +++ /dev/null @@ -1,223 +0,0 @@ -.. _launch-instance-manila-option2: - -Option 2 - Create shares with share servers management support -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Before being able to create a share, the generic driver with the DHSS mode -enabled requires the definition of at least an image, a flavor, a network, and -a share-network for being used to create a share server where the NFS/CIFS -shares are served. - -Create a share type -------------------- - -Enable DHSS before creating a share using the generic driver. - -#. Source the admin credentials to gain access to admin-only CLI commands: - - .. code-block:: console - - $ . admin-openrc - -#. Create a default share type with DHSS enabled: - - .. code-block:: console - - $ manila type-create generic_share_type True - +----------------------+--------------------------------------+ - | Property | Value | - +----------------------+--------------------------------------+ - | required_extra_specs | driver_handles_share_servers : True | - | Name | generic_share_type | - | Visibility | public | - | is_default | - | - | ID | 3df065c8-6ca4-4b80-a5cb-e633c0439097 | - | optional_extra_specs | snapshot_support : True | - +----------------------+--------------------------------------+ - -Create a share network ----------------------- - -#. Source the ``demo`` credentials to perform - the following steps as a non-administrative project: - - .. code-block:: console - - $ . demo-openrc - -#. List available networks to obtain the network and subnet ID for the - ``selfservice`` network: - - .. code-block:: console - - $ neutron net-list - +--------------------------------------+-------------+-----------------------------------------------------+ - | id | name | subnets | - +--------------------------------------+-------------+-----------------------------------------------------+ - | b72d8561-aceb-4e79-938f-df3a45fdeaa3 | provider | 072dd25f-e049-454c-9b11-359c910e6668 203.0.113.0/24 | - | 4e963f5b-b5f3-4db1-a935-0d34c8629e7b | selfservice | 005bf8d1-798e-450f-9efe-72bc0c3be491 172.16.1.0/24 | - +--------------------------------------+-------------+-----------------------------------------------------+ - -#. Create the share network using the ``selfservice`` network and subnet IDs: - - .. code-block:: console - - $ manila share-network-create --name selfservice-net-share1 \ - --neutron-net-id 4e963f5b-b5f3-4db1-a935-0d34c8629e7b \ - --neutron-subnet-id 005bf8d1-798e-450f-9efe-72bc0c3be491 - +-------------------+--------------------------------------+ - | Property | Value | - +-------------------+--------------------------------------+ - | name | selfservice-net-share1 | - | segmentation_id | None | - | created_at | 2016-03-31T13:25:39.052439 | - | neutron_subnet_id | 005bf8d1-798e-450f-9efe-72bc0c3be491 | - | updated_at | None | - | network_type | None | - | neutron_net_id | 4e963f5b-b5f3-4db1-a935-0d34c8629e7b | - | ip_version | None | - | nova_net_id | None | - | cidr | None | - | project_id | 3a46a53a377642a284e1d12efabb3b5a | - | id | 997a1a0a-4f4d-4aa3-b7ae-8ae6d9aaa828 | - | description | None | - +-------------------+--------------------------------------+ - -Create a share --------------- - -#. Source the ``demo`` credentials to perform - the following steps as a non-administrative project: - - .. code-block:: console - - $ . demo-openrc - -#. Create a NFS share using the share network: - - .. code-block:: console - - $ manila create NFS 1 --name share2 \ - --share-network selfservice-net-share1 \ - --share-type generic_share_type - +-----------------------------+--------------------------------------+ - | Property | Value | - +-----------------------------+--------------------------------------+ - | status | creating | - | share_type_name | generic_share_type | - | description | None | - | availability_zone | None | - | share_network_id | 997a1a0a-4f4d-4aa3-b7ae-8ae6d9aaa828 | - | host | | - | access_rules_status | active | - | snapshot_id | None | - | is_public | False | - | task_state | None | - | snapshot_support | True | - | id | 6a711b95-9e03-4547-8769-74e34676cb3e | - | size | 1 | - | name | share2 | - | share_type | 8698ed92-2a1c-4c9f-aab4-a35dccd88c8f | - | has_replicas | False | - | replication_type | None | - | created_at | 2016-03-31T13:45:18.000000 | - | share_proto | NFS | - | consistency_group_id | None | - | source_cgsnapshot_member_id | None | - | project_id | 3a46a53a377642a284e1d12efabb3b5a | - | metadata | {} | - +-----------------------------+--------------------------------------+ - -#. After some time, the share status should change from ``creating`` - to ``available``: - - .. code-block:: console - - $ manila list - +--------------------------------------+--------+------+-------------+-----------+-----------+--------------------+-----------------------------+-------------------+ - | ID | Name | Size | Share Proto | Status | Is Public | Share Type Name | Host | Availability Zone | - +--------------------------------------+--------+------+-------------+-----------+-----------+--------------------+-----------------------------+-------------------+ - | 5f8a0574-a95e-40ff-b898-09fd8d6a1fac | share2 | 1 | NFS | available | False | default_share_type | storage@generic#GENERIC | nova | - +--------------------------------------+--------+------+-------------+-----------+-----------+--------------------+-----------------------------+-------------------+ - -#. Determine export IP address of the share: - - .. code-block:: console - - $ manila show share2 - +-----------------------------+------------------------------------------------------------------------------------+ - | Property | Value | - +-----------------------------+------------------------------------------------------------------------------------+ - | status | available | - | share_type_name | generic_share_type | - | description | None | - | availability_zone | nova | - | share_network_id | None | - | export_locations | | - | | path = 10.254.0.6:/shares/share-0bfd69a1-27f0-4ef5-af17-7cd50bce6550 | - | | id = 3c8d0ada-cadf-48dd-85b8-d4e8c3b1e204 | - | | preferred = False | - | host | storage@generic#GENERIC | - | access_rules_status | active | - | snapshot_id | None | - | is_public | False | - | task_state | None | - | snapshot_support | True | - | id | 5f8a0574-a95e-40ff-b898-09fd8d6a1fac | - | size | 1 | - | name | share2 | - | share_type | 8a35da28-0f74-490d-afff-23664ecd4f01 | - | has_replicas | False | - | replication_type | None | - | created_at | 2016-03-30T19:10:33.000000 | - | share_proto | NFS | - | consistency_group_id | None | - | source_cgsnapshot_member_id | None | - | project_id | 3a46a53a377642a284e1d12efabb3b5a | - | metadata | {} | - +-----------------------------+------------------------------------------------------------------------------------+ - -#. Configure user access to the new share before attempting to mount it via - the network: - - .. code-block:: console - - $ manila access-allow share2 ip INSTANCE_IP_ADDRESS - +--------------+--------------------------------------+ - | Property | Value | - +--------------+--------------------------------------+ - | share_id | 55c401b3-3112-4294-aa9f-3cc355a4e361 | - | access_type | ip | - | access_to | 172.16.1.5 | - | access_level | rw | - | state | new | - | id | f88eab01-7197-44bf-ad0f-d6ca6f99fc96 | - +--------------+--------------------------------------+ - - Replace ``INSTANCE_IP_ADDRESS`` with the IP address of the instance. - - .. note:: - - The instance must use the ``selfservice`` network. - -Mount the share from an instance --------------------------------- - -#. Create a folder where the mount will be placed: - - .. code-block:: console - - $ mkdir ~/test_folder - -#. Mount the NFS share in the instance using the export location of the share: - - .. code-block:: console - - # mount -t nfs 10.254.0.6:/shares/share-0bfd69a1-27f0-4ef5-af17-7cd50bce6550 ~/test_folder - -For more information about how to manage shares, see the -`Manage shares -`__ in -OpenStack End User Guide. - -Return to :ref:`launch-instance`. diff --git a/doc/install-guide/source/launch-instance-manila.rst b/doc/install-guide/source/launch-instance-manila.rst deleted file mode 100644 index 4b2d6f8c08..0000000000 --- a/doc/install-guide/source/launch-instance-manila.rst +++ /dev/null @@ -1,106 +0,0 @@ -.. _launch-instance-manila: - -Shared File Systems -~~~~~~~~~~~~~~~~~~~ - -Create the service image ------------------------- - -.. note:: - - In typical deployments, you should create an instance from an image that - supports network file systems such as NFS/CIFS to evaluate the Shared File - Systems service. This guide should use the CirrOS image for instances to - reduce resource requirements for evaluation. However, the CirrOS image - lacks support for network file systems. For evaluation of the Shared File - Systems service, this guide creates a regular instance using the - ``manila-share-service`` image because it supports network file systems and - using the ``manila-service-flavor`` that limits resource consumption by the - instance to 256 MB memory on the compute node. - -#. Download the source image of the share server: - - .. code-block:: console - - $ wget http://tarballs.openstack.org/manila-image-elements/images/manila-service-image-master.qcow2 - -#. Add the image to the Image service: - - .. code-block:: console - - # openstack image create "manila-service-image" \ - --file manila-service-image-master.qcow2 \ - --disk-format qcow2 \ - --container-format bare \ - --public - +------------------+------------------------------------------------------+ - | Field | Value | - +------------------+------------------------------------------------------+ - | checksum | abb1fdf972162c7214db9fad43229dad | - | container_format | bare | - | created_at | 2016-03-16T23:37:51Z | - | disk_format | qcow2 | - | file | /v2/images/dcec8c7f-4c59-4223-a06f-220231b49c0c/file | - | id | dcec8c7f-4c59-4223-a06f-220231b49c0c | - | min_disk | 0 | - | min_ram | 0 | - | name | manila-service-image | - | owner | fd4a657caa054ca99d8b4179722f49de | - | protected | False | - | schema | /v2/schemas/image | - | size | 324665344 | - | status | active | - | tags | | - | updated_at | 2016-03-16T23:37:55Z | - | virtual_size | None | - | visibility | public | - +------------------+------------------------------------------------------+ - -#. Create a new flavor to support the service image: - - .. code-block:: console - - # openstack flavor create manila-service-flavor --id 100 --ram 256 --disk 0 --vcpus 1 - +----------------------------+-----------------------+ - | Field | Value | - +----------------------------+-----------------------+ - | OS-FLV-DISABLED:disabled | False | - | OS-FLV-EXT-DATA:ephemeral | 0 | - | disk | 0 | - | id | 100 | - | name | manila-service-flavor | - | os-flavor-access:is_public | True | - | ram | 256 | - | rxtx_factor | 1.0 | - | swap | | - | vcpus | 1 | - +----------------------------+-----------------------+ - - .. note:: - - Flavor is image specific and may differ from image to image. - -Launch an instance of the service image ---------------------------------------- - -.. note:: - - This section uses ``manila-service-image`` image as an instance for - mounting shares. - -#. Launch an instance using the ``manila-service-image`` and - ``manila-service-flavor``. - -#. Log into the instance using ``manila`` as the username and password. - -Create a share --------------- - -Create a share for the Shared File Systems service option that you chose -in :ref:`manila-storage`. - -.. toctree:: - :maxdepth: 1 - - launch-instance-manila-dhss-false-option1.rst - launch-instance-manila-dhss-true-option2.rst diff --git a/doc/install-guide/source/launch-instance.rst b/doc/install-guide/source/launch-instance.rst index 2a479cb767..2fdc67e707 100644 --- a/doc/install-guide/source/launch-instance.rst +++ b/doc/install-guide/source/launch-instance.rst @@ -187,9 +187,8 @@ Shared File Systems ------------------- If your environment includes the Shared File Systems service, you can create -a share and mount it in an instance: +a share and mount it in an instance. -.. toctree:: - :maxdepth: 1 - - launch-instance-manila.rst +For more information, see the +`Shared File Systems installation guide +`_. diff --git a/doc/install-guide/source/manila-controller-install.rst b/doc/install-guide/source/manila-controller-install.rst deleted file mode 100644 index a0050bd00a..0000000000 --- a/doc/install-guide/source/manila-controller-install.rst +++ /dev/null @@ -1,385 +0,0 @@ -.. _manila-controller: - -Install and configure controller node -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This section describes how to install and configure the Shared File Systems -service, code-named manila, on the controller node. This service requires at -least one additional share node that manages file storage drivers. - -Prerequisites -------------- - -Before you install and configure the Share File System service, you -must create a database, service credentials, and API endpoints. - -#. To create the database, complete these steps: - - * Use the database access client to connect to the database server as the - ``root`` user: - - .. code-block:: console - - $ mysql -u root -p - - * Create the ``manila`` database: - - .. code-block:: console - - CREATE DATABASE manila; - - * Grant proper access to the ``manila`` database: - - .. code-block:: console - - GRANT ALL PRIVILEGES ON manila.* TO 'manila'@'localhost' \ - IDENTIFIED BY 'MANILA_DBPASS'; - GRANT ALL PRIVILEGES ON manila.* TO 'manila'@'%' \ - IDENTIFIED BY 'MANILA_DBPASS'; - - Replace ``MANILA_DBPASS`` with a suitable password. - - * Exit the database access client. - -#. Source the ``admin`` credentials to gain access to admin-only CLI commands: - - .. code-block:: console - - $ . admin-openrc - -#. To create the service credentials, complete these steps: - - * Create a ``manila`` user: - - .. code-block:: console - - $ openstack user create --domain default --password-prompt manila - User Password: - Repeat User Password: - +-----------+----------------------------------+ - | Field | Value | - +-----------+----------------------------------+ - | domain_id | e0353a670a9e496da891347c589539e9 | - | enabled | True | - | id | 83a3990fc2144100ba0e2e23886d8acc | - | name | manila | - +-----------+----------------------------------+ - - * Add the ``admin`` role to the ``manila`` user: - - .. code-block:: console - - $ openstack role add --project service --user manila admin - - .. note:: - - This command provides no output. - - * Create the ``manila`` and ``manilav2`` service entities: - - .. code-block:: console - - $ openstack service create --name manila \ - --description "OpenStack Shared File Systems" share - +-------------+----------------------------------+ - | Field | Value | - +-------------+----------------------------------+ - | description | OpenStack Shared File Systems | - | enabled | True | - | id | 82378b5a16b340aa9cc790cdd46a03ba | - | name | manila | - | type | share | - +-------------+----------------------------------+ - - .. code-block:: console - - $ openstack service create --name manilav2 \ - --description "OpenStack Shared File Systems" sharev2 - +-------------+----------------------------------+ - | Field | Value | - +-------------+----------------------------------+ - | description | OpenStack Shared File Systems | - | enabled | True | - | id | 30d92a97a81a4e5d8fd97a32bafd7b88 | - | name | manilav2 | - | type | sharev2 | - +-------------+----------------------------------+ - - .. note:: - - The Share File System services require two service entities. - -#. Create the Shared File Systems service API endpoints: - - .. code-block:: console - - $ openstack endpoint create --region RegionOne \ - share public http://controller:8786/v1/%\(tenant_id\)s - +--------------+-----------------------------------------+ - | Field | Value | - +--------------+-----------------------------------------+ - | enabled | True | - | id | 0bd2bbf8d28b433aaea56a254c69f69d | - | interface | public | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 82378b5a16b340aa9cc790cdd46a03ba | - | service_name | manila | - | service_type | share | - | url | http://controller:8786/v1/%(tenant_id)s | - +--------------+-----------------------------------------+ - - $ openstack endpoint create --region RegionOne \ - share internal http://controller:8786/v1/%\(tenant_id\)s - +--------------+-----------------------------------------+ - | Field | Value | - +--------------+-----------------------------------------+ - | enabled | True | - | id | a2859b5732cc48b5b083dd36dafb6fd9 | - | interface | internal | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 82378b5a16b340aa9cc790cdd46a03ba | - | service_name | manila | - | service_type | share | - | url | http://controller:8786/v1/%(tenant_id)s | - +--------------+-----------------------------------------+ - - $ openstack endpoint create --region RegionOne \ - share admin http://controller:8786/v1/%\(tenant_id\)s - +--------------+-----------------------------------------+ - | Field | Value | - +--------------+-----------------------------------------+ - | enabled | True | - | id | f7f46df93a374cc49c0121bef41da03c | - | interface | admin | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 82378b5a16b340aa9cc790cdd46a03ba | - | service_name | manila | - | service_type | share | - | url | http://controller:8786/v1/%(tenant_id)s | - +--------------+-----------------------------------------+ - - .. code-block:: console - - $ openstack endpoint create --region RegionOne \ - sharev2 public http://controller:8786/v2/%\(tenant_id\)s - +--------------+-----------------------------------------+ - | Field | Value | - +--------------+-----------------------------------------+ - | enabled | True | - | id | d63cc0d358da4ea680178657291eddc1 | - | interface | public | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 30d92a97a81a4e5d8fd97a32bafd7b88 | - | service_name | manilav2 | - | service_type | sharev2 | - | url | http://controller:8786/v2/%(tenant_id)s | - +--------------+-----------------------------------------+ - - $ openstack endpoint create --region RegionOne \ - sharev2 internal http://controller:8786/v2/%\(tenant_id\)s - +--------------+-----------------------------------------+ - | Field | Value | - +--------------+-----------------------------------------+ - | enabled | True | - | id | afc86e5f50804008add349dba605da54 | - | interface | internal | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 30d92a97a81a4e5d8fd97a32bafd7b88 | - | service_name | manilav2 | - | service_type | sharev2 | - | url | http://controller:8786/v2/%(tenant_id)s | - +--------------+-----------------------------------------+ - - $ openstack endpoint create --region RegionOne \ - sharev2 admin http://controller:8786/v2/%\(tenant_id\)s - +--------------+-----------------------------------------+ - | Field | Value | - +--------------+-----------------------------------------+ - | enabled | True | - | id | e814a0cec40546e98cf0c25a82498483 | - | interface | admin | - | region | RegionOne | - | region_id | RegionOne | - | service_id | 30d92a97a81a4e5d8fd97a32bafd7b88 | - | service_name | manilav2 | - | service_type | sharev2 | - | url | http://controller:8786/v2/%(tenant_id)s | - +--------------+-----------------------------------------+ - - .. note:: - - The Share File System services require endpoints for each service - entity. - -Install and configure components --------------------------------- - -.. only:: obs - - #. Install the packages: - - .. code-block:: console - - # zypper install openstack-manila-api \ - openstack-manila-scheduler python-manilaclient - -.. only:: rdo - - #. Install the packages: - - .. code-block:: console - - # yum install openstack-manila python-manilaclient - -.. only:: ubuntu or debian - - #. Install the packages: - - .. code-block:: console - - # apt-get install manila-api manila-scheduler \ - python-manilaclient - - .. only:: debian - - Respond to prompts for debconf. - - .. :doc:`database management `, - :doc:`Identity service credentials `, - :doc:`service endpoint registration `, - and :doc:`message broker credentials `. - -2. Edit the ``/etc/manila/manila.conf`` file and complete the - following actions: - - .. only:: obs or rdo or ubuntu - - * In the ``[database]`` section, configure database access: - - .. only:: ubuntu or obs - - .. code-block:: ini - - [database] - ... - connection = mysql+pymysql://manila:MANILA_DBPASS@controller/manila - - .. only:: rdo - - .. code-block:: ini - - [database] - ... - connection = mysql+pymysql://manila:MANILA_DBPASS@controller/manila - - Replace ``MANILA_DBPASS`` with the password you chose for the - Share File System database. - - * In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections, - configure ``RabbitMQ`` message queue access: - - .. code-block:: ini - - [DEFAULT] - ... - rpc_backend = rabbit - - [oslo_messaging_rabbit] - ... - rabbit_host = controller - rabbit_userid = openstack - rabbit_password = RABBIT_PASS - - Replace ``RABBIT_PASS`` with the password you chose for the - ``openstack`` account in ``RabbitMQ``. - - * In the ``[DEFAULT]`` section, set the following config values: - - .. code-block:: ini - - [DEFAULT] - ... - default_share_type = default_share_type - rootwrap_config = /etc/manila/rootwrap.conf - - * In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections, - configure Identity service access: - - .. code-block:: ini - - [DEFAULT] - ... - auth_strategy = keystone - - [keystone_authtoken] - ... - memcached_servers = controller:11211 - auth_uri = http://controller:5000 - auth_url = http://controller:35357 - auth_type = password - project_domain_name = default - user_domain_name = default - project_name = service - username = manila - password = MANILA_PASS - - Replace ``MANILA_PASS`` with the password you chose for - the ``manila`` user in the Identity service. - - * In the ``[DEFAULT]`` section, configure the ``my_ip`` option to - use the management interface IP address of the controller node: - - .. code-block:: ini - - [DEFAULT] - ... - my_ip = 10.0.0.11 - - .. only:: obs or rdo or ubuntu - - * In the ``[oslo_concurrency]`` section, configure the lock path: - - .. code-block:: ini - - [oslo_concurrency] - ... - lock_path = /var/lib/manila/tmp - -.. only:: rdo or ubuntu - - 3. Populate the Share File System database: - - .. code-block:: console - - # su -s /bin/sh -c "manila-manage db sync" manila - - .. note:: - - Ignore any deprecation messages in this output. - -Finalize installation ---------------------- - -.. only:: obs or rdo - - * Start the Share File System services and configure them to start when - the system boots: - - .. code-block:: console - - # systemctl enable openstack-manila-api.service openstack-manila-scheduler.service - # systemctl start openstack-manila-api.service openstack-manila-scheduler.service - -.. only:: ubuntu or debian - - * Restart the Share File Systems services: - - .. code-block:: console - - # service manila-scheduler restart - # service manila-api restart diff --git a/doc/install-guide/source/manila-next-steps.rst b/doc/install-guide/source/manila-next-steps.rst deleted file mode 100644 index 1ebedb3d36..0000000000 --- a/doc/install-guide/source/manila-next-steps.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. _manila-next-steps: - -========== -Next steps -========== - -Your OpenStack environment now includes the Shared File Systems service. You -can :doc:`launch an instance ` or add more services to your -environment in the following chapters. diff --git a/doc/install-guide/source/manila-share-install-dhss-false-option1.rst b/doc/install-guide/source/manila-share-install-dhss-false-option1.rst deleted file mode 100644 index c9f106581c..0000000000 --- a/doc/install-guide/source/manila-share-install-dhss-false-option1.rst +++ /dev/null @@ -1,154 +0,0 @@ -Shared File Systems Option 1: No driver support for share servers management -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -For simplicity, this configuration references the same storage node -configuration for the Block Storage service. However, the LVM driver -requires a separate empty local block storage device to avoid conflict -with the Block Storage service. The instructions use ``/dev/sdc``, but -you can substitute a different value for your particular node. - -Prerequisites -------------- - -.. note:: - - Perform these steps on the storage node. - -#. Install the supporting utility packages: - - .. only:: obs - - * Install LVM and NFS server packages: - - .. code-block:: console - - # zypper install lvm2 nfs-kernel-server - - * (Optional) If you intend to use non-raw image types such as QCOW2 - and VMDK, install the QEMU package: - - .. code-block:: console - - # zypper install qemu - - .. only:: rdo - - * Install LVM and NFS server packages: - - .. code-block:: console - - # yum install lvm2 nfs-utils nfs4-acl-tools portmap - - * Start the LVM metadata service and configure it to start when the - system boots: - - .. code-block:: console - - # systemctl enable lvm2-lvmetad.service - # systemctl start lvm2-lvmetad.service - - .. only:: ubuntu - - * Install LVM and NFS server packages: - - .. code-block:: console - - # apt-get install lvm2 nfs-kernel-server - -#. Create the LVM physical volume ``/dev/sdc``: - - .. code-block:: console - - # pvcreate /dev/sdc - Physical volume "/dev/sdc" successfully created - -#. Create the LVM volume group ``manila-volumes``: - - .. code-block:: console - - # vgcreate manila-volumes /dev/sdc - Volume group "manila-volumes" successfully created - - The Shared File Systems service creates logical volumes in this volume - group. - -#. Only instances can access Shared File Systems service volumes. However, - the underlying operating system manages the devices associated with - the volumes. By default, the LVM volume scanning tool scans the - ``/dev`` directory for block storage devices that - contain volumes. If projects use LVM on their volumes, the scanning - tool detects these volumes and attempts to cache them which can cause - a variety of problems with both the underlying operating system - and project volumes. You must reconfigure LVM to scan only the devices - that contain the ``cinder-volume`` and ``manila-volumes`` volume groups. - Edit the ``/etc/lvm/lvm.conf`` file and complete the following actions: - - * In the ``devices`` section, add a filter that accepts the - ``/dev/sdb`` and ``/dev/sdc`` devices and rejects all other devices: - - .. code-block:: ini - - devices { - ... - filter = [ "a/sdb/", "a/sdc", "r/.*/"] - - .. warning:: - - If your storage nodes use LVM on the operating system disk, you - must also add the associated device to the filter. For example, - if the ``/dev/sda`` device contains the operating system: - - .. code-block:: ini - - filter = [ "a/sda/", "a/sdb/", "a/sdc", "r/.*/"] - - Similarly, if your compute nodes use LVM on the operating - system disk, you must also modify the filter in the - ``/etc/lvm/lvm.conf`` file on those nodes to include only - the operating system disk. For example, if the ``/dev/sda`` - device contains the operating system: - - .. code-block:: ini - - filter = [ "a/sda/", "r/.*/"] - -Configure components --------------------- - -.. include:: shared/note_configuration_vary_by_distribution.rst - -#. Edit the ``/etc/manila/manila.conf`` file and complete the following - actions: - - * In the ``[DEFAULT]`` section, enable the LVM driver and the NFS/CIFS - protocols: - - .. code-block:: ini - - [DEFAULT] - ... - enabled_share_backends = lvm - enabled_share_protocols = NFS,CIFS - - .. note:: - - Back end names are arbitrary. As an example, this guide uses the name - of the driver. - - * In the ``[lvm]`` section, configure the LVM driver: - - .. code-block:: ini - - [lvm] - share_backend_name = LVM - share_driver = manila.share.drivers.lvm.LVMShareDriver - driver_handles_share_servers = False - lvm_share_volume_group = manila-volumes - lvm_share_export_ip = MANAGEMENT_INTERFACE_IP_ADDRESS - - Replace ``MANAGEMENT_INTERFACE_IP_ADDRESS`` with the IP address - of the management network interface on your storage node, - typically 10.0.0.41 for the first node in the - :ref:`example architecture `. - -Return to :ref:`Finalize installation `. diff --git a/doc/install-guide/source/manila-share-install-dhss-true-option2.rst b/doc/install-guide/source/manila-share-install-dhss-true-option2.rst deleted file mode 100644 index 9614423fac..0000000000 --- a/doc/install-guide/source/manila-share-install-dhss-true-option2.rst +++ /dev/null @@ -1,132 +0,0 @@ -Shared File Systems Option 2: Driver support for share servers management -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -For simplicity, this configuration references the same storage node -configuration for the Block Storage service. - -.. note:: - - This guide describes how to configure the Shared File Systems service to - use the ``generic`` driver with the driver handles share server mode - (DHSS) enabled. This mode requires Compute (nova), Networking (neutron) and - Block storage (cinder) services for managing share servers. The information - used for creating share servers is configured as share networks. Generic - driver with DHSS enabled also requires network to be attached to a public - router. - -Prerequisites -------------- - -Before you proceed, verify operation of the Compute, Networking, and Block -Storage services. This options requires implementation of Networking option 2 -and requires installation of some Networking service components on the storage -node. - -* Install the Networking service components: - - .. only:: obs - - .. code-block:: console - - # zypper install --no-recommends openstack-neutron-linuxbridge-agent - - .. only:: rdo - - .. code-block:: console - - # yum install openstack-neutron openstack-neutron-linuxbridge ebtables - - .. only:: ubuntu - - .. code-block:: console - - # apt-get install neutron-plugin-linuxbridge-agent - -Configure components --------------------- - -.. include:: shared/note_configuration_vary_by_distribution.rst - -#. Edit the ``/etc/manila/manila.conf`` file and complete the following - actions: - - * In the ``[DEFAULT]`` section, enable the generic driver and the NFS/CIFS - protocols: - - .. code-block:: ini - - [DEFAULT] - ... - enabled_share_backends = generic - enabled_share_protocols = NFS,CIFS - - .. note:: - - Back end names are arbitrary. As an example, this guide uses the name - of the driver. - - * In the ``[neutron]``, ``[nova]``, and ``[cinder]`` sections, enable - authentication for those services: - - .. code-block:: ini - - [neutron] - ... - url = http://controller:9696 - auth_uri = http://controller:5000 - auth_url = http://controller:35357 - memcached_servers = controller:11211 - auth_type = password - project_domain_name = default - user_domain_name = default - region_name = RegionOne - project_name = service - username = neutron - password = NEUTRON_PASS - - [nova] - ... - auth_uri = http://controller:5000 - auth_url = http://controller:35357 - memcached_servers = controller:11211 - auth_type = password - project_domain_name = default - user_domain_name = default - region_name = RegionOne - project_name = service - username = nova - password = NOVA_PASS - - [cinder] - ... - auth_uri = http://controller:5000 - auth_url = http://controller:35357 - memcached_servers = controller:11211 - auth_type = password - project_domain_name = default - user_domain_name = default - region_name = RegionOne - project_name = service - username = cinder - password = CINDER_PASS - - * In the ``[generic]`` section, configure the generic driver: - - .. code-block:: ini - - [generic] - share_backend_name = GENERIC - share_driver = manila.share.drivers.generic.GenericShareDriver - driver_handles_share_servers = True - service_instance_flavor_id = 100 - service_image_name = manila-service-image - service_instance_user = manila - service_instance_password = manila - interface_driver = manila.network.linux.interface.BridgeInterfaceDriver - - .. note:: - - You can also use SSH keys instead of password authentication for - service instance credentials. - -Return to :ref:`Finalize installation `. diff --git a/doc/install-guide/source/manila-share-install.rst b/doc/install-guide/source/manila-share-install.rst deleted file mode 100644 index ebaf247e4b..0000000000 --- a/doc/install-guide/source/manila-share-install.rst +++ /dev/null @@ -1,196 +0,0 @@ -.. _manila-storage: - -Install and configure a share node -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This section describes how to install and configure a share node for the -Shared File Systems service. - -Install and configure components --------------------------------- - -.. include:: shared/note_configuration_vary_by_distribution.rst - -#. Install the packages: - - .. only:: obs - - .. code-block:: console - - # zypper install openstack-manila-share python-PyMySQL - - .. only:: rdo - - .. code-block:: console - - # yum install openstack-manila-share python2-PyMySQL - - .. only:: ubuntu - - .. code-block:: console - - # apt-get install manila-share python-pymysql - -#. Edit the ``/etc/manila/manila.conf`` file and complete the following - actions: - - * In the ``[database]`` section, configure database access: - - .. only:: ubuntu or obs - - .. code-block:: ini - - [database] - ... - connection = mysql+pymysql://manila:MANILA_DBPASS@controller/manila - - .. only:: rdo - - .. code-block:: ini - - [database] - ... - connection = mysql://manila:MANILA_DBPASS@controller/manila - - Replace ``MANILA_DBPASS`` with the password you chose for - the Share File System database. - - * In the ``[DEFAULT]`` and ``[oslo_messaging_rabbit]`` sections, - configure ``RabbitMQ`` message queue access: - - .. code-block:: ini - - [DEFAULT] - ... - rpc_backend = rabbit - - [oslo_messaging_rabbit] - ... - rabbit_host = controller - rabbit_userid = openstack - rabbit_password = RABBIT_PASS - - Replace ``RABBIT_PASS`` with the password you chose for the - ``openstack`` account in ``RabbitMQ``. - - * In the ``[DEFAULT]`` section, set the following config values: - - .. code-block:: ini - - [DEFAULT] - ... - default_share_type = default_share_type - rootwrap_config = /etc/manila/rootwrap.conf - - * In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections, - configure Identity service access: - - .. code-block:: ini - - [DEFAULT] - ... - auth_strategy = keystone - - [keystone_authtoken] - ... - memcached_servers = controller:11211 - auth_uri = http://controller:5000 - auth_url = http://controller:35357 - auth_type = password - project_domain_name = default - user_domain_name = default - project_name = service - username = manila - password = MANILA_PASS - - Replace ``MANILA_PASS`` with the password you chose for the ``manila`` - user in the Identity service. - - * In the ``[DEFAULT]`` section, configure the ``my_ip`` option: - - .. code-block:: ini - - [DEFAULT] - ... - my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS - - Replace ``MANAGEMENT_INTERFACE_IP_ADDRESS`` with the IP address - of the management network interface on your share node, - typically 10.0.0.41 for the first node in the - :ref:`example architecture `. - - * In the ``[oslo_concurrency]`` section, configure the lock path: - - .. code-block:: ini - - [oslo_concurrency] - ... - lock_path = /var/lib/manila/tmp - -Configure share server management support options -------------------------------------------------- - -The share node can support two modes, with and without the handling of -share servers. The mode depends on driver support. - -Option 1 deploys the service without driver support for share management. In -this mode, the service does not do anything related to networking. The operator -must ensure network connectivity between instances and the NFS server. This -option uses LVM driver that requires LVM and NFS packages as well as an -additional disk for the ``manila-share`` LVM volume group. - -Option 2 deploys the service with driver support for share management. In this -mode, the service requires Compute (nova), Networking (neutron) and Block -storage (cinder) services for managing share servers. The information used for -creating share servers is configured as share networks. This option uses the -generic driver with the handling of share servers capacity and requires -attaching the ``selfservice`` network to a router. - -.. warning:: - - A bug prevents using both driver options on the same share node. - For more information, see LVM Driver section at the - `Configuration Reference `__. - -Choose one of the following options to configure the share driver. -Afterwards, return here and proceed to -:ref:`manila-share-finalize-install`. - -.. toctree:: - :maxdepth: 1 - - manila-share-install-dhss-false-option1.rst - manila-share-install-dhss-true-option2.rst - -.. _manila-share-finalize-install: - -Finalize installation ---------------------- - -.. only:: obs - - * Start the Share File Systems service including its dependencies - and configure them to start when the system boots: - - .. code-block:: console - - # systemctl enable openstack-manila-share.service - # systemctl start openstack-manila-share.service - -.. only:: rdo - - * Start the Share File Systems service including its dependencies - and configure them to start when the system boots: - - .. code-block:: console - - # systemctl enable openstack-manila-share.service - # systemctl start openstack-manila-share.service - -.. only:: ubuntu - - * Start the Share File Systems service including its dependencies: - - .. code-block:: console - - # service manila-share restart diff --git a/doc/install-guide/source/manila-verify.rst b/doc/install-guide/source/manila-verify.rst deleted file mode 100644 index fdd021559d..0000000000 --- a/doc/install-guide/source/manila-verify.rst +++ /dev/null @@ -1,43 +0,0 @@ -.. _manila-verify: - -Verify operation -~~~~~~~~~~~~~~~~ - -Verify operation of the Shared File Systems service. - -.. note:: - - Perform these commands on the controller node. - -#. Source the ``admin`` credentials to gain access to - admin-only CLI commands: - - .. code-block:: console - - $ . admin-openrc - -#. List service components to verify successful launch of each process: - - For deployments using option 1: - - .. code-block:: console - - $ manila service-list - +----+------------------+-------------+------+---------+-------+----------------------------+ - | Id | Binary | Host | Zone | Status | State | Updated_at | - +----+------------------+-------------+------+---------+-------+----------------------------+ - | 1 | manila-scheduler | controller | nova | enabled | up | 2016-03-30T20:17:28.000000 | - | 2 | manila-share | storage@lvm | nova | enabled | up | 2016-03-30T20:17:29.000000 | - +----+------------------+-------------+------+---------+-------+----------------------------+ - - For deployments using option 2: - - .. code-block:: console - - $ manila service-list - +----+------------------+-----------------+------+---------+-------+----------------------------+ - | Id | Binary | Host | Zone | Status | State | Updated_at | - +----+------------------+-----------------+------+---------+-------+----------------------------+ - | 1 | manila-scheduler | controller | nova | enabled | up | 2016-03-30T20:17:28.000000 | - | 2 | manila-share | storage@generic | nova | enabled | up | 2016-03-30T20:17:29.000000 | - +----+------------------+-----------------+------+---------+-------+----------------------------+ diff --git a/doc/install-guide/source/manila.rst b/doc/install-guide/source/manila.rst deleted file mode 100644 index 1516048057..0000000000 --- a/doc/install-guide/source/manila.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _manila: - -=========================== -Shared File Systems service -=========================== - -.. toctree:: - - common/get-started-shared-file-systems.rst - manila-controller-install.rst - manila-share-install.rst - manila-verify.rst - manila-next-steps.rst - -The Shared File Systems service (manila) provides coordinated access to -shared or distributed file systems. The method in which the share is -provisioned and consumed is determined by the Shared File Systems driver, or -drivers in the case of a multi-driver configuration. There are a variety of -drivers that support NFS, CIFS, HDFS and/or protocols as well. - -The Shared File Systems API and scheduler services typically run on the -controller nodes. Depending upon the drivers used, the share service can run -on controller nodes, compute nodes, or storage nodes. - -For more information, see the `Configuration Reference `__. diff --git a/www/project-install-guide/draft/index.html b/www/project-install-guide/draft/index.html index 3773c6a5b6..d3e8c1d968 100644 --- a/www/project-install-guide/draft/index.html +++ b/www/project-install-guide/draft/index.html @@ -38,7 +38,7 @@ Networking service Dashboard Block Storage service - Shared File Systems service + Shared File Systems service Object Storage service Orchestration service Database service @@ -56,7 +56,7 @@ Networking service Dashboard Block Storage service - Shared File Systems service + Shared File Systems service Object Storage service Orchestration service Database service @@ -75,7 +75,7 @@ Networking service Dashboard Block Storage service - Shared File Systems service + Shared File Systems service Object Storage service Orchestration service Telemetry service @@ -98,7 +98,7 @@ Networking service Dashboard Block Storage service - Shared File Systems service + Shared File Systems service Object Storage service Orchestration service Telemetry service @@ -120,7 +120,7 @@ Networking service Dashboard Block Storage service - Shared File Systems service + Shared File Systems service Object Storage service Orchestration service Telemetry service