Browse Source

[install-guide] remove install-guide doc

1. manila/install-guide is completely the same doc as the one in
   the directory of manila/doc/source/install, this change is to
   remove manila/install-guide because I think this is unnecessary
   and also let us maintenance a copy of install-guide doc.
2. remove install-guide in tox.ini file, cause build doc will generate
   install-guide doc.

Change-Id: Ife2d2b366f3f8b2bff8f9dda0f972858e1505a21
junboli 1 year ago
parent
commit
e631ccfa81
30 changed files with 0 additions and 2245 deletions
  1. 0
    76
      install-guide/source/common/controller-node-common-configuration.rst
  2. 0
    208
      install-guide/source/common/controller-node-prerequisites.rst
  3. 0
    98
      install-guide/source/common/dhss-false-mode-configuration.rst
  4. 0
    8
      install-guide/source/common/dhss-false-mode-intro.rst
  5. 0
    176
      install-guide/source/common/dhss-false-mode-using-shared-file-systems.rst
  6. 0
    94
      install-guide/source/common/dhss-true-mode-configuration.rst
  7. 0
    18
      install-guide/source/common/dhss-true-mode-intro.rst
  8. 0
    304
      install-guide/source/common/dhss-true-mode-using-shared-file-systems.rst
  9. 0
    81
      install-guide/source/common/share-node-common-configuration.rst
  10. 0
    42
      install-guide/source/common/share-node-share-server-modes.rst
  11. 0
    306
      install-guide/source/conf.py
  12. BIN
      install-guide/source/figures/hwreqs.graffle
  13. BIN
      install-guide/source/figures/hwreqs.png
  14. 0
    3
      install-guide/source/figures/hwreqs.svg
  15. 0
    40
      install-guide/source/get-started-with-shared-file-systems.rst
  16. 0
    63
      install-guide/source/index.rst
  17. 0
    56
      install-guide/source/install-controller-debian.rst
  18. 0
    22
      install-guide/source/install-controller-node.rst
  19. 0
    47
      install-guide/source/install-controller-obs.rst
  20. 0
    57
      install-guide/source/install-controller-rdo.rst
  21. 0
    64
      install-guide/source/install-controller-ubuntu.rst
  22. 0
    91
      install-guide/source/install-share-debian.rst
  23. 0
    27
      install-guide/source/install-share-node.rst
  24. 0
    90
      install-guide/source/install-share-obs.rst
  25. 0
    103
      install-guide/source/install-share-rdo.rst
  26. 0
    99
      install-guide/source/install-share-ubuntu.rst
  27. 0
    14
      install-guide/source/next-steps.rst
  28. 0
    22
      install-guide/source/post-install.rst
  29. 0
    29
      install-guide/source/verify.rst
  30. 0
    7
      tox.ini

+ 0
- 76
install-guide/source/common/controller-node-common-configuration.rst View File

@@ -1,76 +0,0 @@
1
-3. Complete the rest of the configuration in ``manila.conf``:
2
-
3
-   * In the ``[DEFAULT]`` section, configure ``RabbitMQ``
4
-     message queue access:
5
-
6
-     .. code-block:: ini
7
-
8
-        [DEFAULT]
9
-        ...
10
-        transport_url = rabbit://openstack:RABBIT_PASS@controller
11
-
12
-     Replace ``RABBIT_PASS`` with the  password you chose for the ``openstack``
13
-     account in ``RabbitMQ``.
14
-
15
-   * In the ``[DEFAULT]`` section, set the following config values:
16
-
17
-     .. code-block:: ini
18
-
19
-        [DEFAULT]
20
-        ...
21
-        default_share_type = default_share_type
22
-        share_name_template = share-%s
23
-        rootwrap_config = /etc/manila/rootwrap.conf
24
-        api_paste_config = /etc/manila/api-paste.ini
25
-
26
-     .. important::
27
-
28
-        The ``default_share_type`` option specifies the default share type to
29
-        be used when shares are created without specifying the share type in
30
-        the request. The default share type that is specified in the
31
-        configuration file has to be created with the necessary required
32
-        extra-specs (such as ``driver_handles_share_servers``) set
33
-        appropriately with reference to the driver mode used. This is further
34
-        explained in the section discussing the setup and configuration of the
35
-        share node.
36
-
37
-   * In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections, configure
38
-     Identity service access:
39
-
40
-     .. code-block:: ini
41
-
42
-        [DEFAULT]
43
-        ...
44
-        auth_strategy = keystone
45
-
46
-        [keystone_authtoken]
47
-        ...
48
-        memcached_servers = controller:11211
49
-        auth_uri = http://controller:5000
50
-        auth_url = http://controller:35357
51
-        auth_type = password
52
-        project_domain_id = default
53
-        user_domain_id = default
54
-        project_name = service
55
-        username = manila
56
-        password = MANILA_PASS
57
-
58
-     Replace ``MANILA_PASS`` with the password you chose for the ``manila``
59
-     user in the Identity service.
60
-
61
-   * In the ``[DEFAULT]`` section, configure the ``my_ip`` option to use the
62
-     management interface IP address of the controller node:
63
-
64
-     .. code-block:: ini
65
-
66
-        [DEFAULT]
67
-        ...
68
-        my_ip = 10.0.0.11
69
-
70
-   * In the ``[oslo_concurrency]`` section, configure the lock path:
71
-
72
-     .. code-block:: ini
73
-
74
-        [oslo_concurrency]
75
-        ...
76
-        lock_path = /var/lock/manila

+ 0
- 208
install-guide/source/common/controller-node-prerequisites.rst View File

@@ -1,208 +0,0 @@
1
-Prerequisites
2
--------------
3
-
4
-Before you install and configure the Shared File Systems service, you
5
-must create a database, service credentials, and `API endpoints`.
6
-
7
-#. To create the database, complete these steps:
8
-
9
-   * Use the database access client to connect to the database server as the
10
-     ``root`` user:
11
-
12
-     .. code-block:: console
13
-
14
-        $ mysql -u root -p
15
-
16
-   * Create the `manila` database:
17
-
18
-     .. code-block:: console
19
-
20
-        CREATE DATABASE manila;
21
-
22
-   * Grant proper access to the ``manila`` database:
23
-
24
-     .. code-block:: console
25
-
26
-        GRANT ALL PRIVILEGES ON manila.* TO 'manila'@'localhost' \
27
-          IDENTIFIED BY 'MANILA_DBPASS';
28
-        GRANT ALL PRIVILEGES ON manila.* TO 'manila'@'%' \
29
-          IDENTIFIED BY 'MANILA_DBPASS';
30
-
31
-     Replace ``MANILA_DBPASS`` with a suitable password.
32
-
33
-   * Exit the database access client.
34
-
35
-#. Source the ``admin`` credentials to gain access to admin CLI commands:
36
-
37
-   .. code-block:: console
38
-
39
-      $ . admin-openrc.sh
40
-
41
-#. To create the service credentials, complete these steps:
42
-
43
-   * Create a ``manila`` user:
44
-
45
-     .. code-block:: console
46
-
47
-        $ openstack user create --domain default --password-prompt manila
48
-        User Password:
49
-        Repeat User Password:
50
-        +-----------+----------------------------------+
51
-        | Field     | Value                            |
52
-        +-----------+----------------------------------+
53
-        | domain_id | e0353a670a9e496da891347c589539e9 |
54
-        | enabled   | True                             |
55
-        | id        | 83a3990fc2144100ba0e2e23886d8acc |
56
-        | name      | manila                           |
57
-        +-----------+----------------------------------+
58
-
59
-   * Add the ``admin`` role to the ``manila`` user:
60
-
61
-     .. code-block:: console
62
-
63
-        $ openstack role add --project service --user manila admin
64
-
65
-     .. note::
66
-
67
-        This command provides no output.
68
-
69
-   * Create the ``manila`` and ``manilav2`` service entities:
70
-
71
-     .. code-block:: console
72
-
73
-        $ openstack service create --name manila \
74
-          --description "OpenStack Shared File Systems" share
75
-          +-------------+----------------------------------+
76
-          | Field       | Value                            |
77
-          +-------------+----------------------------------+
78
-          | description | OpenStack Shared File Systems    |
79
-          | enabled     | True                             |
80
-          | id          | 82378b5a16b340aa9cc790cdd46a03ba |
81
-          | name        | manila                           |
82
-          | type        | share                            |
83
-          +-------------+----------------------------------+
84
-
85
-     .. code-block:: console
86
-
87
-        $ openstack service create --name manilav2 \
88
-          --description "OpenStack Shared File Systems" sharev2
89
-          +-------------+----------------------------------+
90
-          | Field       | Value                            |
91
-          +-------------+----------------------------------+
92
-          | description | OpenStack Shared File Systems    |
93
-          | enabled     | True                             |
94
-          | id          | 30d92a97a81a4e5d8fd97a32bafd7b88 |
95
-          | name        | manilav2                         |
96
-          | type        | sharev2                          |
97
-          +-------------+----------------------------------+
98
-
99
-     .. note::
100
-
101
-        The Shared File Systems services require two service entities.
102
-
103
-#. Create the Shared File Systems service API endpoints:
104
-
105
-   .. code-block:: console
106
-
107
-      $ openstack endpoint create --region RegionOne \
108
-        share public http://controller:8786/v1/%\(tenant_id\)s
109
-        +--------------+-----------------------------------------+
110
-        | Field        | Value                                   |
111
-        +--------------+-----------------------------------------+
112
-        | enabled      | True                                    |
113
-        | id           | 0bd2bbf8d28b433aaea56a254c69f69d        |
114
-        | interface    | public                                  |
115
-        | region       | RegionOne                               |
116
-        | region_id    | RegionOne                               |
117
-        | service_id   | 82378b5a16b340aa9cc790cdd46a03ba        |
118
-        | service_name | manila                                  |
119
-        | service_type | share                                   |
120
-        | url          | http://controller:8786/v1/%(tenant_id)s |
121
-        +--------------+-----------------------------------------+
122
-
123
-      $ openstack endpoint create --region RegionOne \
124
-        share internal http://controller:8786/v1/%\(tenant_id\)s
125
-        +--------------+-----------------------------------------+
126
-        | Field        | Value                                   |
127
-        +--------------+-----------------------------------------+
128
-        | enabled      | True                                    |
129
-        | id           | a2859b5732cc48b5b083dd36dafb6fd9        |
130
-        | interface    | internal                                |
131
-        | region       | RegionOne                               |
132
-        | region_id    | RegionOne                               |
133
-        | service_id   | 82378b5a16b340aa9cc790cdd46a03ba        |
134
-        | service_name | manila                                  |
135
-        | service_type | share                                   |
136
-        | url          | http://controller:8786/v1/%(tenant_id)s |
137
-        +--------------+-----------------------------------------+
138
-
139
-      $ openstack endpoint create --region RegionOne \
140
-        share admin http://controller:8786/v1/%\(tenant_id\)s
141
-        +--------------+-----------------------------------------+
142
-        | Field        | Value                                   |
143
-        +--------------+-----------------------------------------+
144
-        | enabled      | True                                    |
145
-        | id           | f7f46df93a374cc49c0121bef41da03c        |
146
-        | interface    | admin                                   |
147
-        | region       | RegionOne                               |
148
-        | region_id    | RegionOne                               |
149
-        | service_id   | 82378b5a16b340aa9cc790cdd46a03ba        |
150
-        | service_name | manila                                  |
151
-        | service_type | share                                   |
152
-        | url          | http://controller:8786/v1/%(tenant_id)s |
153
-        +--------------+-----------------------------------------+
154
-
155
-   .. code-block:: console
156
-
157
-      $ openstack endpoint create --region RegionOne \
158
-        sharev2 public http://controller:8786/v2/%\(tenant_id\)s
159
-        +--------------+-----------------------------------------+
160
-        | Field        | Value                                   |
161
-        +--------------+-----------------------------------------+
162
-        | enabled      | True                                    |
163
-        | id           | d63cc0d358da4ea680178657291eddc1        |
164
-        | interface    | public                                  |
165
-        | region       | RegionOne                               |
166
-        | region_id    | RegionOne                               |
167
-        | service_id   | 30d92a97a81a4e5d8fd97a32bafd7b88        |
168
-        | service_name | manilav2                                |
169
-        | service_type | sharev2                                 |
170
-        | url          | http://controller:8786/v2/%(tenant_id)s |
171
-        +--------------+-----------------------------------------+
172
-
173
-      $ openstack endpoint create --region RegionOne \
174
-        sharev2 internal http://controller:8786/v2/%\(tenant_id\)s
175
-        +--------------+-----------------------------------------+
176
-        | Field        | Value                                   |
177
-        +--------------+-----------------------------------------+
178
-        | enabled      | True                                    |
179
-        | id           | afc86e5f50804008add349dba605da54        |
180
-        | interface    | internal                                |
181
-        | region       | RegionOne                               |
182
-        | region_id    | RegionOne                               |
183
-        | service_id   | 30d92a97a81a4e5d8fd97a32bafd7b88        |
184
-        | service_name | manilav2                                |
185
-        | service_type | sharev2                                 |
186
-        | url          | http://controller:8786/v2/%(tenant_id)s |
187
-        +--------------+-----------------------------------------+
188
-
189
-      $ openstack endpoint create --region RegionOne \
190
-        sharev2 admin http://controller:8786/v2/%\(tenant_id\)s
191
-        +--------------+-----------------------------------------+
192
-        | Field        | Value                                   |
193
-        +--------------+-----------------------------------------+
194
-        | enabled      | True                                    |
195
-        | id           | e814a0cec40546e98cf0c25a82498483        |
196
-        | interface    | admin                                   |
197
-        | region       | RegionOne                               |
198
-        | region_id    | RegionOne                               |
199
-        | service_id   | 30d92a97a81a4e5d8fd97a32bafd7b88        |
200
-        | service_name | manilav2                                |
201
-        | service_type | sharev2                                 |
202
-        | url          | http://controller:8786/v2/%(tenant_id)s |
203
-        +--------------+-----------------------------------------+
204
-
205
-   .. note::
206
-
207
-      The Shared File Systems services require endpoints for each service
208
-      entity.

