From f6380f6f5a470951c838c792ffc51bcd4a86c472 Mon Sep 17 00:00:00 2001 From: Yamini Umapathy Date: Wed, 3 Dec 2014 22:38:37 +0530 Subject: [PATCH] Add Documentation for CISCOFCZoneDriver Added a new section for CiscoFCZoneDriver in Config Reference Guide Closes bug 1398790 Change-Id: I19640e210bd039b4dd92de85f3f2a334ea3afe8b --- doc/common/tables/cinder-zoning.xml | 8 +++ doc/common/tables/cinder-zoning_fabric.xml | 35 ------------ .../tables/cinder-zoning_fabric_cisco.xml | 54 +++++++++++++++++++ doc/common/tables/cinder-zoning_manager.xml | 12 ----- .../tables/cinder-zoning_manager_cisco.xml | 26 +++++++++ .../block-storage/section_fc-zoning.xml | 27 ++++++++++ .../cinder.flagmappings | 22 ++++---- .../cinder.headers | 2 + 8 files changed, 128 insertions(+), 58 deletions(-) create mode 100644 doc/common/tables/cinder-zoning_fabric_cisco.xml create mode 100644 doc/common/tables/cinder-zoning_manager_cisco.xml diff --git a/doc/common/tables/cinder-zoning.xml b/doc/common/tables/cinder-zoning.xml index bd614c2c83..7dfe85e585 100644 --- a/doc/common/tables/cinder-zoning.xml +++ b/doc/common/tables/cinder-zoning.xml @@ -28,6 +28,14 @@ fc_fabric_names = None (StrOpt) 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 + (StrOpt) FC San Lookup Service + + + zone_driver = cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver.BrcdFCZoneDriver + (StrOpt) FC Zone Driver responsible for zone management + zoning_policy = initiator-target (StrOpt) Zoning policy configured by user diff --git a/doc/common/tables/cinder-zoning_fabric.xml b/doc/common/tables/cinder-zoning_fabric.xml index 3b7cffdcda..08cb89e870 100644 --- a/doc/common/tables/cinder-zoning_fabric.xml +++ b/doc/common/tables/cinder-zoning_fabric.xml @@ -49,41 +49,6 @@ zoning_policy = initiator-target (StrOpt) overridden zoning policy - - [CISCO_FABRIC_EXAMPLE] - - - cisco_fc_fabric_address = - (StrOpt) Management IP of fabric - - - cisco_fc_fabric_password = - (StrOpt) Password for user - - - cisco_fc_fabric_port = 22 - (IntOpt) Connecting port - - - cisco_fc_fabric_user = - (StrOpt) Fabric user ID - - - cisco_zone_activate = True - (BoolOpt) overridden zoning activation state - - - cisco_zone_name_prefix = None - (StrOpt) overridden zone name prefix - - - cisco_zoning_policy = initiator-target - (StrOpt) overridden zoning policy - - - cisco_zoning_vsan = None - (StrOpt) VSAN of the Fabric - diff --git a/doc/common/tables/cinder-zoning_fabric_cisco.xml b/doc/common/tables/cinder-zoning_fabric_cisco.xml new file mode 100644 index 0000000000..13da7c7fb4 --- /dev/null +++ b/doc/common/tables/cinder-zoning_fabric_cisco.xml @@ -0,0 +1,54 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Description of cisco zoning fabrics configuration options
Configuration option = Default valueDescription
[CISCO_FABRIC_EXAMPLE]
cisco_fc_fabric_address = (StrOpt) Management IP of fabric
cisco_fc_fabric_password = (StrOpt) Password for user
cisco_fc_fabric_port = 22(IntOpt) Connecting port
cisco_fc_fabric_user = (StrOpt) Fabric user ID
cisco_zone_activate = True(BoolOpt) overridden zoning activation state
cisco_zone_name_prefix = None(StrOpt) overridden zone name prefix
cisco_zoning_policy = initiator-target(StrOpt) overridden zoning policy
cisco_zoning_vsan = None(StrOpt) VSAN of the Fabric
+ diff --git a/doc/common/tables/cinder-zoning_manager.xml b/doc/common/tables/cinder-zoning_manager.xml index b570546506..94f7f3a1db 100644 --- a/doc/common/tables/cinder-zoning_manager.xml +++ b/doc/common/tables/cinder-zoning_manager.xml @@ -21,18 +21,6 @@ brcd_sb_connector = cinder.zonemanager.drivers.brocade.brcd_fc_zone_client_cli.BrcdFCZoneClientCLI (StrOpt) Southbound connector for zoning operation - - cisco_sb_connector = cinder.zonemanager.drivers.cisco.cisco_fc_zone_client_cli.CiscoFCZoneClientCLI - (StrOpt) Southbound connector for zoning operation - - - fc_san_lookup_service = cinder.zonemanager.drivers.brocade.brcd_fc_san_lookup_service.BrcdFCSanLookupService - (StrOpt) FC San Lookup Service - - - zone_driver = cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver.BrcdFCZoneDriver - (StrOpt) FC Zone Driver responsible for zone management - diff --git a/doc/common/tables/cinder-zoning_manager_cisco.xml b/doc/common/tables/cinder-zoning_manager_cisco.xml new file mode 100644 index 0000000000..1dfa4c289b --- /dev/null +++ b/doc/common/tables/cinder-zoning_manager_cisco.xml @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + +
Description of cisco zoning manager configuration options
Configuration option = Default valueDescription
[fc-zone-manager]
cisco_sb_connector = cinder.zonemanager.drivers.cisco.cisco_fc_zone_client_cli.CiscoFCZoneClientCLI(StrOpt) Southbound connector for zoning operation
+ diff --git a/doc/config-reference/block-storage/section_fc-zoning.xml b/doc/config-reference/block-storage/section_fc-zoning.xml index 524cf50575..91d8c26fec 100644 --- a/doc/config-reference/block-storage/section_fc-zoning.xml +++ b/doc/config-reference/block-storage/section_fc-zoning.xml @@ -69,4 +69,31 @@ switches, see the Brocade Fabric OS user documentation. +
+ Cisco Fibre Channel Zone Driver + Cisco Fibre Channel Zone Driver performs zoning operations + via SSH. Configure Cisco Zone Driver and lookup service by + specifying the following parameters: + + Configure SAN fabric parameters in the form of fabric + groups as described in the example below: + + + Define a fabric group for each fabric using the fabric names + used in configuration option + as group name. + + The Cisco Fibre Channel Zone Driver supports basic and enhanced zoning + modes.The zoning VSAN must exist with an active zone set name which is + same as the parameter. + + +
+ System requirements + Cisco MDS 9000 Family Switches. + Cisco MDS NX-OS Release 6.2(9) or later. + For information about how to manage Cisco Fibre Channel + switches, see the Cisco MDS 9000 user documentation. +
+
diff --git a/tools/autogenerate-config-flagmappings/cinder.flagmappings b/tools/autogenerate-config-flagmappings/cinder.flagmappings index f9d9550093..3e21211c0f 100644 --- a/tools/autogenerate-config-flagmappings/cinder.flagmappings +++ b/tools/autogenerate-config-flagmappings/cinder.flagmappings @@ -480,14 +480,14 @@ BRCD_FABRIC_EXAMPLE/principal_switch_wwn zoning_fabric BRCD_FABRIC_EXAMPLE/zone_activate zoning_fabric BRCD_FABRIC_EXAMPLE/zone_name_prefix zoning_fabric BRCD_FABRIC_EXAMPLE/zoning_policy zoning_fabric -CISCO_FABRIC_EXAMPLE/cisco_fc_fabric_address zoning_fabric -CISCO_FABRIC_EXAMPLE/cisco_fc_fabric_password zoning_fabric -CISCO_FABRIC_EXAMPLE/cisco_fc_fabric_port zoning_fabric -CISCO_FABRIC_EXAMPLE/cisco_fc_fabric_user zoning_fabric -CISCO_FABRIC_EXAMPLE/cisco_zone_activate zoning_fabric -CISCO_FABRIC_EXAMPLE/cisco_zone_name_prefix zoning_fabric -CISCO_FABRIC_EXAMPLE/cisco_zoning_policy zoning_fabric -CISCO_FABRIC_EXAMPLE/cisco_zoning_vsan zoning_fabric +CISCO_FABRIC_EXAMPLE/cisco_fc_fabric_address zoning_fabric_cisco +CISCO_FABRIC_EXAMPLE/cisco_fc_fabric_password zoning_fabric_cisco +CISCO_FABRIC_EXAMPLE/cisco_fc_fabric_port zoning_fabric_cisco +CISCO_FABRIC_EXAMPLE/cisco_fc_fabric_user zoning_fabric_cisco +CISCO_FABRIC_EXAMPLE/cisco_zone_activate zoning_fabric_cisco +CISCO_FABRIC_EXAMPLE/cisco_zone_name_prefix zoning_fabric_cisco +CISCO_FABRIC_EXAMPLE/cisco_zoning_policy zoning_fabric_cisco +CISCO_FABRIC_EXAMPLE/cisco_zoning_vsan zoning_fabric_cisco database/backend database database/connection database database/connection_debug database @@ -510,10 +510,10 @@ database/sqlite_synchronous database database/use_db_reconnect database database/use_tpool database fc-zone-manager/brcd_sb_connector zoning_manager -fc-zone-manager/cisco_sb_connector zoning_manager +fc-zone-manager/cisco_sb_connector zoning_manager_cisco fc-zone-manager/fc_fabric_names zoning -fc-zone-manager/fc_san_lookup_service zoning_manager -fc-zone-manager/zone_driver zoning_manager +fc-zone-manager/fc_san_lookup_service zoning +fc-zone-manager/zone_driver zoning fc-zone-manager/zoning_policy zoning keymgr/api_class keymgr keymgr/encryption_api_url keymgr diff --git a/tools/autogenerate-config-flagmappings/cinder.headers b/tools/autogenerate-config-flagmappings/cinder.headers index 3a60ac09c7..0fdd523b9e 100644 --- a/tools/autogenerate-config-flagmappings/cinder.headers +++ b/tools/autogenerate-config-flagmappings/cinder.headers @@ -51,3 +51,5 @@ zones zones zoning zoning zoning_fabric zoning fabrics zoning_manager zoning manager +zoning_fabric_cisco cisco zoning fabrics +zoning_manager_cisco cisco zoning manager