diff --git a/doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml b/doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml new file mode 100644 index 0000000000..1289c6c80f --- /dev/null +++ b/doc/config-reference/block-storage/drivers/zfssa-iscsi-driver.xml @@ -0,0 +1,211 @@ +
+ Oracle ZFS Storage Appliance iSCSI driver + Oracle ZFS Storage Appliances (ZFSSAs) provide advanced software to protect data, speed tuning and + troubleshooting, and deliver high performance and high availability. + Through the Oracle ZFSSA iSCSI Driver, OpenStack Block Storage can use an Oracle ZFSSA as a block storage resource. + The driver enables you to create iSCSI volumes that an OpenStack Block Storage server can allocate to any virtual machine running on a compute host. + The Oracle ZFSSA iSCSI Driver, version 1.0.0 and later, supports ZFSSA software release 2013.1.2.0 and later. + + + + Configuration + + + Enable RESTful service on the ZFSSA Storage Appliance. + + + Create a new user on the appliance with the following authorizations: + + + scope=stmf - allow_configure=true + + + scope=nas - allow_clone=true, allow_createProject=true, allow_createShare=true, allow_changeSpaceProps=true, allow_changeGeneralProps=true, allow_destroy=true, allow_rollback=true, allow_takeSnap=true + + + + You can create a role with authorizations as follows: + + zfssa:> configuration roles +zfssa:configuration roles> role OpenStackRole +zfssa:configuration roles OpenStackRole (uncommitted)> set description="OpenStack Cinder Driver" +zfssa:configuration roles OpenStackRole (uncommitted)> commit +zfssa:configuration roles> select OpenStackRole +zfssa:configuration roles OpenStackRole> authorizations create +zfssa:configuration roles OpenStackRole auth (uncommitted)> set scope=stmf +zfssa:configuration roles OpenStackRole auth (uncommitted)> set allow_configure=true +zfssa:configuration roles OpenStackRole auth (uncommitted)> commit + You can create a user with a specific role as follows: + zfssa:> configuration users +zfssa:configuration users> user cinder +zfssa:configuration users cinder (uncommitted)> set fullname="OpenStack Cinder Driver" +zfssa:configuration users cinder (uncommitted)> set initial_password=12345 +zfssa:configuration users cinder (uncommitted)> commit +zfssa:configuration users> select cinder set roles=OpenStackRole + + + You can also run this workflow to automate the above tasks. + + + + + + Ensure that the ZFSSA iSCSI service is online. If the ZFSSA iSCSI service is not online, enable the service by using the BUI, CLI or REST API in the appliance. + + zfssa:> configuration services iscsi +zfssa:configuration services iscsi> enable +zfssa:configuration services iscsi> show +Properties: +<status>= online +... + + + +Define the following required properties in the cinder.conf file: + volume_driver = cinder.volume.drivers.zfssa.zfssaiscsi.ZFSSAISCSIDriver +san_ip = myhost +san_login = username +san_password = password +zfssa_pool = mypool +zfssa_project = myproject +zfssa_initiator_group = default +zfssa_target_portal = w.x.y.z:3260 +zfssa_target_interfaces = e1000g0 +Optionally, you can define additional properties. + Target interfaces can be seen as follows in the CLI: + zfssa:> configuration net interfaces +zfssa:configuration net interfaces> show +Interfaces: +INTERFACE STATE CLASS LINKS ADDRS LABEL +e1000g0 up ip e1000g0 1.10.20.30/24 Untitled Interface +... + + + Do not use management interfaces for zfssa_target_interfaces. + + + + + + Supported operations + + + Create and delete volumes + + + Extend volume + + + Create and delete snapshots + + + Create volume from snapshot + + + Delete volume snapshots + + + Attach and detach volumes + + + Get volume stats + + + Clone volumes + + + Volume migration + + + + + ZFSSA assisted volume migration + The ZFSSA iSCSI driver supports storage assisted volume migration starting in the Liberty release. This feature + uses remote replication feature on the ZFSSA. Volumes can be migrated between + two backends configured not only to the same ZFSSA but also between + two separate ZFSSAs altogether. + + The following conditions must be met in order to use ZFSSA assisted volume + migration: + + + + Both the source and target backends are configured to ZFSSAs. + + + Remote replication service on the source and target appliance is enabled. + + + The ZFSSA to which the target backend is configured should be configured as a target in + the remote replication service of the ZFSSA configured to the source backend. + The remote replication target needs to be configured even when the source + and the destination for volume migration are the same ZFSSA. + Define zfssa_replication_ip in the cinder.conf of the source backend as the IP + address used to register the target ZFSSA in the remote replication service of + the source ZFSSA. + + + + The name of the iSCSI target group(zfssa_target_group) on the source and the + destination ZFSSA is the same. + + + + The volume is not attached and is in available state. + + + + If any of the above conditions are not met, the driver will proceed with generic + volume migration. + + The ZFSSA user on the source and target appliances will need to have additional + role authorizations for assisted volume migration to work. In scope nas, + set allow_rrtarget and allow_rrsource to true. + + + zfssa:configuration roles OpenStackRole auth (uncommitted)> set scope=nas + zfssa:configuration roles OpenStackRole auth (uncommitted)> set allow_rrtarget=true + zfssa:configuration roles OpenStackRole auth (uncommitted)> set allow_rrsource=true + + + + Supported extra specs + Extra specs provide the OpenStack storage admin the + flexibility to create volumes with different characteristics from the + ones specified in cinder.conf. The admin will + specify the volume properties as keys at volume type creation. When a + user requests a volume of this volume type, the volume will be created + with the properties specified as extra specs. + + The following extra specs scoped keys are supported by the driver + + + + zfssa:volblocksize + + + zfssa:sparse + + + zfssa:compression + + + zfssa:logbias + + + Volume types can be created using the cinder type-create. Extra spec keys can be added using cinder type-key command. + + + + + + Driver options + The Oracle ZFSSA iSCSI Driver supports these options: + + + +
diff --git a/doc/config-reference/block-storage/drivers/zfssa-nfs-driver.xml b/doc/config-reference/block-storage/drivers/zfssa-nfs-driver.xml index 3357c01a54..6446abc95a 100644 --- a/doc/config-reference/block-storage/drivers/zfssa-nfs-driver.xml +++ b/doc/config-reference/block-storage/drivers/zfssa-nfs-driver.xml @@ -35,6 +35,9 @@ Clone a volume + + Volume migration + diff --git a/doc/config-reference/block-storage/section_misc.xml b/doc/config-reference/block-storage/section_misc.xml index 91e3741544..4ba9eae519 100644 --- a/doc/config-reference/block-storage/section_misc.xml +++ b/doc/config-reference/block-storage/section_misc.xml @@ -54,7 +54,6 @@ - diff --git a/doc/config-reference/block-storage/section_volume-drivers.xml b/doc/config-reference/block-storage/section_volume-drivers.xml index 654191c8ed..12f49db6d0 100644 --- a/doc/config-reference/block-storage/section_volume-drivers.xml +++ b/doc/config-reference/block-storage/section_volume-drivers.xml @@ -49,5 +49,6 @@ + diff --git a/tools/autogenerate-config-flagmappings/cinder.flagmappings b/tools/autogenerate-config-flagmappings/cinder.flagmappings index 489820803e..649ce24795 100644 --- a/tools/autogenerate-config-flagmappings/cinder.flagmappings +++ b/tools/autogenerate-config-flagmappings/cinder.flagmappings @@ -596,8 +596,8 @@ zfssa_nfs_share_compression zfssa-nfs zfssa_nfs_share_logbias zfssa-nfs zfssa_pool zfssa-iscsi zfssa_project zfssa-iscsi -zfssa_replication_ip zfssa-nfs -zfssa_rest_timeout zfssa zfssa-nfs +zfssa_replication_ip zfssa-iscsi +zfssa_rest_timeout zfssa-iscsi zfssa-nfs zfssa_target_group zfssa-iscsi zfssa_target_interfaces zfssa-iscsi zfssa_target_password zfssa-iscsi diff --git a/tools/autogenerate-config-flagmappings/cinder.headers b/tools/autogenerate-config-flagmappings/cinder.headers index f7d25ef209..81779363d9 100644 --- a/tools/autogenerate-config-flagmappings/cinder.headers +++ b/tools/autogenerate-config-flagmappings/cinder.headers @@ -65,7 +65,6 @@ windows Windows xio X-IO volume driver xiv IBM XIV and DS8000 volume driver zadara Zadara Storage driver -zfssa ZFS Storage Appliance iSCSI driver zfssa-iscsi ZFS Storage Appliance iSCSI driver zfssa-nfs ZFS Storage Appliance NFS driver zones zones