From 2b4581bedfbbb1d3e55658c744b8aa5c4bf8b194 Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Thu, 3 May 2018 03:04:24 -0500 Subject: [PATCH] Remove zonemanager static config option tables Switch to using config-table instead. Change-Id: Iac9ca774fd69069bb7d6c8b4860b75237f33b71e --- .../configuration/block-storage/fc-zoning.rst | 39 ++++++++++++----- .../configuration/tables/cinder-zoning.inc | 34 --------------- .../tables/cinder-zoning_fabric_brcd.inc | 42 ------------------- .../tables/cinder-zoning_fabric_cisco.inc | 36 ---------------- .../tables/cinder-zoning_manager_brcd.inc | 22 ---------- .../tables/cinder-zoning_manager_cisco.inc | 22 ---------- 6 files changed, 28 insertions(+), 167 deletions(-) delete mode 100644 doc/source/configuration/tables/cinder-zoning.inc delete mode 100644 doc/source/configuration/tables/cinder-zoning_fabric_brcd.inc delete mode 100644 doc/source/configuration/tables/cinder-zoning_fabric_cisco.inc delete mode 100644 doc/source/configuration/tables/cinder-zoning_manager_brcd.inc delete mode 100644 doc/source/configuration/tables/cinder-zoning_manager_cisco.inc diff --git a/doc/source/configuration/block-storage/fc-zoning.rst b/doc/source/configuration/block-storage/fc-zoning.rst index b88310a896a..8f3f9cffe30 100644 --- a/doc/source/configuration/block-storage/fc-zoning.rst +++ b/doc/source/configuration/block-storage/fc-zoning.rst @@ -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:: diff --git a/doc/source/configuration/tables/cinder-zoning.inc b/doc/source/configuration/tables/cinder-zoning.inc deleted file mode 100644 index b9d4520bf4d..00000000000 --- a/doc/source/configuration/tables/cinder-zoning.inc +++ /dev/null @@ -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" diff --git a/doc/source/configuration/tables/cinder-zoning_fabric_brcd.inc b/doc/source/configuration/tables/cinder-zoning_fabric_brcd.inc deleted file mode 100644 index 79b46d8d257..00000000000 --- a/doc/source/configuration/tables/cinder-zoning_fabric_brcd.inc +++ /dev/null @@ -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. diff --git a/doc/source/configuration/tables/cinder-zoning_fabric_cisco.inc b/doc/source/configuration/tables/cinder-zoning_fabric_cisco.inc deleted file mode 100644 index 911f66d5ca2..00000000000 --- a/doc/source/configuration/tables/cinder-zoning_fabric_cisco.inc +++ /dev/null @@ -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 diff --git a/doc/source/configuration/tables/cinder-zoning_manager_brcd.inc b/doc/source/configuration/tables/cinder-zoning_manager_brcd.inc deleted file mode 100644 index 22a883ebd4f..00000000000 --- a/doc/source/configuration/tables/cinder-zoning_manager_brcd.inc +++ /dev/null @@ -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 diff --git a/doc/source/configuration/tables/cinder-zoning_manager_cisco.inc b/doc/source/configuration/tables/cinder-zoning_manager_cisco.inc deleted file mode 100644 index fbf0324dca5..00000000000 --- a/doc/source/configuration/tables/cinder-zoning_manager_cisco.inc +++ /dev/null @@ -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