Skip to content

Commit 3452d78

Browse files
authored
Merge pull request #27 from PureStorage-OpenConnect/update_rhosp_docs
Update RHOSP docs
2 parents f2daaa4 + 4cd8914 commit 3452d78

File tree

2 files changed

+41
-117
lines changed

2 files changed

+41
-117
lines changed

source/cinder/configuration/cinder_config_files/section_rhosp161_director_flasharray_configuration.rst

Lines changed: 22 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -47,75 +47,38 @@ the Overcloud resources by creating environment files.
4747

4848
To ensure that your RHOSP environment is correctly configured for using
4949
Pure Storage FlashArrays obtain a copy of `pure-temp.yaml <https://raw.githubusercontent.com/PureStorage-OpenConnect/tripleo-deployment-configs/master/RHOSP16.1/pure-temp.yaml>`__
50-
and save this in the ``/home/stack/templates`` directory. This will be required when
51-
deploying the Overcloud.
50+
and `cinder-pure-config.yaml <https://raw.githubusercontent.com/PureStorage-OpenConnect/tripleo-deployment-configs/master/RHOSP16.1/cinder-pure-config.yaml>`__
51+
and save these in the ``/home/stack/templates``
52+
directory. These will be required when deploying the Overcloud.
5253

5354
Multiple back end configuration
5455
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5556

5657
Define Pure Storage Cinder back ends using Custom THT Configuration syntax.
57-
It's possible to define all the back ends in a single environment file, but for
58-
sake of clarity, the following example organizes the back ends in multiple
59-
smaller environment files:
60-
61-
- ``/home/stack/templates/cinder-flasharray-backend1.yaml``
62-
63-
This file defines the first Cinder volume back end
64-
``tripleo_pure_1`` and its parameters:
58+
It's possible to define all the back ends in a single environment file by
59+
modifying the `cinder-pure-config.yaml` file as follows:
6560

6661
.. code-block:: yaml
6762
:name: cinder-flasharray-backend1.yaml
6863
6964
parameter_defaults:
70-
ControllerExtraConfig:
71-
cinder::config::cinder_config:
72-
tripleo_pure_1/CinderPureBackendName:
73-
value: tripleo_pure_1
74-
tripleo_pure_1/CinderPureStorageProtocol:
75-
value: 'iSCSI'
76-
tripleo_pure_1/CinderPureSanIp:
77-
value: san_ip_1
78-
tripleo_pure_1/CinderPureAPIToken:
79-
value: api_token_1
80-
81-
- ``/home/stack/templates/cinder-purestorage-backend2.yaml``
82-
83-
This file defines the second Cinder volume back end
84-
``tripleo_pure_2`` and its parameters:
85-
86-
.. code-block:: yaml
87-
:name: cinder-flasharray-backend2.yaml
88-
89-
parameter_defaults:
90-
ControllerExtraConfig:
91-
cinder::config::cinder_config:
92-
tripleo_pure_2/CinderPureBackendName:
93-
value: tripleo_pure_2
94-
tripleo_pure_2/CinderPureStorageProtocol:
95-
value: 'iSCSI'
96-
tripleo_pure_2/CinderPureSanIp:
97-
value: san_ip_2
98-
tripleo_pure_2/CinderPureAPIToken:
99-
value: api_token_2
65+
CinderPureBackendName:
66+
- tripleo_pure_1
67+
- tripleo_pure_2
68+
CinderPureStorageProtocol: 'iSCSI' # Default value for all Pure backends
69+
CinderPureUseChap: false # Default value for the Pure backends
70+
CinderPureMultiConfig:
71+
tripleo_pure_1:
72+
CinderPureSanIp: '10.0.0.1'
73+
CinderPureAPIToken: 'secret'
74+
tripleo_pure_2:
75+
CinderPureSanIp: '10.0.0.2'
76+
CinderPureAPIToken: 'anothersecret'
77+
CinderPureUseChap: true # Specific value for this backend
10078
10179
Modify the parameter values according to your Pure Storage back end
10280
configuration.
10381

104-
- ``/home/stack/templates/cinder-enabled-backends.yaml``
105-
106-
This file defines which back ends will be enabled. In this example, two
107-
back ends ``tripleo_pure_1`` and ``tripleo_pure_2`` will be
108-
enabled:
109-
110-
.. code-block:: yaml
111-
:name: cinder-enabled-backends.yaml
112-
113-
parameter_defaults:
114-
ControllerExtraConfig:
115-
cinder_user_enabled_backends:
116-
- 'tripleo_pure_1'
117-
- 'tripleo_pure_2'
118-
11982
.. note::
12083

12184
You can define arbitrary Custom THT Configurations using the following syntax:
@@ -137,8 +100,8 @@ smaller environment files:
137100
[backend_name]
138101
configuration_name=value
139102
140-
See `Optional Cinder Configuration Attributes (Train)
141-
<../section_flasharray-conf.html#optional-cinder-configuration-attributes>`_
103+
See `Optional Cinder Configuration Attributes (RHOSP16)
104+
<./section_flasharray-conf-train.html#optional-cinder-configuration-attributes>`_
142105
for a complete list of the available Cinder Configuration Options.
143106

