Merge "Remove zonemanager static config option tables"

This commit is contained in:
Zuul 2018-05-17 21:21:35 +00:00 committed by Gerrit Code Review
commit 089abd0159
6 changed files with 28 additions and 167 deletions

View File

@ -17,9 +17,13 @@ If Block Storage is configured to use a Fibre Channel volume driver that
supports Zone Manager, update ``cinder.conf`` to add the following
configuration options to enable Fibre Channel Zone Manager.
Make the following changes in the ``/etc/cinder/cinder.conf`` file.
Make the following changes in the ``/etc/cinder/cinder.conf`` file under a
``[fc-zone-manager]`` section.
.. include:: ../tables/cinder-zoning.inc
.. config-table::
:config-target: zoning
cinder.zonemanager.fc_zone_manager
To use different Fibre Channel Zone Drivers, use the parameters
described in this section.
@ -46,14 +50,21 @@ Brocade Fibre Channel Zone Driver
Brocade Fibre Channel Zone Driver performs zoning operations
through HTTP, HTTPS, or SSH.
Set the following options in the ``cinder.conf`` configuration file.
Set the following options in the ``cinder.conf`` configuration file under the
``[fc-zone-manager]`` section.
.. include:: ../tables/cinder-zoning_manager_brcd.inc
.. config-table::
:config-target: Brocade zoning manager
Configure SAN fabric parameters in the form of fabric groups as
described in the example below:
cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver
.. include:: ../tables/cinder-zoning_fabric_brcd.inc
Configure SAN fabric parameters under a section matching the name used in
``fc_fabric_names`` as described in the example below:
.. config-table::
:config-target: Brocade zoning fabrics
cinder.zonemanager.drivers.brocade.brcd_fabric_opts
.. note::
@ -99,12 +110,18 @@ Set the following options in the ``cinder.conf`` configuration file.
fc_fabric_names = CISCO_FABRIC_EXAMPLE
cisco_sb_connector = cinder.zonemanager.drivers.cisco.cisco_fc_zone_client_cli.CiscoFCZoneClientCLI
.. include:: ../tables/cinder-zoning_manager_cisco.inc
.. config-table::
:config-target: Cisco zoning manager
Configure SAN fabric parameters in the form of fabric groups as
described in the example below:
cinder.zonemanager.drivers.cisco.cisco_fc_zone_driver
.. include:: ../tables/cinder-zoning_fabric_cisco.inc
Configure SAN fabric parameters under a section matching the name used in
``fc_fabric_names`` as described in the example below:
.. config-table::
:config-target: Cisco zoning fabrics
cinder.zonemanager.drivers.cisco.cisco_fabric_opts
.. note::

View File

@ -1,34 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-zoning:
.. list-table:: Description of zoning configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``zoning_mode`` = ``None``
- (String) FC Zoning mode configured
* - **[fc-zone-manager]**
-
* - ``enable_unsupported_driver`` = ``False``
- (Boolean) Set this to True when you want to allow an unsupported zone manager driver to start. Drivers that haven't maintained a working CI system and testing are marked as unsupported until CI is working again. This also marks a driver as deprecated and may be removed in the next release.
* - ``fc_fabric_names`` = ``None``
- (String) Comma separated list of Fibre Channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric
* - ``fc_san_lookup_service`` = ``cinder.zonemanager.drivers.brocade.brcd_fc_san_lookup_service.BrcdFCSanLookupService``
- (String) FC SAN Lookup Service
* - ``zone_driver`` = ``cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver.BrcdFCZoneDriver``
- (String) FC Zone Driver responsible for zone management
* - ``zoning_policy`` = ``initiator-target``
- (String) Zoning policy configured by user; valid values include "initiator-target" or "initiator"

View File

@ -1,42 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-zoning_fabric_brcd:
.. list-table:: Description of brocade zoning fabrics configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[BRCD_FABRIC_EXAMPLE]**
-
* - ``fc_fabric_address`` =
- (String) Management IP of fabric.
* - ``fc_fabric_password`` =
- (String) Password for user.
* - ``fc_fabric_port`` = ``22``
- (Port number) Connecting port
* - ``fc_fabric_ssh_cert_path`` =
- (String) Local SSH certificate Path.
* - ``fc_fabric_user`` =
- (String) Fabric user ID.
* - ``fc_southbound_protocol`` = ``HTTP``
- (String) South bound connector for the fabric.
* - ``fc_virtual_fabric_id`` = ``None``
- (String) Virtual Fabric ID.
* - ``principal_switch_wwn`` = ``None``
- (String) DEPRECATED: Principal switch WWN of the fabric. This option is not used anymore.
* - ``zone_activate`` = ``True``
- (Boolean) Overridden zoning activation state.
* - ``zone_name_prefix`` = ``openstack``
- (String) Overridden zone name prefix.
* - ``zoning_policy`` = ``initiator-target``
- (String) Overridden zoning policy.

View File

@ -1,36 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-zoning_fabric_cisco:
.. list-table:: Description of cisco zoning fabrics configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[CISCO_FABRIC_EXAMPLE]**
-
* - ``cisco_fc_fabric_address`` =
- (String) Management IP of fabric
* - ``cisco_fc_fabric_password`` =
- (String) Password for user
* - ``cisco_fc_fabric_port`` = ``22``
- (Port number) Connecting port
* - ``cisco_fc_fabric_user`` =
- (String) Fabric user ID
* - ``cisco_zone_activate`` = ``True``
- (Boolean) overridden zoning activation state
* - ``cisco_zone_name_prefix`` = ``None``
- (String) overridden zone name prefix
* - ``cisco_zoning_policy`` = ``initiator-target``
- (String) overridden zoning policy
* - ``cisco_zoning_vsan`` = ``None``
- (String) VSAN of the Fabric

View File

@ -1,22 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-zoning_manager_brcd:
.. list-table:: Description of brocade zoning manager configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[fc-zone-manager]**
-
* - ``brcd_sb_connector`` = ``HTTP``
- (String) South bound connector for zoning operation

View File

@ -1,22 +0,0 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-zoning_manager_cisco:
.. list-table:: Description of cisco zoning manager configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[fc-zone-manager]**
-
* - ``cisco_sb_connector`` = ``cinder.zonemanager.drivers.cisco.cisco_fc_zone_client_cli.CiscoFCZoneClientCLI``
- (String) Southbound connector for zoning operation