+ 0
- 98
install-guide/source/common/dhss-false-mode-configuration.rst View File

@@ -1,98 +0,0 @@
1
-2. Create the LVM physical volume ``/dev/sdc``:
2
-
3
-   .. code-block:: console
4
-
5
-      # pvcreate /dev/sdc
6
-      Physical volume "/dev/sdc" successfully created
7
-
8
-#. Create the LVM volume group ``manila-volumes``:
9
-
10
-   .. code-block:: console
11
-
12
-      # vgcreate manila-volumes /dev/sdc
13
-      Volume group "manila-volumes" successfully created
14
-
15
-   The Shared File Systems service creates logical volumes in this volume
16
-   group.
17
-
18
-#. Only instances can access Shared File Systems service volumes. However,
19
-   the underlying operating system manages the devices associated with
20
-   the volumes. By default, the LVM volume scanning tool scans the
21
-   ``/dev`` directory for block storage devices that
22
-   contain volumes. If projects use LVM on their volumes, the scanning
23
-   tool detects these volumes and attempts to cache them which can cause
24
-   a variety of problems with both the underlying operating system
25
-   and project volumes. You must reconfigure LVM to scan only the devices
26
-   that contain the ``cinder-volume`` and ``manila-volumes`` volume groups.
27
-   Edit the ``/etc/lvm/lvm.conf`` file and complete the following actions:
28
-
29
-   * In the ``devices`` section, add a filter that accepts the
30
-     ``/dev/sdb`` and ``/dev/sdc`` devices and rejects all other devices:
31
-
32
-     .. code-block:: ini
33
-
34
-        devices {
35
-        ...
36
-        filter = [ "a/sdb/", "a/sdc", "r/.*/"]
37
-
38
-     .. warning::
39
-
40
-        If your storage nodes use LVM on the operating system disk, you
41
-        must also add the associated device to the filter. For example,
42
-        if the ``/dev/sda`` device contains the operating system:
43
-
44
-        .. code-block:: ini
45
-
46
-           filter = [ "a/sda/", "a/sdb/", "a/sdc", "r/.*/"]
47
-
48
-        Similarly, if your compute nodes use LVM on the operating
49
-        system disk, you must also modify the filter in the
50
-        ``/etc/lvm/lvm.conf`` file on those nodes to include only
51
-        the operating system disk. For example, if the ``/dev/sda``
52
-        device contains the operating system:
53
-
54
-        .. code-block:: ini
55
-
56
-           filter = [ "a/sda/", "r/.*/"]
57
-
58
-Configure components
59
---------------------
60
-
61
-#. Edit the ``/etc/manila/manila.conf`` file and complete the following
62
-   actions:
63
-
64
-   * In the ``[DEFAULT]`` section, enable the LVM driver and the NFS
65
-     protocol:
66
-
67
-     .. code-block:: ini
68
-
69
-        [DEFAULT]
70
-        ...
71
-        enabled_share_backends = lvm
72
-        enabled_share_protocols = NFS
73
-
74
-     .. note::
75
-
76
-        Back end names are arbitrary. As an example, this guide uses the name
77
-        of the driver.
78
-
79
-   * In the ``[lvm]`` section, configure the LVM driver:
80
-
81
-     .. code-block:: ini
82
-
83
-        [lvm]
84
-        share_backend_name = LVM
85
-        share_driver = manila.share.drivers.lvm.LVMShareDriver
86
-        driver_handles_share_servers = False
87
-        lvm_share_volume_group = manila-volumes
88
-        lvm_share_export_ip = MANAGEMENT_INTERFACE_IP_ADDRESS
89
-
90
-     Replace ``MANAGEMENT_INTERFACE_IP_ADDRESS`` with the IP address
91
-     of the management network interface on your storage node,
92
-     typically 10.0.0.41 for the first node in the example architecture
93
-     shown below:
94
-
95
-     .. figure:: figures/hwreqs.png
96
-        :alt: Hardware requirements
97
-
98
-        **Hardware requirements**.

+ 0
- 8
install-guide/source/common/dhss-false-mode-intro.rst View File

@@ -1,8 +0,0 @@
1
-Shared File Systems Option 1: No driver support for share servers management
2
-----------------------------------------------------------------------------
3
-
4
-For simplicity, this configuration references the same storage node
5
-configuration for the Block Storage service. However, the LVM driver
6
-requires a separate empty local block storage device to avoid conflict
7
-with the Block Storage service. The instructions use ``/dev/sdc``, but
8
-you can substitute a different value for your particular node.

+ 0
- 176
install-guide/source/common/dhss-false-mode-using-shared-file-systems.rst View File

@@ -1,176 +0,0 @@
1
-Creating shares with Shared File Systems Option 1 (DHSS = False)
2
-----------------------------------------------------------------
3
-
4
-Create a share type
5
--------------------
6
-
7
-Disable DHSS (``driver_handles_share_servers``) before creating a share using
8
-the LVM driver.
9
-
10
-#. Source the admin credentials to gain access to admin-only CLI commands:
11
-
12
-   .. code-block:: console
13
-
14
-      $ . admin-openrc
15
-
16
-#. Create a default share type with DHSS disabled. A default share type will
17
-   allow you to create shares with this driver, without having to specify
18
-   the share type explicitly during share creation.
19
-
20
-   .. code-block:: console
21
-
22
-      $ manila type-create default_share_type False
23
-      +----------------------+--------------------------------------+
24
-      | Property             | Value                                |
25
-      +----------------------+--------------------------------------+
26
-      | required_extra_specs | driver_handles_share_servers : False |
27
-      | Name                 | default_share_type                   |
28
-      | Visibility           | public                               |
29
-      | is_default           | -                                    |
30
-      | ID                   | 3df065c8-6ca4-4b80-a5cb-e633c0439097 |
31
-      | optional_extra_specs | snapshot_support : True              |
32
-      +----------------------+--------------------------------------+
33
-
34
-   Set this default share type in ``manila.conf`` under the ``[DEFAULT]``
35
-   section and restart the ``manila-api`` service before proceeding.
36
-   Unless you do so, the default share type will not be effective.
37
-
38
-   .. note::
39
-
40
-      Creating and configuring a default share type is optional. If you wish
41
-      to use the shared file system service with a variety of share types,
42
-      where each share creation request could specify a type, please refer to
43
-      the Share types usage documentation `here
44
-      <http://docs.openstack.org/admin-guide/shared-file-systems-share-types.html>_`.
45
-
46
-Create a share
47
---------------
48
-
49
-#. Source the ``demo`` credentials to perform
50
-   the following steps as a non-administrative project:
51
-
52
-   .. code-block:: console
53
-
54
-      $ . demo-openrc
55
-
56
-#. Create an NFS share. Since a default share type has been created and
57
-   configured, it need not be specified in the request.
58
-
59
-   .. code-block:: console
60
-
61
-      $ manila create NFS 1 --name share1
62
-      +-----------------------------+--------------------------------------+
63
-      | Property                    | Value                                |
64
-      +-----------------------------+--------------------------------------+
65
-      | status                      | creating                             |
66
-      | share_type_name             | default_share_type                   |
67
-      | description                 | None                                 |
68
-      | availability_zone           | None                                 |
69
-      | share_network_id            | None                                 |
70
-      | host                        |                                      |
71
-      | access_rules_status         | active                               |
72
-      | snapshot_id                 | None                                 |
73
-      | is_public                   | False                                |
74
-      | task_state                  | None                                 |
75
-      | snapshot_support            | True                                 |
76
-      | id                          | 55c401b3-3112-4294-aa9f-3cc355a4e361 |
77
-      | size                        | 1                                    |
78
-      | name                        | share1                               |
79
-      | share_type                  | 3df065c8-6ca4-4b80-a5cb-e633c0439097 |
80
-      | has_replicas                | False                                |
81
-      | replication_type            | None                                 |
82
-      | created_at                  | 2016-03-30T19:10:33.000000           |
83
-      | share_proto                 | NFS                                  |
84
-      | consistency_group_id        | None                                 |
85
-      | source_cgsnapshot_member_id | None                                 |
86
-      | project_id                  | 3a46a53a377642a284e1d12efabb3b5a     |
87
-      | metadata                    | {}                                   |
88
-      +-----------------------------+--------------------------------------+
89
-
90
-#. After some time, the share status should change from ``creating``
91
-   to ``available``:
92
-
93
-   .. code-block:: console
94
-
95
-      $ manila list
96
-      +--------------------------------------+--------+------+-------------+-----------+-----------+--------------------+-----------------------------+-------------------+
97
-      | ID                                   | Name   | Size | Share Proto | Status    | Is Public | Share Type Name    | Host                        | Availability Zone |
98
-      +--------------------------------------+--------+------+-------------+-----------+-----------+--------------------+-----------------------------+-------------------+
99
-      | 55c401b3-3112-4294-aa9f-3cc355a4e361 | share1 | 1    | NFS         | available | False     | default_share_type | storage@lvm#lvm-single-pool | nova              |
100
-      +--------------------------------------+--------+------+-------------+-----------+-----------+--------------------+-----------------------------+-------------------+
101
-
102
-#. Determine export IP address of the share:
103
-
104
-   .. code-block:: console
105
-
106
-      $ manila show share1
107
-      +-----------------------------+------------------------------------------------------------------------------------+
108
-      | Property                    | Value                                                                              |
109
-      +-----------------------------+------------------------------------------------------------------------------------+
110
-      | status                      | available                                                                          |
111
-      | share_type_name             | default_share_type                                                                 |
112
-      | description                 | None                                                                               |
113
-      | availability_zone           | nova                                                                               |
114
-      | share_network_id            | None                                                                               |
115
-      | export_locations            |                                                                                    |
116
-      |                             | path = 10.0.0.41:/var/lib/manila/mnt/share-8e13a98f-c310-41df-ac90-fc8bce4910b8    |
117
-      |                             | id = 3c8d0ada-cadf-48dd-85b8-d4e8c3b1e204                                          |
118
-      |                             | preferred = False                                                                  |
119
-      | host                        | storage@lvm#lvm-single-pool                                                        |
120
-      | access_rules_status         | active                                                                             |
121
-      | snapshot_id                 | None                                                                               |
122
-      | is_public                   | False                                                                              |
123
-      | task_state                  | None                                                                               |
124
-      | snapshot_support            | True                                                                               |
125
-      | id                          | 55c401b3-3112-4294-aa9f-3cc355a4e361                                               |
126
-      | size                        | 1                                                                                  |
127
-      | name                        | share1                                                                             |
128
-      | share_type                  | c6dfcfc6-9920-420e-8b0a-283d578efef5                                               |
129
-      | has_replicas                | False                                                                              |
130
-      | replication_type            | None                                                                               |
131
-      | created_at                  | 2016-03-30T19:10:33.000000                                                         |
132
-      | share_proto                 | NFS                                                                                |
133
-      | consistency_group_id        | None                                                                               |
134
-      | source_cgsnapshot_member_id | None                                                                               |
135
-      | project_id                  | 3a46a53a377642a284e1d12efabb3b5a                                                   |
136
-      | metadata                    | {}                                                                                 |
137
-      +-----------------------------+------------------------------------------------------------------------------------+
138
-
139
-Allow access to the share
140
--------------------------
141
-
142
-#. Configure access to the new share before attempting to mount it via
143
-   the network. The compute instance (whose IP address is referenced by the
144
-   INSTANCE_IP below) must have network connectivity to the network specified
145
-   in the share network.
146
-
147
-   .. code-block:: console
148
-
149
-      $ manila access-allow share1 ip INSTANCE_IP
150
-      +--------------+--------------------------------------+
151
-      | Property     | Value                                |
152
-      +--------------+--------------------------------------+
153
-      | share_id     | 55c401b3-3112-4294-aa9f-3cc355a4e361 |
154
-      | access_type  | ip                                   |
155
-      | access_to    | 10.0.0.46                            |
156
-      | access_level | rw                                   |
157
-      | state        | new                                  |
158
-      | id           | f88eab01-7197-44bf-ad0f-d6ca6f99fc96 |
159
-      +--------------+--------------------------------------+
160
-
161
-Mount the share on a compute instance
162
--------------------------------------
163
-
164
-#. Log into your compute instance and create a folder where the mount will
165
-   be placed:
166
-
167
-   .. code-block:: console
168
-
169
-      $ mkdir ~/test_folder
170
-
171
-#. Mount the NFS share in the compute instance using the export location of
172
-   the share:
173
-
174
-   .. code-block:: console
175
-
176
-      # mount -vt nfs 10.0.0.41:/var/lib/manila/mnt/share-8e13a98f-c310-41df-ac90-fc8bce4910b8 ~/test_folder

+ 0
- 94
install-guide/source/common/dhss-true-mode-configuration.rst View File

@@ -1,94 +0,0 @@
1
-Configure components
2
---------------------
3
-
4
-#. Edit the ``/etc/manila/manila.conf`` file and complete the following
5
-   actions:
6
-
7
-   * In the ``[DEFAULT]`` section, enable the generic driver and the NFS
8
-     protocol:
9
-
10
-     .. code-block:: ini
11
-
12
-        [DEFAULT]
13
-        ...
14
-        enabled_share_backends = generic
15
-        enabled_share_protocols = NFS
16
-
17
-     .. note::
18
-
19
-        Back end names are arbitrary. As an example, this guide uses the name
20
-        of the driver.
21
-
22
-   * In the ``[neutron]``, ``[nova]``, and ``[cinder]`` sections, enable
23
-     authentication for those services:
24
-
25
-     .. code-block:: ini
26
-
27
-        [neutron]
28
-        ...
29
-        url = http://controller:9696
30
-        auth_uri = http://controller:5000
31
-        auth_url = http://controller:35357
32
-        memcached_servers = controller:11211
33
-        auth_type = password
34
-        project_domain_name = default
35
-        user_domain_name = default
36
-        region_name = RegionOne
37
-        project_name = service
38
-        username = neutron
39
-        password = NEUTRON_PASS
40
-
41
-        [nova]
42
-        ...
43
-        auth_uri = http://controller:5000
44
-        auth_url = http://controller:35357
45
-        memcached_servers = controller:11211
46
-        auth_type = password
47
-        project_domain_name = default
48
-        user_domain_name = default
49
-        region_name = RegionOne
50
-        project_name = service
51
-        username = nova
52
-        password = NOVA_PASS
53
-
54
-        [cinder]
55
-        ...
56
-        auth_uri = http://controller:5000
57
-        auth_url = http://controller:35357
58
-        memcached_servers = controller:11211
59
-        auth_type = password
60
-        project_domain_name = default
61
-        user_domain_name = default
62
-        region_name = RegionOne
63
-        project_name = service
64
-        username = cinder
65
-        password = CINDER_PASS
66
-
67
-   * In the ``[generic]`` section, configure the generic driver:
68
-
69
-     .. code-block:: ini
70
-
71
-        [generic]
72
-        share_backend_name = GENERIC
73
-        share_driver = manila.share.drivers.generic.GenericShareDriver
74
-        driver_handles_share_servers = True
75
-        service_instance_flavor_id = 100
76
-        service_image_name = manila-service-image
77
-        service_instance_user = manila
78
-        service_instance_password = manila
79
-        interface_driver = manila.network.linux.interface.BridgeInterfaceDriver
80
-
81
-     .. note::
82
-
83
-        You can also use SSH keys instead of password authentication for
84
-        service instance credentials.
85
-
86
-     .. important::
87
-
88
-        The ``service_image_name``, ``service_instance_flavor_id``,
89
-        ``service_instance_user`` and ``service_instance_password`` are with
90
-        reference to the service image that is used by the driver to create
91
-        share servers. A sample service image for use with the ``generic``
92
-        driver is available in the ``manila-image-elements`` project. Its
93
-        creation is explained in the post installation steps (See:
94
-        :ref:`post-install`).

+ 0
- 18
install-guide/source/common/dhss-true-mode-intro.rst View File

@@ -1,18 +0,0 @@
1
-Shared File Systems Option 2: Driver support for share servers management
2
--------------------------------------------------------------------------
3
-
4
-For simplicity, this configuration references the same storage node
5
-as the one used for the Block Storage service.
6
-
7
-.. note::
8
-
9
-   This guide describes how to configure the Shared File Systems service to
10
-   use the ``generic`` driver with the driver handles share server mode
11
-   (DHSS) enabled. This driver requires Compute service (nova), Image service
12
-   (glance) and Networking service (neutron) for creating and managing share
13
-   servers; and Block storage service (cinder) for creating shares. The
14
-   information used for creating share servers is configured as share
15
-   networks. Generic driver with DHSS enabled also requires the tenant's
16
-   private network (where the compute instances are running) to be attached
17
-   to a public router.
18
-

+ 0
- 304
install-guide/source/common/dhss-true-mode-using-shared-file-systems.rst View File

@@ -1,304 +0,0 @@
1
-Creating shares with Shared File Systems Option 2 (DHSS = True)
2
----------------------------------------------------------------
3
-
4
-Before being able to create a share, manila with the generic driver and
5
-the DHSS (``driver_handles_share_servers``) mode enabled requires the
6
-definition of at least an image, a network and a share-network for being
7
-used to create a share server. For that `back end` configuration, the share
8
-server is an instance where NFS shares are served.
9
-
10
-.. note::
11
-
12
-   This configuration automatically creates a cinder volume for every share.
13
-   The cinder volumes are attached to share servers according to the
14
-   definition of a share network.
15
-
16
-Create a share type
17
--------------------
18
-
19
-#. Source the admin credentials to gain access to admin-only CLI commands:
20
-
21
-   .. code-block:: console
22
-
23
-      $ . admin-openrc.sh
24
-
25
-#. Create a default share type with DHSS enabled. A default share type will
26
-   allow you to create shares with this driver, without having to specify
27
-   the share type explicitly during share creation.
28
-
29
-   .. code-block:: console
30
-
31
-      $ manila type-create default_share_type True
32
-      +----------------------+--------------------------------------+
33
-      | Property             | Value                                |
34
-      +----------------------+--------------------------------------+
35
-      | required_extra_specs | driver_handles_share_servers : True  |
36
-      | Name                 | default_share_type                   |
37
-      | Visibility           | public                               |
38
-      | is_default           | -                                    |
39
-      | ID                   | 8a35da28-0f74-490d-afff-23664ecd4f01 |
40
-      | optional_extra_specs | snapshot_support : True              |
41
-      +----------------------+--------------------------------------+
42
-
43
-   Set this default share type in ``manila.conf`` under the ``[DEFAULT]``
44
-   section and restart the ``manila-api`` service before proceeding.
45
-   Unless you do so, the default share type will not be effective.
46
-
47
-   .. note::
48
-
49
-      Creating and configuring a default share type is optional. If you wish
50
-      to use the shared file system service with a variety of share types,
51
-      where each share creation request could specify a type, please refer to
52
-      the Share types usage documentation `here
53
-      <http://docs.openstack.org/admin-guide/shared-file-systems-share-types.html>_`.
54
-
55
-Create a manila server image
56
-----------------------------
57
-
58
-   For evaluation of the Shared File Systems service, the image used by manila server must support
59
-   network file system protocols such as NFS/CIFS. This guide creates a regular instance using the
60
-   manila-share-service image because it supports NFS and using the
61
-   manila-service-flavor that limits resource consumption by the instance to 256 MB memory on the
62
-   compute node. You may skip this step if you already have a such kind of image in glance.
63
-
64
-#. Download the source image of the share server:
65
-
66
-   .. code-block:: console
67
-
68
-      $ wget http://tarballs.openstack.org/manila-image-elements/images/manila-service-image-master.qcow2
69
-
70
-#. Add the image to the Image service:
71
-
72
-   .. code-block:: console
73
-
74
-      $ openstack image create "manila-service-image" \
75
-      --file manila-service-image-master.qcow2 \
76
-      --disk-format qcow2 \
77
-      --container-format bare \
78
-      --public
79
-      +------------------+--------------------------------------+
80
-      | Property         | Value                                |
81
-      +------------------+--------------------------------------+
82
-      | checksum         | 48a08e746cf0986e2bc32040a9183445     |
83
-      | container_format | bare                                 |
84
-      | created_at       | 2016-01-26T19:52:24Z                 |
85
-      | disk_format      | qcow2                                |
86
-      | id               | 1fc7f29e-8fe6-44ef-9c3c-15217e83997c |
87
-      | min_disk         | 0                                    |
88
-      | min_ram          | 0                                    |
89
-      | name             | manila-service-image                 |
90
-      | owner            | e2c965830ecc4162a002bf16ddc91ab7     |
91
-      | protected        | False                                |
92
-      | size             | 306577408                            |
93
-      | status           | active                               |
94
-      | tags             | []                                   |
95
-      | updated_at       | 2016-01-26T19:52:28Z                 |
96
-      | virtual_size     | None                                 |
97
-      | visibility       | public                               |
98
-      +------------------+--------------------------------------+
99
-
100
-#. Create a new flavor to support the service image:
101
-
102
-   .. code-block:: console
103
-
104
-      openstack flavor create manila-service-flavor --id 100 --ram 256 --disk 0 --vcpus 1
105
-      +----------------------------+-----------------------+
106
-      | Field                      | Value                 |
107
-      +----------------------------+-----------------------+
108
-      | OS-FLV-DISABLED:disabled   | False                 |
109
-      | OS-FLV-EXT-DATA:ephemeral  | 0                     |
110
-      | disk                       | 0                     |
111
-      | id                         | 100                   |
112
-      | name                       | manila-service-flavor |
113
-      | os-flavor-access:is_public | True                  |
114
-      | ram                        | 256                   |
115
-      | rxtx_factor                | 1.0                   |
116
-      | swap                       |                       |
117
-      | vcpus                      | 1                     |
118
-      +----------------------------+-----------------------+
119
-
120
-.. note::
121
-
122
-       Be sure to set the configuration values ``service_image_name``,
123
-       ``service_instance_flavor_id``, ``service_anstance_user`` and ``service_instance_password``
124
-       in``manila.conf`` according to the image you chose, and restart the manila-share process.
125
-
126
-.. note::
127
-
128
-      As an alternative to specifying a plain-text
129
-      ``service_instance_password`` in your configuration, a key-pair may be
130
-      specified with options ``path_to_public_key`` and
131
-      ``path_to_private_key`` to configure and allow password-less SSH access
132
-      between the `share node` and the share server/s created.
133
-
134
-Create a share network
135
-----------------------
136
-
137
-#. Source the ``demo`` credentials to perform
138
-   the following steps as a non-administrative project:
139
-
140
-   .. code-block:: console
141
-
142
-      $ . demo-openrc.sh
143
-
144
-#. List available networks in order to get id and subnets of the private
145
-   network:
146
-
147
-   .. code-block:: console
148
-
149
-      $ neutron net-list
150
-      +--------------------------------------+---------+----------------------------------------------------+
151
-      | id                                   | name    | subnets                                            |
152
-      +--------------------------------------+---------+----------------------------------------------------+
153
-      | 0e62efcd-8cee-46c7-b163-d8df05c3c5ad | public  | 5cc70da8-4ee7-4565-be53-b9c011fca011 10.3.31.0/24  |
154
-      | 7c6f9b37-76b4-463e-98d8-27e5686ed083 | private | 3482f524-8bff-4871-80d4-5774c2730728 172.16.1.0/24 |
155
-      +--------------------------------------+---------+----------------------------------------------------+
156
-
157
-#. Create the share network using the private network and subnet IDs:
158
-
159
-   .. code-block:: console
160
-
161
-      $ manila share-network-create --name demo-share-network1 \
162
-      --neutron-net-id PRIVATE_NETWORK_ID \
163
-      --neutron-subnet-id PRIVATE_NETWORK_SUBNET_ID
164
-      +-------------------+--------------------------------------+
165
-      | Property          | Value                                |
166
-      +-------------------+--------------------------------------+
167
-      | name              | demo-share-network1                  |
168
-      | segmentation_id   | None                                 |
169
-      | created_at        | 2016-01-26T20:03:41.877838           |
170
-      | neutron_subnet_id | 3482f524-8bff-4871-80d4-5774c2730728 |
171
-      | updated_at        | None                                 |
172
-      | network_type      | None                                 |
173
-      | neutron_net_id    | 7c6f9b37-76b4-463e-98d8-27e5686ed083 |
174
-      | ip_version        | None                                 |
175
-      | nova_net_id       | None                                 |
176
-      | cidr              | None                                 |
177
-      | project_id        | e2c965830ecc4162a002bf16ddc91ab7     |
178
-      | id                | 58b2f0e6-5509-4830-af9c-97f525a31b14 |
179
-      | description       | None                                 |
180
-      +-------------------+--------------------------------------+
181
-
182
-Create a share
183
---------------
184
-
185
-#. Create an NFS share using the share network. Since a default share type has
186
-   been created and configured, it need not be specified in the request.
187
-
188
-   .. code-block:: console
189
-
190
-      $ manila create NFS 1 --name demo-share1 --share-network demo-share-network1
191
-      +-----------------------------+--------------------------------------+
192
-      | Property                    | Value                                |
193
-      +-----------------------------+--------------------------------------+
194
-      | status                      | None                                 |
195
-      | share_type_name             | default_share_type                   |
196
-      | description                 | None                                 |
197
-      | availability_zone           | None                                 |
198
-      | share_network_id            | 58b2f0e6-5509-4830-af9c-97f525a31b14 |
199
-      | host                        | None                                 |
200
-      | snapshot_id                 | None                                 |
201
-      | is_public                   | False                                |
202
-      | task_state                  | None                                 |
203
-      | snapshot_support            | True                                 |
204
-      | id                          | 016ca18f-bdd5-48e1-88c0-782e4c1aa28c |
205
-      | size                        | 1                                    |
206
-      | name                        | demo-share1                          |
207
-      | share_type                  | 8a35da28-0f74-490d-afff-23664ecd4f01 |
208
-      | created_at                  | 2016-01-26T20:08:50.502877           |
209
-      | export_location             | None                                 |
210
-      | share_proto                 | NFS                                  |
211
-      | consistency_group_id        | None                                 |
212
-      | source_cgsnapshot_member_id | None                                 |
213
-      | project_id                  | 48e8c35b2ac6495d86d4be61658975e7     |
214
-      | metadata                    | {}                                   |
215
-      +-----------------------------+--------------------------------------+
216
-
217
-#. After some time, the share status should change from ``creating``
218
-   to ``available``:
219
-
220
-   .. code-block:: console
221
-
222
-      $ manila list
223
-      +--------------------------------------+-------------+------+-------------+-----------+-----------+------------------------+-----------------------------+-------------------+
224
-      | ID                                   | Name        | Size | Share Proto | Status    | Is Public | Share Type Name        | Host                        | Availability Zone |
225
-      +--------------------------------------+-------------+------+-------------+-----------+-----------+------------------------+-----------------------------+-------------------+
226
-      | 5f8a0574-a95e-40ff-b898-09fd8d6a1fac | demo-share1 | 1    | NFS         | available | False     |   default_share_type   | storagenode@generic#GENERIC | nova              |
227
-      +--------------------------------------+-------------+------+-------------+-----------+-----------+------------------------+-----------------------------+-------------------+
228
-
229
-#. Determine export IP address of the share:
230
-
231
-   .. code-block:: console
232
-
233
-      $ manila show demo-share1
234
-      +-----------------------------+------------------------------------------------------------------------------------+
235
-      | Property                    | Value                                                                              |
236
-      +-----------------------------+------------------------------------------------------------------------------------+
237
-      | status                      | available                                                                          |
238
-      | share_type_name             | default_share_type                                                                 |
239
-      | description                 | None                                                                               |
240
-      | availability_zone           | nova                                                                               |
241
-      | share_network_id            | 58b2f0e6-5509-4830-af9c-97f525a31b14                                               |
242
-      | export_locations            |                                                                                    |
243
-      |                             | path = 10.254.0.6:/shares/share-0bfd69a1-27f0-4ef5-af17-7cd50bce6550               |
244
-      |                             | id = e525cbca-b3cc-4adf-a1cb-b1bf48fa2422                                          |
245
-      |                             | preferred = False                                                                  |
246
-      | host                        | storagenode@generic#GENERIC                                                        |
247
-      | access_rules_status         | active                                                                             |
248
-      | snapshot_id                 | None                                                                               |
249
-      | is_public                   | False                                                                              |
250
-      | task_state                  | None                                                                               |
251
-      | snapshot_support            | True                                                                               |
252
-      | id                          | 5f8a0574-a95e-40ff-b898-09fd8d6a1fac                                               |
253
-      | size                        | 1                                                                                  |
254
-      | name                        | demo-share1                                                                        |
255
-      | share_type                  | 8a35da28-0f74-490d-afff-23664ecd4f01                                               |
256
-      | has_replicas                | False                                                                              |
257
-      | replication_type            | None                                                                               |
258
-      | created_at                  | 2016-03-30T19:10:33.000000                                                         |
259
-      | share_proto                 | NFS                                                                                |
260
-      | consistency_group_id        | None                                                                               |
261
-      | source_cgsnapshot_member_id | None                                                                               |
262
-      | project_id                  | 48e8c35b2ac6495d86d4be61658975e7                                                   |
263
-      | metadata                    | {}                                                                                 |
264
-      +-----------------------------+------------------------------------------------------------------------------------+
265
-
266
-Allow access to the share
267
--------------------------
268
-
269
-#. Configure access to the new share before attempting to mount it via
270
-   the network. The compute instance (whose IP address is referenced by the
271
-   INSTANCE_IP below) must have network connectivity to the network specified
272
-   in the share network.
273
-
274
-   .. code-block:: console
275
-
276
-      $ manila access-allow demo-share1 ip INSTANCE_IP
277
-      +--------------+--------------------------------------+
278
-      | Property     | Value                                |
279
-      +--------------+--------------------------------------+
280
-      | share_id     | 5f8a0574-a95e-40ff-b898-09fd8d6a1fac |
281
-      | access_type  | ip                                   |
282
-      | access_to    | 10.0.0.46                            |
283
-      | access_level | rw                                   |
284
-      | state        | new                                  |
285
-      | id           | aefeab01-7197-44bf-ad0f-d6ca6f99fc96 |
286
-      +--------------+--------------------------------------+
287
-
288
-
289
-Mount the share on a compute instance
290
--------------------------------------
291
-
292
-#. Log into your compute instance and create a folder where the mount will
293
-   be placed:
294
-
295
-   .. code-block:: console
296
-
297
-      $ mkdir ~/test_folder
298
-
299
-#. Mount the NFS share in the compute instance using the export location of
300
-   the share:
301
-
302
-   .. code-block:: console
303
-
304
-      $ mount -vt nfs 10.254.0.6:/shares/share-0bfd69a1-27f0-4ef5-af17-7cd50bce6550 ~/test_folder

+ 0
- 81
install-guide/source/common/share-node-common-configuration.rst View File

@@ -1,81 +0,0 @@
1
-4. Complete the rest of the configuration in ``manila.conf``.
2
-
3
-   * In the ``[DEFAULT]`` section, configure ``RabbitMQ``
4
-     message queue access:
5
-
6
-     .. code-block:: ini
7
-
8
-        [DEFAULT]
9
-        ...
10
-        transport_url = rabbit://openstack:RABBIT_PASS@controller
11
-
12
-     Replace ``RABBIT_PASS`` with the password you chose for the
13
-     ``openstack`` account in ``RabbitMQ``.
14
-
15
-   * In the ``[DEFAULT]`` section, set the following config values:
16
-
17
-     .. code-block:: ini
18
-
19
-        [DEFAULT]
20
-        ...
21
-        default_share_type = default_share_type
22
-        rootwrap_config = /etc/manila/rootwrap.conf
23
-
24
-     .. important::
25
-
26
-        The ``default_share_type`` option specifies the default share type to
27
-        be used when shares are created without specifying the share type in
28
-        the request. The default share type that is specified in the
29
-        configuration file has to be created with the necessary required
30
-        extra-specs (such as ``driver_handles_share_servers``) set
31
-        appropriately with reference to the driver mode used. This is
32
-        explained in further steps.
33
-
34
-   * In the ``[DEFAULT]`` and ``[keystone_authtoken]`` sections, configure
35
-     Identity service access:
36
-
37
-     .. code-block:: ini
38
-
39
-        [DEFAULT]
40
-        ...
41
-        auth_strategy = keystone
42
-
43
-        [keystone_authtoken]
44
-        ...
45
-        memcached_servers = controller:11211
46
-        auth_uri = http://controller:5000
47
-        auth_url = http://controller:35357
48
-        auth_type = password
49
-        project_domain_id = default
50
-        user_domain_id = default
51
-        project_name = service
52
-        username = manila
53
-        password = MANILA_PASS
54
-
55
-     Replace ``MANILA_PASS`` with the password you chose for the ``manila``
56
-     user in the Identity service.
57
-
58
-   * In the ``[DEFAULT]`` section, configure the ``my_ip`` option:
59
-
60
-     .. code-block:: ini
61
-
62
-        [DEFAULT]
63
-        ...
64
-        my_ip = MANAGEMENT_INTERFACE_IP_ADDRESS
65
-
66
-     Replace ``MANAGEMENT_INTERFACE_IP_ADDRESS`` with the IP address of the
67
-     management network interface on your share node, typically 10.0.0.41 for
68
-     the first node in the example architecture shown below:
69
-
70
-     .. figure:: figures/hwreqs.png
71
-        :alt: Hardware requirements
72
-
73
-        **Hardware requirements**
74
-
75
-   * In the ``[oslo_concurrency]`` section, configure the lock path:
76
-
77
-     .. code-block:: ini
78
-
79
-        [oslo_concurrency]
80
-        ...
81
-        lock_path = /var/lib/manila/tmp

+ 0
- 42
install-guide/source/common/share-node-share-server-modes.rst View File

@@ -1,42 +0,0 @@
1
-The share node can support two modes, with and without the handling of
2
-share servers. The mode depends on driver support.
3
-
4
-Option 1
5
---------
6
-Deploying the service without driver support for share server management.
7
-In this mode, the service does not do anything related to networking. The
8
-operator must ensure network connectivity between instances and the NAS
9
-protocol based server.
10
-
11
-This tutorial demonstrates setting up the LVM driver which creates LVM volumes
12
-on the share node and exports them with the help of an NFS server that is
13
-installed locally on the share node. It therefore requires LVM and NFS packages
14
-as well as an additional disk for the ``manila-share`` LVM volume group.
15
-
16
-This driver mode may be referred to as ``driver_handles_share_servers = False``
17
-mode, or simply ``DHSS=False`` mode.
18
-
19
-Option 2
20
---------
21
-Deploying the service with driver support for share server management. In
22
-this mode, the service runs with a back end driver that creates and manages
23
-share servers. This tutorial demonstrates setting up the ``Generic`` driver.
24
-This driver requires Compute service (nova), Image service (glance) and
25
-Networking service (neutron) for creating and managing share servers; and
26
-Block storage service (cinder) for creating shares.
27
-
28
-The information used for creating share servers is configured with the help of
29
-share networks.
30
-
31
-This driver mode may be referred to as ``driver_handles_share_servers = True``
32
-mode, or simply ``DHSS=True`` mode.
33
-
34
-.. warning::
35
-
36
-   When running the generic driver in ``DHSS=True`` driver mode, the share
37
-   service should be run on the same node as the networking service.
38
-   However, such a service may not be able to run the LVM driver that runs
39
-   in ``DHSS=False`` driver mode effectively, due to a bug in some
40
-   distributions of Linux. For more information, see LVM Driver section in the
41
-   `Configuration Reference Guide
42
-   <http://docs.openstack.org/ocata/config-reference/shared-file-systems.html>`_.

+ 0
- 306
install-guide/source/conf.py View File

@@ -1,306 +0,0 @@
1
-# Licensed under the Apache License, Version 2.0 (the "License");
2
-# you may not use this file except in compliance with the License.
3
-# You may obtain a copy of the License at
4
-#
5
-#    http://www.apache.org/licenses/LICENSE-2.0
6
-#
7
-# Unless required by applicable law or agreed to in writing, software
8
-# distributed under the License is distributed on an "AS IS" BASIS,
9
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
10
-# implied.
11
-# See the License for the specific language governing permissions and
12
-# limitations under the License.
13
-
14
-# This file is execfile()d with the current directory set to its
15
-# containing dir.
16
-#
17
-# Note that not all possible configuration values are present in this
18
-# autogenerated file.
19
-#
20
-# All configuration values have a default; values that are commented out
21
-# serve to show the default.
22
-
23
-import os
24
-
25
-
26
-import openstackdocstheme
27
-
28
-# If extensions (or modules to document with autodoc) are in another directory,
29
-# add these directories to sys.path here. If the directory is relative to the
30
-# documentation root, use os.path.abspath to make it absolute, like shown here.
31
-# sys.path.insert(0, os.path.abspath('.'))
32
-
33
-# -- General configuration ------------------------------------------------
34
-
35
-# If your documentation needs a minimal Sphinx version, state it here.
36
-# needs_sphinx = '1.0'
37
-
38
-# Add any Sphinx extension module names here, as strings. They can be
39
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40
-# ones.
41
-# TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder'
42
-# extensions =
43
-
44
-# Add any paths that contain templates here, relative to this directory.
45
-# templates_path = ['_templates']
46
-
47
-# The suffix of source filenames.
48
-source_suffix = '.rst'
49
-
50
-# The encoding of source files.
51
-# source_encoding = 'utf-8-sig'
52
-
53
-# The master toctree document.
54
-master_doc = 'index'
55
-
56
-# General information about the project.
57
-project = u'Installation Guide for Shared File Systems Service'
58
-bug_tag = u'install-guide'
59
-copyright = u'2016, OpenStack contributors'
60
-
61
-# The version info for the project you're documenting, acts as replacement for
62
-# |version| and |release|, also used in various other places throughout the
63
-# built documents.
64
-#
65
-# The short X.Y version.
66
-version = '0.1'
67
-# The full version, including alpha/beta/rc tags.
68
-release = '0.1'
69
-
70
-# A few variables have to be set for the log-a-bug feature.
71
-#   giturl: The location of conf.py on Git. Must be set manually.
72
-#   gitsha: The SHA checksum of the bug description. Automatically
73
-#           extracted from git log.
74
-#   bug_tag: Tag for categorizing the bug. Must be set manually.
75
-# These variables are passed to the logabug code via html_context.
76
-giturl = u'https://git.openstack.org/cgit/openstack/manila/tree/install-guide/source'
77
-git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
78
-gitsha = os.popen(git_cmd).read().strip('\n')
79
-# source tree
80
-pwd = os.getcwd()
81
-html_context = {
82
-    "pwd": pwd,
83
-    "gitsha": gitsha,
84
-    "bug_tag": bug_tag,
85
-    "giturl": giturl,
86
-    "bug_project": "manila",
87
-}
88
-
89
-# The language for content autogenerated by Sphinx. Refer to documentation
90
-# for a list of supported languages.
91
-# language = None
92
-
93
-# There are two options for replacing |today|: either, you set today to some
94
-# non-false value, then it is used:
95
-# today = ''
96
-# Else, today_fmt is used as the format for a strftime call.
97
-# today_fmt = '%B %d, %Y'
98
-
99
-# List of patterns, relative to source directory, that match files and
100
-# directories to ignore when looking for source files.
101
-exclude_patterns = ["common/*.rst"]
102
-
103
-# The reST default role (used for this markup: `text`) to use for all
104
-# documents.
105
-# default_role = None
106
-
107
-# If true, '()' will be appended to :func: etc. cross-reference text.
108
-# add_function_parentheses = True
109
-
110
-# If true, the current module name will be prepended to all description
111
-# unit titles (such as .. function::).
112
-# add_module_names = True
113
-
114
-# If true, sectionauthor and moduleauthor directives will be shown in the
115
-# output. They are ignored by default.
116
-# show_authors = False
117
-
118
-# The name of the Pygments (syntax highlighting) style to use.
119
-pygments_style = 'sphinx'
120
-
121
-# A list of ignored prefixes for module index sorting.
122
-# modindex_common_prefix = []
123
-
124
-# If true, keep warnings as "system message" paragraphs in the built documents.
125
-# keep_warnings = False
126
-
127
-
128
-# -- Options for HTML output ----------------------------------------------
129
-
130
-# The theme to use for HTML and HTML Help pages.  See the documentation for
131
-# a list of builtin themes.
132
-html_theme = 'openstackdocs'
133
-
134
-# Theme options are theme-specific and customize the look and feel of a theme
135
-# further.  For a list of options available for each theme, see the
136
-# documentation.
137
-# html_theme_options = {}
138
-
139
-# Add any paths that contain custom themes here, relative to this directory.
140
-html_theme_path = [openstackdocstheme.get_html_theme_path()]
141
-
142
-# The name for this set of Sphinx documents.  If None, it defaults to
143
-# "<project> v<release> documentation".
144
-# html_title = None
145
-
146
-# A shorter title for the navigation bar.  Default is the same as html_title.
147
-# html_short_title = None
148
-
149
-# The name of an image file (relative to this directory) to place at the top
150
-# of the sidebar.
151
-# html_logo = None
152
-
153
-# The name of an image file (within the static path) to use as favicon of the
154
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
155
-# pixels large.
156
-# html_favicon = None
157
-
158
-# Add any paths that contain custom static files (such as style sheets) here,
159
-# relative to this directory. They are copied after the builtin static files,
160
-# so a file named "default.css" will overwrite the builtin "default.css".
161
-# html_static_path = []
162
-
163
-# Add any extra paths that contain custom files (such as robots.txt or
164
-# .htaccess) here, relative to this directory. These files are copied
165
-# directly to the root of the documentation.
166
-# html_extra_path = []
167
-
168
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
169
-# using the given strftime format.
170
-# So that we can enable "log-a-bug" links from each output HTML page, this
171
-# variable must be set to a format that includes year, month, day, hours and
172
-# minutes.
173
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
174
-
175
-
176
-# If true, SmartyPants will be used to convert quotes and dashes to
177
-# typographically correct entities.
178
-# html_use_smartypants = True
179
-
180
-# Custom sidebar templates, maps document names to template names.
181
-# html_sidebars = {}
182
-
183
-# Additional templates that should be rendered to pages, maps page names to
184
-# template names.
185
-# html_additional_pages = {}
186
-
187
-# If false, no module index is generated.
188
-# html_domain_indices = True
189
-
190
-# If false, no index is generated.
191
-html_use_index = False
192
-
193
-# If true, the index is split into individual pages for each letter.
194
-# html_split_index = False
195
-
196
-# If true, links to the reST sources are added to the pages.
197
-html_show_sourcelink = False
198
-
199
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
200
-# html_show_sphinx = True
201
-
202
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
203
-# html_show_copyright = True
204
-
205
-# If true, an OpenSearch description file will be output, and all pages will
206
-# contain a <link> tag referring to it.  The value of this option must be the
207
-# base URL from which the finished HTML is served.
208
-# html_use_opensearch = ''
209
-
210
-# This is the file name suffix for HTML files (e.g. ".xhtml").
211
-# html_file_suffix = None
212
-
213
-# Output file base name for HTML help builder.
214
-htmlhelp_basename = 'install-guide'
215
-
216
-# If true, publish source files
217
-html_copy_source = False
218
-
219
-# -- Options for LaTeX output ---------------------------------------------
220
-
221
-latex_elements = {
222
-    # The paper size ('letterpaper' or 'a4paper').
223
-    # 'papersize': 'letterpaper',
224
-
225
-    # The font size ('10pt', '11pt' or '12pt').
226
-    # 'pointsize': '10pt',
227
-
228
-    # Additional stuff for the LaTeX preamble.
229
-    # 'preamble': '',
230
-}
231
-
232
-# Grouping the document tree into LaTeX files. List of tuples
233
-# (source start file, target name, title,
234
-#  author, documentclass [howto, manual, or own class]).
235
-latex_documents = [
236
-    ('index', 'InstallGuide.tex', u'Install Guide',
237
-     u'OpenStack contributors', 'manual'),
238
-]
239
-
240
-# The name of an image file (relative to this directory) to place at the top of
241
-# the title page.
242
-# latex_logo = None
243
-
244
-# For "manual" documents, if this is true, then toplevel headings are parts,
245
-# not chapters.
246
-# latex_use_parts = False
247
-
248
-# If true, show page references after internal links.
249
-# latex_show_pagerefs = False
250
-
251
-# If true, show URL addresses after external links.
252
-# latex_show_urls = False
253
-
254
-# Documents to append as an appendix to all manuals.
255
-# latex_appendices = []
256
-
257
-# If false, no module index is generated.
258
-# latex_domain_indices = True
259
-
260
-
261
-# -- Options for manual page output ---------------------------------------
262
-
263
-# One entry per manual page. List of tuples
264
-# (source start file, name, description, authors, manual section).
265
-man_pages = [
266
-    ('index', 'installguide', u'Install Guide',
267
-     [u'OpenStack contributors'], 1)
268
-]
269
-
270
-# If true, show URL addresses after external links.
271
-# man_show_urls = False
272
-
273
-
274
-# -- Options for Texinfo output -------------------------------------------
275
-
276
-# Grouping the document tree into Texinfo files. List of tuples
277
-# (source start file, target name, title, author,
278
-#  dir menu entry, description, category)
279
-texinfo_documents = [
280
-    ('index', 'InstallGuide', u'Install Guide',
281
-     u'OpenStack contributors', 'InstallGuide',
282
-     'This guide shows OpenStack end users how to install '
283
-     'an OpenStack cloud.', 'Miscellaneous'),
284
-]
285
-
286
-# Documents to append as an appendix to all manuals.
287
-# texinfo_appendices = []
288
-
289
-# If false, no module index is generated.
290
-# texinfo_domain_indices = True
291
-
292
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
293
-# texinfo_show_urls = 'footnote'
294
-
295
-# If true, do not generate a @detailmenu in the "Top" node's menu.
296
-# texinfo_no_detailmenu = False
297
-
298
-# -- Options for Internationalization output ------------------------------
299
-locale_dirs = ['locale/']
300
-
301
-# -- Options for PDF output --------------------------------------------------
302
-
303
-pdf_documents = [
304
-    ('index', u'InstallGuide', u'Install Guide',
305
-     u'OpenStack contributors')
306
-]

BIN
install-guide/source/figures/hwreqs.graffle View File


BIN
install-guide/source/figures/hwreqs.png View File


+ 0
- 3
install-guide/source/figures/hwreqs.svg
File diff suppressed because it is too large
View File


+ 0
- 40
install-guide/source/get-started-with-shared-file-systems.rst View File

@@ -1,40 +0,0 @@
1
-====================================
2
-Shared File Systems service overview
3
-====================================
4
-
5
-The OpenStack Shared File Systems service (manila) provides file storage to a
6
-virtual machine. The Shared File Systems service provides an abstraction
7
-for managing and provisioning of file shares. The service also enables
8
-management of share types as well as share snapshots if a driver supports
9
-them.
10
-
11
-The Shared File Systems service consists of the following components:
12
-
13
-manila-api
14
-  A WSGI app that authenticates and routes requests to the Shared File
15
-  Systems service.
16
-
17
-manila-data
18
-  A standalone service whose purpose is to process data operations such as
19
-  copying, share migration or backup.
20
-
21
-manila-scheduler
22
-  Schedules and routes requests to the appropriate share service. The
23
-  scheduler uses configurable filters and weighers to route requests. The
24
-  Filter Scheduler is the default and enables filters on various attributes
25
-  of back ends, such as, Capacity, Availability Zone and other capabilities.
26
-
27
-manila-share
28
-  Manages back-end devices that provide shared file systems. A manila-share
29
-  service talks to back-end devices by using share back-end drivers as
30
-  interfaces. A share driver may operate in one of two modes, with or
31
-  without handling of share servers. Share servers export file shares
32
-  via share networks. When share servers are not managed by a driver
33
-  within the shared file systems service, networking requirements should
34
-  be handled out of band of the shared file systems service.
35
-
36
-Messaging queue
37
-  Routes information between the Shared File Systems processes.
38
-
39
-For more information, see `Configuration Reference Guide
40
-<http://docs.openstack.org/ocata/config-reference/shared-file-systems.html>`_.

+ 0
- 63
install-guide/source/index.rst View File

@@ -1,63 +0,0 @@
1
-=========================================
2
-Shared File Systems Installation Tutorial
3
-=========================================
4
-
5
-.. toctree::
6
-   :maxdepth: 2
7
-
8
-   get-started-with-shared-file-systems.rst
9
-   install-controller-node.rst
10
-   install-share-node.rst
11
-   verify.rst
12
-   post-install.rst
13
-   next-steps.rst
14
-
15
-
16
-The OpenStack Shared File Systems service (manila) provides coordinated
17
-access to shared or distributed file systems. The method in which the share is
18
-provisioned and consumed is determined by the Shared File Systems driver, or
19
-drivers in the case of a multi-backend configuration. There are a variety of
20
-drivers that support NFS, CIFS, HDFS, GlusterFS, CEPHFS and other protocols
21
-as well.
22
-
23
-The Shared File Systems API and scheduler services typically run on the
24
-controller nodes. Depending upon the drivers used, the share service can run
25
-on controllers, compute nodes, or storage nodes.
26
-
27
-.. important::
28
-
29
-    For simplicity, this guide describes configuring the Shared File Systems
30
-    service to use one of either:
31
-
32
-    * the ``generic`` back end with the ``driver_handles_share_servers`` mode
33
-      (DHSS) enabled that uses the `Compute service` (`nova`),
34
-      `Image service` (`glance`), `Networking service` (`neutron`) and
35
-      `Block storage service` (`cinder`); or,
36
-    * the ``LVM`` back end with ``driver_handles_share_servers`` mode (DHSS)
37
-      disabled.
38
-
39
-    The storage protocol used and referenced in this guide is ``NFS``. As
40
-    stated above, the Shared File System service supports different storage
41
-    protocols depending on the back end chosen.
42
-
43
-    For the ``generic`` back end, networking service configuration requires
44
-    the capability of networks being attached to a public router in order to
45
-    create share networks. If using this back end, ensure that Compute,
46
-    Networking and Block storage services are properly working before you
47
-    proceed. For networking service, ensure that option 2 (deploying the
48
-    networking service with support for self-service networks) is properly
49
-    configured.
50
-
51
-    This installation tutorial also assumes that installation and configuration
52
-    of OpenStack packages, Network Time Protocol, database engine and
53
-    message queue has been completed as per the instructions in the `OpenStack
54
-    Installation Tutorial. <http://docs.openstack.org/#install-guides>`_. The
55
-    `Identity Service` (`keystone`) has to be pre-configured with suggested
56
-    client environment scripts.
57
-
58
-For more information on various Shared File Systems storage back ends,
59
-see the `Shared File Systems Configuration Reference.
60
-<http://docs.openstack.org/ocata/config-reference/shared-file-systems.html>`_.
61
-
62
-To learn more about installation dependencies noted above, see the `OpenStack
63
-Installation Tutorial. <http://docs.openstack.org/#install-guides>`_

+ 0
- 56
install-guide/source/install-controller-debian.rst View File

@@ -1,56 +0,0 @@
1
-.. _manila-controller-debian:
2
-
3
-Install and configure controller node on Debian
4
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
-
6
-This section describes how to install and configure the Shared File Systems
7
-service, code-named manila, on the controller node that runs a Debian
8
-distribution. This service requires at least one additional share node that
9
-manages file storage back ends.
10
-
11
-.. include:: common/controller-node-prerequisites.rst
12
-
13
-Install and configure components
14
---------------------------------
15
-
16
-#. Install the packages:
17
-
18
-   .. code-block:: console
19
-
20
-      # apt-get install manila-api manila-scheduler python-manilaclient
21
-
22
-#. Edit the ``/etc/manila/manila.conf`` file and complete the following
23
-   actions:
24
-
25
-   * In the ``[database]`` section, configure database access:
26
-
27
-     .. code-block:: ini
28
-
29
-        [database]
30
-        ...
31
-        connection = mysql+pymysql://manila:MANILA_DBPASS@controller/manila
32
-
33
-     Replace ``MANILA_DBPASS`` with the password you chose for the Shared
34
-     File Systems database.
35
-
36
-.. include:: common/controller-node-common-configuration.rst
37
-
38
-#. Populate the Shared File Systems database:
39
-
40
-   .. code-block:: console
41
-
42
-      # su -s /bin/sh -c "manila-manage db sync" manila
43
-
44
-   .. note::
45
-
46
-      Ignore any deprecation messages in this output.
47
-
48
-Finalize installation
49
----------------------
50
-
51
-#. Restart the Shared File Systems services:
52
-
53
-   .. code-block:: console
54
-
55
-      # service manila-scheduler restart
56
-      # service manila-api restart

+ 0
- 22
install-guide/source/install-controller-node.rst View File

@@ -1,22 +0,0 @@
1
-.. _manila-controller:
2
-
3
-Install and configure controller node
4
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
-
6
-This section describes how to install and configure the Shared File Systems
7
-service, code-named manila, on the controller node. This service requires at
8
-least one additional share node that manages file storage back ends.
9
-
10
-This section assumes that you already have a working OpenStack
11
-environment with at least the following components installed:
12
-Compute, Image Service, Identity.
13
-
14
-Note that installation and configuration vary by distribution.
15
-
16
-.. toctree::
17
-   :maxdepth: 1
18
-
19
-   install-controller-obs.rst
20
-   install-controller-rdo.rst
21
-   install-controller-ubuntu.rst
22
-   install-controller-debian.rst

+ 0
- 47
install-guide/source/install-controller-obs.rst View File

@@ -1,47 +0,0 @@
1
-.. _manila-controller-obs:
2
-
3
-Install and configure controller node on openSUSE and SUSE Linux Enterprise
4
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
-
6
-This section describes how to install and configure the Shared File Systems
7
-service, code-named manila, on the controller node that runs openSUSE and SUSE
8
-Linux Enterprise. This service requires at least one additional share node
9
-that manages file storage back ends.
10
-
11
-.. include:: common/controller-node-prerequisites.rst
12
-
13
-Install and configure components
14
---------------------------------
15
-
16
-#. Install the packages:
17
-
18
-   .. code-block:: console
19
-
20
-      # zypper install openstack-manila-api openstack-manila-scheduler python-manilaclient
21
-
22
-#. Edit the ``/etc/manila/manila.conf`` file and complete the
23
-   following actions:
24
-
25
-   * In the ``[database]`` section, configure database access:
26
-
27
-     .. code-block:: ini
28
-
29
-        [database]
30
-        ...
31
-        connection = mysql+pymysql://manila:MANILA_DBPASS@controller/manila
32
-
33
-     Replace ``MANILA_DBPASS`` with the password you chose for the Shared
34
-     File Systems database.
35
-
36
-.. include:: common/controller-node-common-configuration.rst
37
-
38
-Finalize installation
39
----------------------
40
-
41
-#. Start the Shared File Systems services and configure them to start when
42
-   the system boots:
43
-
44
-   .. code-block:: console
45
-
46
-      # systemctl enable openstack-manila-api.service openstack-manila-scheduler.service
47
-      # systemctl start openstack-manila-api.service openstack-manila-scheduler.service

+ 0
- 57
install-guide/source/install-controller-rdo.rst View File

@@ -1,57 +0,0 @@
1
-.. _manila-controller-rdo:
2
-
3
-Install and configure controller node on Red Hat Enterprise Linux and CentOS
4
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
-
6
-This section describes how to install and configure the Shared File Systems
7
-service, code-named manila, on the controller node that runs Red Hat
8
-Enterprise Linux or CentOS. This service requires at least one additional
9
-share node that manages file storage back ends.
10
-
11
-.. include:: common/controller-node-prerequisites.rst
12
-
13
-Install and configure components
14
---------------------------------
15
-
16
-#. Install the packages:
17
-
18
-   .. code-block:: console
19
-
20
-      # yum install openstack-manila python-manilaclient
21
-
22
-#. Edit the ``/etc/manila/manila.conf`` file and complete the
23
-   following actions:
24
-
25
-   * In the ``[database]`` section, configure database access:
26
-
27
-     .. code-block:: ini
28
-
29
-        [database]
30
-        ...
31
-        connection = mysql+pymysql://manila:MANILA_DBPASS@controller/manila
32
-
33
-     Replace ``MANILA_DBPASS`` with the password you chose for the Shared
34
-     File Systems database.
35
-
36
-.. include:: common/controller-node-common-configuration.rst
37
-
38
-#. Populate the Shared File Systems database:
39
-
40
-   .. code-block:: console
41
-
42
-      # su -s /bin/sh -c "manila-manage db sync" manila
43
-
44
-   .. note::
45
-
46
-      Ignore any deprecation messages in this output.
47
-
48
-Finalize installation
49
----------------------
50
-
51
-#. Start the Shared File Systems services and configure them to start when
52
-   the system boots:
53
-
54
-   .. code-block:: console
55
-
56
-      # systemctl enable openstack-manila-api.service openstack-manila-scheduler.service
57
-      # systemctl start openstack-manila-api.service openstack-manila-scheduler.service

+ 0
- 64
install-guide/source/install-controller-ubuntu.rst View File

@@ -1,64 +0,0 @@
1
-.. _manila-controller-ubuntu:
2
-
3
-Install and configure controller node on Ubuntu
4
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
-
6
-This section describes how to install and configure the Shared File Systems
7
-service, code-named manila, on the controller node that runs Ubuntu. This
8
-service requires at least one additional share node that manages file
9
-storage back ends.
10
-
11
-.. include:: common/controller-node-prerequisites.rst
12
-
13
-Install and configure components
14
---------------------------------
15
-
16
-#. Install the packages:
17
-
18
-   .. code-block:: console
19
-
20
-      # apt-get install manila-api manila-scheduler python-manilaclient
21
-
22
-#. Edit the ``/etc/manila/manila.conf`` file and complete the
23
-   following actions:
24
-
25
-   * In the ``[database]`` section, configure database access:
26
-
27
-     .. code-block:: ini
28
-
29
-        [database]
30
-        ...
31
-        connection = mysql+pymysql://manila:MANILA_DBPASS@controller/manila
32
-
33
-     Replace ``MANILA_DBPASS`` with the password you chose for the Shared
34
-     File Systems database.
35
-
36
-.. include:: common/controller-node-common-configuration.rst
37
-
38
-#. Populate the Shared File Systems database:
39
-
40
-   .. code-block:: console
41
-
42
-      # su -s /bin/sh -c "manila-manage db sync" manila
43
-
44
-   .. note::
45
-
46
-      Ignore any deprecation messages in this output.
47
-
48
-Finalize installation
49
----------------------
50
-
51
-#. Restart the Shared File Systems services:
52
-
53
-   .. code-block:: console
54
-
55
-      # service manila-scheduler restart
56
-      # service manila-api restart
57
-
58
-#. By default, the Ubuntu packages create an SQLite database. Because this
59
-   configuration uses an SQL database server, you can remove the SQLite
60
-   database file:
61
-
62
-   .. code-block:: console
63
-
64
-      # rm -f /var/lib/manila/manila.sqlite

+ 0
- 91
install-guide/source/install-share-debian.rst View File

@@ -1,91 +0,0 @@
1
-.. _share-node-install-debian:
2
-
3
-Install and configure a share node running Debian
4
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
-
6
-This section describes how to install and configure a share node for the
7
-Shared File Systems service. For simplicity, this configuration references one
8
-storage node with the generic driver managing the share servers. The
9
-generic backend manages share servers using compute, networking and block
10
-services for provisioning shares.
11
-
12
-Note that installation and configuration vary by distribution. This section
13
-describes the instructions for a share node running a Debian distribution.
14
-
15
-Install and configure components
16
---------------------------------
17
-
18
-#. Install the packages:
19
-
20
-   .. code-block:: console
21
-
22
-      # apt-get install manila-share python-pymysql
23
-
24
-#. Edit the ``/etc/manila/manila.conf`` file and complete the following
25
-   actions:
26
-
27
-   * In the ``[database]`` section, configure database access:
28
-
29
-     .. code-block:: ini
30
-
31
-        [database]
32
-        ...
33
-        connection = mysql+pymysql://manila:MANILA_DBPASS@controller/manila
34
-
35
-     Replace ``MANILA_DBPASS`` with the password you chose for the Shared
36
-     File Systems database.
37
-
38
-.. include:: common/share-node-common-configuration.rst
39
-
40
-Two driver modes
41
-----------------
42
-
43
-.. include:: common/share-node-share-server-modes.rst
44
-
45
-Choose one of the following options to configure the share driver:
46
-
47
-.. include:: common/dhss-false-mode-intro.rst
48
-
49
-Prerequisites
50
--------------
51
-
52
-.. note::
53
-
54
-   Perform these steps on the storage node.
55
-
56
-#. Install the supporting utility packages:
57
-
58
-   * Install LVM and NFS server packages:
59
-
60
-     .. code-block:: console
61
-
62
-        # apt-get install lvm2 nfs-kernel-server
63
-
64
-.. include:: common/dhss-false-mode-configuration.rst
65
-
66
-.. include:: common/dhss-true-mode-intro.rst
67
-
68
-Prerequisites
69
--------------
70
-
71
-Before you proceed, verify operation of the Compute, Networking, and Block
72
-Storage services. This options requires implementation of Networking option 2
73
-and requires installation of some Networking service components on the storage
74
-node.
75
-
76
-* Install the Networking service components:
77
-
78
-  .. code-block:: console
79
-
80
-     # apt-get install neutron-plugin-linuxbridge-agent
81
-
82
-.. include:: common/dhss-true-mode-configuration.rst
83
-
84
-Finalize installation
85
----------------------
86
-#. Prepare manila-share as start/stop service. Start the Shared File Systems
87
-   service including its dependencies:
88
-
89
-   .. code-block:: console
90
-
91
-      # service manila-share restart

+ 0
- 27
install-guide/source/install-share-node.rst View File

@@ -1,27 +0,0 @@
1
-.. _share-node-install:
2
-
3
-Install and configure a share node
4
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
-
6
-This section describes how to install and configure a share node for the
7
-Shared File Systems service.
8
-
9
-.. note::
10
-
11
-   The manila-share process can run in two modes, with and without handling of
12
-   share servers. Some drivers may support either modes; while some may only
13
-   support one of the two modes. See the `Configuration Reference
14
-   <http://docs.openstack.org/ocata/config-reference/shared-file-systems.html>`_
15
-   to determine if the driver you choose supports the driver mode desired.
16
-   This tutorial describes setting up each driver mode using an example driver
17
-   for the mode.
18
-
19
-Note that installation and configuration vary by distribution.
20
-
21
-.. toctree::
22
-   :maxdepth: 1
23
-
24
-   install-share-obs.rst
25
-   install-share-rdo.rst
26
-   install-share-ubuntu.rst
27
-   install-share-debian.rst

+ 0
- 90
install-guide/source/install-share-obs.rst View File

@@ -1,90 +0,0 @@
1
-.. _share-node-install-obs:
2
-
3
-Install and configure a share node running openSUSE and SUSE Linux Enterprise
4
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
-
6
-This section describes how to install and configure a share node for the
7
-Shared File Systems service.
8
-
9
-Note that installation and configuration vary by distribution. This section
10
-describes the instructions for a share node running openSUSE and SUSE Linux
11
-Enterprise.
12
-
13
-Install and configure components
14
---------------------------------
15
-
16
-#. Install the packages:
17
-
18
-   .. code-block:: console
19
-
20
-      # zypper install openstack-manila-share python-PyMySQL
21
-
22
-#. Edit the ``/etc/manila/manila.conf`` file and complete the following
23
-   actions:
24
-
25
-   * In the ``[database]`` section, configure database access:
26
-
27
-     .. code-block:: ini
28
-
29
-        [database]
30
-        ...
31
-        connection = mysql+pymysql://manila:MANILA_DBPASS@controller/manila
32
-
33
-     Replace ``MANILA_DBPASS`` with the password you chose for
34
-     the Shared File Systems database.
35
-
36
-.. include:: common/share-node-common-configuration.rst
37
-
38
-Two driver modes
39
-----------------
40
-
41
-.. include:: common/share-node-share-server-modes.rst
42
-
43
-Choose one of the following options to configure the share driver:
44
-
45
-.. include:: common/dhss-false-mode-intro.rst
46
-
47
-Prerequisites
48
--------------
49
-
50
-.. note::
51
-   Perform these steps on the storage node.
52
-
53
-#. Install the supporting utility packages:
54
-
55
-   * Install LVM and NFS server packages:
56
-
57
-     .. code-block:: console
58
-
59
-        # zypper install lvm2 nfs-kernel-server
60
-
61
-.. include:: common/dhss-false-mode-configuration.rst
62
-
63
-.. include:: common/dhss-true-mode-intro.rst
64
-
65
-Prerequisites
66
--------------
67
-
68
-Before you proceed, verify operation of the Compute, Networking, and Block
69
-Storage services. This options requires implementation of Networking option 2
70
-and requires installation of some Networking service components on the storage
71
-node.
72
-
73
-* Install the Networking service components:
74
-
75
-  .. code-block:: console
76
-
77
-     # zypper install --no-recommends openstack-neutron-linuxbridge-agent
78
-
79
-.. include:: common/dhss-true-mode-configuration.rst
80
-
81
-Finalize installation
82
----------------------
83
-#. Prepare manila-share as start/stop service. Start the Shared File Systems
84
-   service including its dependencies and configure them to start when the
85
-   system boots:
86
-
87
-   .. code-block:: console
88
-
89
-      # systemctl enable openstack-manila-share.service tgtd.service
90
-      # systemctl start openstack-manila-share.service tgtd.service

+ 0
- 103
install-guide/source/install-share-rdo.rst View File

@@ -1,103 +0,0 @@
1
-.. _share-node-install-rdo:
2
-
3
-Install and configure a share node running Red Hat Enterprise Linux and CentOS
4
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
-
6
-This section describes how to install and configure a share node for the
7
-Shared File Systems service. For simplicity, this configuration references one
8
-storage node with the generic driver managing the share servers. The
9
-generic backend manages share servers using compute, networking and block
10
-services for provisioning shares.
11
-
12
-Note that installation and configuration vary by distribution. This section
13
-describes the instructions for a share node running Red Hat Enterprise Linux
14
-or CentOS.
15
-
16
-Install and configure components
17
---------------------------------
18
-
19
-#. Install the packages:
20
-
21
-   .. code-block:: console
22
-
23
-      # yum install openstack-manila-share python2-PyMySQL
24
-
25
-#. Edit the ``/etc/manila/manila.conf`` file and complete the following
26
-   actions:
27
-
28
-   * In the ``[database]`` section, configure database access:
29
-
30
-     .. code-block:: ini
31
-
32
-        [database]
33
-        ...
34
-        connection = mysql://manila:MANILA_DBPASS@controller/manila
35
-
36
-
37
-     Replace ``MANILA_DBPASS`` with the password you chose for
38
-     the Shared File Systems database.
39
-
40
-.. include:: common/share-node-common-configuration.rst
41
-
42
-Two driver modes
43
-----------------
44
-
45
-.. include:: common/share-node-share-server-modes.rst
46
-
47
-Choose one of the following options to configure the share driver:
48
-
49
-.. include:: common/dhss-false-mode-intro.rst
50
-
51
-Prerequisites
52
--------------
53
-
54
-.. note::
55
-
56
-   Perform these steps on the storage node.
57
-
58
-#. Install the supporting utility packages:
59
-
60
-   * Install LVM and NFS server packages:
61
-
62
-     .. code-block:: console
63
-
64
-        # yum install lvm2 nfs-utils nfs4-acl-tools portmap
65
-
66
-   * Start the LVM metadata service and configure it to start when the
67
-     system boots:
68
-
69
-     .. code-block:: console
70
-
71
-        # systemctl enable lvm2-lvmetad.service
72
-        # systemctl start lvm2-lvmetad.service
73
-
74
-.. include:: common/dhss-false-mode-configuration.rst
75
-
76
-.. include:: common/dhss-true-mode-intro.rst
77
-
78
-Prerequisites
79
--------------
80
-
81
-Before you proceed, verify operation of the Compute, Networking, and Block
82
-Storage services. This options requires implementation of Networking option 2
83
-and requires installation of some Networking service components on the storage
84
-node.
85
-
86
-* Install the Networking service components:
87
-
88
-  .. code-block:: console
89
-
90
-     # yum install openstack-neutron openstack-neutron-linuxbridge ebtables
91
-
92
-.. include:: common/dhss-true-mode-configuration.rst
93
-
94
-Finalize installation
95
----------------------
96
-#. Prepare manila-share as start/stop service. Start the Shared File Systems
97
-   service including its dependencies and configure them to start when the
98
-   system boots:
99
-
100
-   .. code-block:: console
101
-
102
-      # systemctl enable openstack-manila-share.service target.service
103
-      # systemctl start openstack-manila-share.service target.service

+ 0
- 99
install-guide/source/install-share-ubuntu.rst View File

@@ -1,99 +0,0 @@
1
-.. _share-node-install-ubuntu:
2
-
3
-Install and configure a share node running Ubuntu
4
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
-
6
-This section describes how to install and configure a share node for the
7
-Shared File Systems service. For simplicity, this configuration references one
8
-storage node with the generic driver managing the share servers. The
9
-generic backend manages share servers using compute, networking and block
10
-services for provisioning shares.
11
-
12
-Note that installation and configuration vary by distribution. This section
13
-describes the instructions for a share node running Ubuntu.
14
-
15
-Install and configure components
16
---------------------------------
17
-
18
-#. Install the packages:
19
-
20
-   .. code-block:: console
21
-
22
-      # apt-get install manila-share python-pymysql
23
-
24
-#. Edit the ``/etc/manila/manila.conf`` file and complete the following
25
-   actions:
26
-
27
-   * In the ``[database]`` section, configure database access:
28
-
29
-     .. code-block:: ini
30
-
31
-        [database]
32
-        ...
33
-        connection = mysql+pymysql://manila:MANILA_DBPASS@controller/manila
34
-
35
-     Replace ``MANILA_DBPASS`` with the password you chose for
36
-     the Shared File Systems database.
37
-
38
-.. include:: common/share-node-common-configuration.rst
39
-
40
-Two driver modes
41
-----------------
42
-
43
-.. include:: common/share-node-share-server-modes.rst
44
-
45
-Choose one of the following options to configure the share driver:
46
-
47
-.. include:: common/dhss-false-mode-intro.rst
48
-
49
-Prerequisites
50
--------------
51
-
52
-.. note::
53
-
54
-   Perform these steps on the storage node.
55
-
56
-#. Install the supporting utility packages:
57
-
58
-   * Install LVM and NFS server packages:
59
-
60
-     .. code-block:: console
61
-
62
-        # apt-get install lvm2 nfs-kernel-server
63
-
64
-.. include:: common/dhss-false-mode-configuration.rst
65
-
66
-.. include:: common/dhss-true-mode-intro.rst
67
-
68
-Prerequisites
69
--------------
70
-
71
-Before you proceed, verify operation of the Compute, Networking, and Block
72
-Storage services. This options requires implementation of Networking option 2
73
-and requires installation of some Networking service components on the storage
74
-node.
75
-
76
-* Install the Networking service components:
77
-
78
-  .. code-block:: console
79
-
80
-     # apt-get install neutron-plugin-linuxbridge-agent
81
-
82
-.. include:: common/dhss-true-mode-configuration.rst
83
-
84
-Finalize installation
85
----------------------
86
-#. Prepare manila-share as start/stop service. Start the Shared File Systems
87
-   service including its dependencies:
88
-
89
-   .. code-block:: console
90
-
91
-      # service manila-share restart
92
-
93
-#. By default, the Ubuntu packages create an SQLite database. Because this
94
-   configuration uses an SQL database server, remove the SQLite database
95
-   file:
96
-
97
-   .. code-block:: console
98
-
99
-      # rm -f /var/lib/manila/manila.sqlite

+ 0
- 14
install-guide/source/next-steps.rst View File

@@ -1,14 +0,0 @@
1
-.. _next-steps:
2
-
3
-==========
4
-Next steps
5
-==========
6
-
7
-Your OpenStack environment now includes the Shared File Systems service.
8
-
9
-To add more services, see the `additional documentation on installing
10
-OpenStack services <http://docs.openstack.org/#install-guides>`_
11
-
12
-Continue to evaluate the Shared File Systems service by creating the service
13
-image and running the service with the correct driver mode that you chose
14
-while configuring the share node.

+ 0
- 22
install-guide/source/post-install.rst View File

@@ -1,22 +0,0 @@
1
-.. _post-install:
2
-
3
-Creating and using shared file systems
4
-======================================
5
-
6
-Depending on the option chosen while installing the share node (Option with
7
-share server management and one without); the steps to create and use your
8
-shared file systems will vary. When the Shared File Systems service handles
9
-the creation and management of share servers, you would need to specify the
10
-``share network`` with the request to create a share. Either modes will vary
11
-in their respective share type definition. When using the driver mode with
12
-automatic handling of share servers, a service image is needed as specified
13
-in your configuration. The instructions below enumerate the steps for both
14
-driver modes. Follow what is appropriate for your installation.
15
-
16
-.. include:: common/dhss-false-mode-using-shared-file-systems.rst
17
-
18
-.. include:: common/dhss-true-mode-using-shared-file-systems.rst
19
-
20
-For more information about how to manage shares, see the
21
-`OpenStack End User Guide
22
-<http://docs.openstack.org/user-guide/cli_manage_shares.html>`_

+ 0
- 29
install-guide/source/verify.rst View File

@@ -1,29 +0,0 @@
1
-.. _verify:
2
-
3
-Verify operation
4
-~~~~~~~~~~~~~~~~
5
-
6
-Verify operation of the Shared File Systems service.
7
-
8
-.. note::
9
-
10
-   Perform these commands on the controller node.
11
-
12
-#. Source the ``admin`` credentials to gain access to
13
-   admin-only CLI commands:
14
-
15
-   .. code-block:: console
16
-
17
-      $ . admin-openrc.sh
18
-
19
-#. List service components to verify successful launch of each process:
20
-
21
-   .. code-block:: console
22
-
23
-      $ manila service-list
24
-      +------------------+----------------+------+---------+-------+----------------------------+-----------------+
25
-      |      Binary      |    Host        | Zone |  Status | State |         Updated_at         | Disabled Reason |
26
-      +------------------+----------------+------+---------+-------+----------------------------+-----------------+
27
-      | manila-scheduler | controller     | nova | enabled |   up  | 2014-10-18T01:30:54.000000 |       None      |
28
-      | manila-share     | share1@generic | nova | enabled |   up  | 2014-10-18T01:30:57.000000 |       None      |
29
-      +------------------+----------------+------+---------+-------+----------------------------+-----------------+

+ 0
- 7
tox.ini View File

@@ -21,13 +21,6 @@ commands =
21 21
   sphinx-build -a -E -W -d releasenotes/build/doctrees \
22 22
          -b html releasenotes/source releasenotes/build/html
23 23
 
24
-[testenv:install-guide]
25
-# builds to install-guide/build/html
26
-whitelist_externals = rm
27
-commands =
28
-  rm -rf install-guide/build
29
-  sphinx-build -a -E -W -d install-guide/build/doctrees -b html install-guide/source install-guide/build/html
30
-
31 24
 [testenv:debug]
32 25
 commands = oslo_debug_helper {posargs}
33 26
 

Loading…
Cancel
Save