144107
.. warning::
@@ -211,15 +174,13 @@ YAML file(s) you defined:
211174
212175
(undercloud) [stack@rhosp-undercloud ~]$ openstack overcloud deploy \
213176
--templates \
177+
-e /home/stack/cinder-pure-config.yaml \
214178
-e /home/stack/containers-prepare-parameter.yaml \
215-
-e /home/stack/templates/cinder-flasharray-backend1.yaml \
216-
-e /home/stack/templates/cinder-flasharray-backend2.yaml \
217-
-e /home/stack/templates/cinder-enabled-backends.yaml \
218179
-e /home/stack/templates/custom_container_pure.yaml \
219180
--stack overcloud
220181
221182
If you modified the container images environment file the
222-
``custom_container_pure.yaml`` line is not required above.
183+
``custom_container_pure.yaml`` option is not required in the above command.
223184

224185
.. note::
225186
Alternatively, you can use ``--environment-directory`` parameter and specify

source/cinder/configuration/cinder_config_files/section_rhosp16_director_flasharray_configuration.rst

Lines changed: 19 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -47,75 +47,38 @@ the Overcloud resources by creating environment files.
4747

4848
To ensure that your RHOSP environment is correctly configured for using
4949
Pure Storage FlashArrays obtain a copy of `pure-temp.yaml <https://raw.githubusercontent.com/PureStorage-OpenConnect/tripleo-deployment-configs/master/RHOSP16/pure-temp.yaml>`__
50-
and save this in the ``/home/stack/templates`` directory. This will be required when
50+
and `<https://raw.githubusercontent.com/PureStorage-OpenConnect/tripleo-deployment-configs/master/RHOSP16/cinder-pure-config.yaml>`__
51+
and save these in the ``/home/stack/templates`` directory. These will be required when
5152
deploying the Overcloud.
5253

5354
Multiple back end configuration
5455
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5556

5657
Define Pure Storage Cinder back ends using Custom THT Configuration syntax.
57-
It's possible to define all the back ends in a single environment file, but for
58-
sake of clarity, the following example organizes the back ends in multiple
59-
smaller environment files:
60-
61-
- ``/home/stack/templates/cinder-flasharray-backend1.yaml``
62-
63-
This file defines the first Cinder volume back end
64-
``tripleo_pure_1`` and its parameters:
58+
It's possible to define all the back ends in a single environment file by
59+
modifying the `cinder-pure-config.yaml` file as follows:
6560

6661
.. code-block:: yaml
6762
:name: cinder-flasharray-backend1.yaml
6863
6964
parameter_defaults:
70-
ControllerExtraConfig:
71-
cinder::config::cinder_config:
72-
tripleo_pure_1/CinderPureBackendName:
73-
value: tripleo_pure_1
74-
tripleo_pure_1/CinderPureStorageProtocol:
75-
value: 'iSCSI'
76-
tripleo_pure_1/CinderPureSanIp:
77-
value: san_ip_1
78-
tripleo_pure_1/CinderPureAPIToken:
79-
value: api_token_1
80-
81-
- ``/home/stack/templates/cinder-purestorage-backend2.yaml``
82-
83-
This file defines the second Cinder volume back end
84-
``tripleo_pure_2`` and its parameters:
85-
86-
.. code-block:: yaml
87-
:name: cinder-flasharray-backend2.yaml
88-
89-
parameter_defaults:
90-
ControllerExtraConfig:
91-
cinder::config::cinder_config:
92-
tripleo_pure_2/CinderPureBackendName:
93-
value: tripleo_pure_2
94-
tripleo_pure_2/CinderPureStorageProtocol:
95-
value: 'iSCSI'
96-
tripleo_pure_2/CinderPureSanIp:
97-
value: san_ip_2
98-
tripleo_pure_2/CinderPureAPIToken:
99-
value: api_token_2
65+
CinderPureBackendName:
66+
- tripleo_pure_1
67+
- tripleo_pure_2
68+
CinderPureStorageProtocol: 'iSCSI' # Default value for all Pure backends
69+
CinderPureUseChap: false # Default value for the Pure backends
70+
CinderPureMultiConfig:
71+
tripleo_pure_1:
72+
CinderPureSanIp: '10.0.0.1'
73+
CinderPureAPIToken: 'secret'
74+
tripleo_pure_2:
75+
CinderPureSanIp: '10.0.0.2'
76+
CinderPureAPIToken: 'anothersecret'
77+
CinderPureUseChap: true # Specific value for this backend
10078
10179
Modify the parameter values according to your Pure Storage back end
10280
configuration.
10381

104-
- ``/home/stack/templates/cinder-enabled-backends.yaml``
105-
106-
This file defines which back ends will be enabled. In this example, two
107-
back ends ``tripleo_pure_1`` and ``tripleo_pure_2`` will be
108-
enabled:
109-
110-
.. code-block:: yaml
111-
:name: cinder-enabled-backends.yaml
112-
113-
parameter_defaults:
114-
ControllerExtraConfig:
115-
cinder_user_enabled_backends:
116-
- 'tripleo_pure_1'
117-
- 'tripleo_pure_2'
118-
11982
.. note::
12083

12184
You can define arbitrary Custom THT Configurations using the following syntax:
@@ -137,8 +100,8 @@ smaller environment files:
137100
[backend_name]
138101
configuration_name=value
139102
140-
See `Optional Cinder Configuration Attributes (Train)
141-
<../section_flasharray-conf.html#optional-cinder-configuration-attributes>`_
103+
See `Optional Cinder Configuration Attributes (RHOSP16)
104+
<./section_flasharray-conf-train.html#optional-cinder-configuration-attributes>`_
142105
for a complete list of the available Cinder Configuration Options.
143106

144107
.. warning::

0 commit comments

Comments
 (0)