Hitachi Block Storage Driver for OpenStack Queens User Guideitdoc.hitachi.co.jp/manuals/st_driver_os/dkc/MK-92ADPTR136-03.pdf · Appendix A: OpenStack overview ... This guide provides

Hitachi Block Storage Driver for OpenStackQueens

User Guide

MK-92ADPTR136-03August 2018

© 2015, 2018 Hitachi, Ltd. All rights reserved.

No part of this publication may be reproduced or transmitted in any form or by any means, electronic or mechanical, including copying andrecording, or stored in a database or retrieval system for commercial purposes without the express written permission of Hitachi, Ltd., orHitachi Vantara Corporation (collectively “Hitachi”). Licensee may make copies of the Materials provided that any such copy is: (i) created as anessential step in utilization of the Software as licensed and is used in no other manner; or (ii) used for archival purposes. Licensee may notmake any other copies of the Materials. “Materials” mean text, data, photographs, graphics, audio, video and documents.

Hitachi reserves the right to make changes to this Material at any time without notice and assumes no responsibility for its use. The Materialscontain the most current information available at the time of publication.

Some of the features described in the Materials might not be currently available. Refer to the most recent product announcement forinformation about feature and product availability, or contact Hitachi Vantara Corporation at https://support.hitachivantara.com/en_us/contact-us.html.

Notice: Hitachi products and services can be ordered only under the terms and conditions of the applicable Hitachi agreements. The use ofHitachi products is governed by the terms of your agreements with Hitachi Vantara Corporation.

By using this software, you agree that you are responsible for:

1. Acquiring the relevant consents as may be required under local privacy laws or otherwise from authorized employees and otherindividuals; and

2. Verifying that your data continues to be held, retrieved, deleted, or otherwise processed in accordance with relevant laws.

Notice on Export Controls. The technical data and technology inherent in this Document may be subject to U.S. export control laws, includingthe U.S. Export Administration Act and its associated regulations, and may be subject to export or import regulations in other countries. Readeragrees to comply strictly with all such regulations and acknowledges that Reader has the responsibility to obtain licenses to export, re-export, orimport the Document and any Compliant Products.

Hitachi is a registered trademark of Hitachi, Ltd., in the United States and other countries.

All other trademarks, service marks, and company names in this document or website are properties of their respective owners.

Hitachi Block Storage Driver for OpenStack Queens User Guide ii

https://support.hitachivantara.com/en_us/contact-us.html


Contents

Preface..................................................................................................... 7Intended audience............................................................................................... 7Software version.................................................................................................. 7Document conventions........................................................................................ 7Release notes......................................................................................................9Changes made in this revision.............................................................................9Referenced documents .......................................................................................9Related documents ...........................................................................................10Conventions for storage capacity values........................................................... 11Getting help........................................................................................................12Comments..........................................................................................................12

Chapter 1: Overview............................................................................. 13System Configuration.........................................................................................13Supported Cinder functions .............................................................................. 14Support for additional OpenStack operations ................................................... 16Backend storage management configuration.................................................... 16

Volume operations........................................................................................17Copy operations .......................................................................................... 18Volume attachment.......................................................................................21Backup operations........................................................................................22Manage and unmanage a volume................................................................23Volume migration .........................................................................................23

Chapter 2: System requirements.........................................................24Operating systems.............................................................................................24OpenStack......................................................................................................... 24Storage devices................................................................................................. 24

Contents

Hitachi Block Storage Driver for OpenStack Queens User Guide 3

Storage firmware versions................................................................................. 24Software.............................................................................................................25

Prerequisite packages..................................................................................25Storage management software ................................................................... 25Storage software licenses............................................................................ 26Software restrictions.....................................................................................26

Chapter 3: Installation and configuration..........................................27Installation and setup workflow..........................................................................27Supported configurations for Block Storage Driver for OpenStack....................28Management software restrictions ....................................................................29Environment setup.............................................................................................29

Connect nodes............................................................................................. 30Single node configuration.............................................................................30Controller node without I/O data paths ........................................................31Configure node setting................................................................................. 32About the communication mode of the Configuration Manager RESTAPI server ....................................................................................................32Configure storage resources........................................................................ 33

Common resources ................................................................................33Fibre Channel connectivity .....................................................................34iSCSI connectivity .................................................................................. 35

Configure Configuration Manager REST API server ...................................37Secure your storage system password........................................................ 38

Deploy Block Storage Driver for OpenStack (Red Hat)..................................... 38Install Block Storage Driver for OpenStack (SUSE/Mirantis/Ubuntu)................ 41

Installation prerequisites ..............................................................................41Block Storage Driver for OpenStack installation for SUSE ......................... 41Block Storage Driver for OpenStack installation for Mirantis and Ubuntu.... 42

Initial setup.........................................................................................................43Add a Block Storage Driver for OpenStack configuration (SUSE/Mirantis/Ubuntu)........................................................................................... 43

Using Crowbar (SUSE OpenStack Cloud)..............................................43Using FUEL (Mirantis OpenStack)..........................................................43

Contents


Using MAAS (Ubuntu OpenStack)..........................................................43Linking a volume type and a backend.......................................................... 43Edit cinder.conf (SUSE/Mirantis/Ubuntu)..................................................... 44

Restart Cinder (SUSE/Mirantis/Ubuntu)............................................................ 45Verify Block Storage Driver for OpenStack installation......................................46Update the Block Storage Driver for OpenStack............................................... 47

Update the Block Storage Driver for OpenStack software for Red Hat .......47Update the Block Storage Driver for OpenStack software for SUSE .......... 47Update the Block Storage Driver for OpenStack software for Mirantisand Ubuntu...................................................................................................48Updating the management parameters in the cinder.conf file...................... 48

Uninstall Block Storage Driver for OpenStack (SUSE/Mirantis/Ubuntu)............49Live migration ....................................................................................................50Configure multipathing.......................................................................................50Configure high availability..................................................................................51

High availability overview............................................................................. 51Pacemaker configurations for Cinder volumes.............................................51Build high availability environment of controller node ................................. 52Recoverable failures.....................................................................................52Handling HA post-failover ............................................................................52

Chapter 4: Hitachi extended functions............................................... 54Copy methods ...................................................................................................54Maximum number of copy pairs and consistency groups..................................57Port assignment using extra specs....................................................................57Port scheduler....................................................................................................58Data deduplication and compression.................................................................59

Enabling deduplication and compression ....................................................60Creating a volume with dedupe/comp enabled............................................ 60Deleting a volume with dedupe/comp enabled.............................................61

Chapter 5: Parameters..........................................................................62Block Storage Driver for OpenStack specific parameters .................................62Cinder-specific parameters................................................................................75

Contents


Chapter 6: Troubleshooting................................................................ 80Check the version of Block Storage Driver for OpenStack................................ 80hbsdgetinfo command....................................................................................... 81Configuration Manager logs...............................................................................85Openstack-cinder-volume service does not start...............................................86Volume (snapshot) cannot be created............................................................... 86Volume (snapshot) cannot be attached............................................................. 86Volume operations fail in a multi-controller node environment.......................... 86Volume attach and detach operations fail..........................................................86Volume detach operation fails............................................................................87Volume attach performance issues after HBA replacement.............................. 87Volume deletion causes error status..................................................................87Contacting Hitachi Vantara Corporation customer support................................87

Chapter 7: Messages............................................................................ 88Message output format...................................................................................... 88List of messages ...............................................................................................89Messages output by the command hbsdgetinfo......................................... 109

Messages output by the installer......................................................................110

Appendix A: OpenStack overview..................................................... 111About OpenStack............................................................................................. 111Cinder overview............................................................................................... 112Cinder commands............................................................................................112OpenStack commands.....................................................................................112

Appendix B: Block Storage Driver for OpenStack License............113

Glossary........................................................................................... 114

Contents


Preface

This guide provides overview of and technical information for installing, configuring, andadministering Hitachi Block Storage Driver for OpenStack.

Intended audience

This document is intended for operators and administrators who configure and operatecloud systems using the software tools listed below.■ Red Hat OpenStack Platform■ SUSE OpenStack Cloud■ Mirantis OpenStack■ Ubuntu OpenStack■ Configuration Manager REST API

This document assumes they have basic knowledge of Linux operating systems.

Software version

This document applies to Block Storage Driver for OpenStack version 6.1.0 or later forQueens.

Document conventions

This document uses the following typographic conventions:

Convention Description

Bold ■ Indicates text in a window, including window titles, menus,menu options, buttons, fields, and labels. Example:

Click OK.■ Indicates emphasized words in list items.

Preface


Convention Description

Italic ■ Indicates a document title or emphasized words in text.■ Indicates a variable, which is a placeholder for actual text

provided by the user or for output by the system. Example:

pairdisplay -g group

(For exceptions to this convention for variables, see the entry forangle brackets.)

Monospace Indicates text that is displayed on screen or entered by the user.Example: pairdisplay -g oradb

< > anglebrackets

Indicates variables in the following scenarios:■ Variables are not clearly separated from the surrounding text or

from other variables. Example:

Status-<report-name><file-version>.csv

■ Variables in headings.

[ ] squarebrackets

Indicates optional values. Example: [ a | b ] indicates that you canchoose a, b, or nothing.

{ } braces Indicates required or expected values. Example: { a | b } indicatesthat you must choose either a or b.

| vertical bar Indicates that you have a choice between two or more options orarguments. Examples:

[ a | b ] indicates that you can choose a, b, or nothing.

{ a | b } indicates that you must choose either a or b.

This document uses the following icons to draw attention to information:

Icon Label Description

Note Calls attention to important or additional information.

Tip Provides helpful information, guidelines, or suggestions forperforming tasks more effectively.

Caution Warns the user of adverse conditions and/or consequences(for example, disruptive operations, data loss, or a systemcrash).

Document conventions

Preface


Icon Label Description

WARNING Warns the user of a hazardous situation which, if notavoided, could result in death or serious injury.

Release notes

Read the release notes before installing and using this product. They may containrequirements or restrictions that are not fully described in this document or updates orcorrections to this document.

Changes made in this revision

The following changes have been made to this document:■ The information about the port scheduler function was enhanced.

■ Red Hat OpenStack Platform 13 is now supported. For this reason, the deploymentprocedure was added to the following chapter: Installation and configuration (onpage 27) .

Referenced documents

The documents below are referenced in this document or contain more informationabout the features described in this document.

Hitachi Vantara documents

Hitachi Command Suite Configuration Manager REST API: REST API Reference Guide,MK-92HC229

Hitachi Virtual Storage Platform F1500 and Hitachi Virtual Storage Platform G1000,G1500: Provisioning Guide for Open Systems: Hitachi Virtual Storage Platform G1000, G1500,and F1500, MK-92RD8014

Hitachi Virtual Storage Platform F400, F600, F800 and Hitachi Virtual Storage PlatformG400, G600, G800: Provisioning Guide: Hitachi Virtual Storage Platform Gx00 and Fx00Models, MK-94HM8014

Hitachi Virtual Storage Platform F350, F370, F700, F900 and Hitachi Virtual StoragePlatform G350, G370, G700, G900: Provisioning Guide: Hitachi Virtual Storage Platform G/F350, G/F370, G/F700, G/F900, MK-97HM85026

Hitachi Vantara Support Connect, https://knowledge.hitachivantara.com/Documents

Release notes

Preface


https://knowledge.hitachivantara.com/Documents

Related documents

The documents below are related to this document or contain more information aboutfeatures described in this document.

Hitachi Vantara documents

Common to all storage systems: Thin Image User Guide: Hitachi Virtual Storage Platform Fseries and G series, MK-97HM85032

Hitachi Virtual Storage Platform F1500 and Hitachi Virtual Storage Platform G1000,G1500:■ System Administrator Guide: Hitachi Virtual Storage Platform G1x00 and F1500,

MK-92RD8016■ Hardware Guide: Hitachi Virtual Storage Platform G1000,G1500, and Hitachi Virtual

Storage Platform F1500, MK-92RD8007

Hitachi Virtual Storage Platform F400, F600, F800 and Hitachi Virtual Storage PlatformG400, G600, G800:■ System Administrator Guide: Hitachi Virtual Storage Platform Gx00 and Fx00,

MK-94HM8016■ Hardware Reference Guide: Hitachi Virtual Storage Platform F400, F600, MK-94HM8045■ Hardware Reference Guide: Hitachi Virtual Storage Platform F800, MK-94HM8046■ Hardware Reference Guide: Hitachi Virtual Storage Platform G200, MK-94HM8020■ Hardware Reference Guide: Hitachi Virtual Storage Platform G400, G600, MK-94HM8022■ Hardware Reference Guide: Hitachi Virtual Storage Platform G800, MK-94HM8026

Hitachi Virtual Storage Platform F350, F370, F700, F900 and Hitachi Virtual StoragePlatform G350, G370, G700, G900:■ System Administrator Guide: Hitachi Virtual Storage Platform G/F350, G/F370, G/F700, G/

F900, MK-97HM85028■ Hardware Reference Guide: Hitachi Virtual Storage Platform F350 and F370,

MK-97HM85016■ Hardware Reference Guide: Hitachi Virtual Storage Platform F700, MK-97HM85017■ Hardware Reference Guide: Hitachi Virtual Storage Platform F900, MK-97HM85018■ Hardware Reference Guide: Hitachi Virtual Storage Platform G350 and G370,

MK-97HM85012■ Hardware Reference Guide: Hitachi Virtual Storage Platform G700, MK-97HM85013■ Hardware Reference Guide: Hitachi Virtual Storage Platform G900, MK-97HM85014

OpenStack■ OpenStack Cloud Administrator Guide

■ OpenStack Command-Line Interface Reference

■ OpenStack Configuration Reference

Related documents

Preface


■ Red Hat OpenStack Platform Product Documentation

■ SUSE OpenStack Cloud Product Manual

■ Mirantis OpenStack Product Documentation

■ Ubuntu OpenStack Documentation

Conventions for storage capacity values

Physical storage capacity values (for example, disk drive capacity) are calculated basedon the following values:

Physical capacity unit Value

1 kilobyte (KB) 1,000 (103) bytes

1 megabyte (MB) 1,000 KB or 1,0002 bytes

1 gigabyte (GB) 1,000 MB or 1,0003 bytes

1 terabyte (TB) 1,000 GB or 1,0004 bytes

1 petabyte (PB) 1,000 TB or 1,0005 bytes

1 exabyte (EB) 1,000 PB or 1,0006 bytes

Logical capacity values (for example, logical device capacity, cache memory capacity) arecalculated based on the following values:

Logical capacity unit Value

1 block 512 bytes

1 cylinder Mainframe: 870 KB

Open-systems:■ OPEN-V: 960 KB■ Others: 720 KB

1 KB 1,024 (210) bytes

1 MB 1,024 KB or 1,0242 bytes

1 GB 1,024 MB or 1,0243 bytes

1 TB 1,024 GB or 1,0244 bytes

1 PB 1,024 TB or 1,0245 bytes

1 EB 1,024 PB or 1,0246 bytes

Conventions for storage capacity values

Preface


Getting help

Hitachi Vantara Support Connect is the destination for technical support of products andsolutions sold by Hitachi Vantara. To contact technical support, log on to Hitachi VantaraSupport Connect for contact information: https://support.hitachivantara.com/en_us/contact-us.html.

Hitachi Vantara Community is a global online community for Hitachi Vantara customers,partners, independent software vendors, employees, and prospects. It is the destinationto get answers, discover insights, and make connections. Join the conversation today!Go to community.hitachivantara.com, register, and complete your profile.

Comments

Please send us your comments on this document [email protected]. Include the document title and number, includingthe revision level (for example, -07), and refer to specific sections and paragraphswhenever possible. All comments become the property of Hitachi Vantara Corporation.

Thank you!

Getting help

Preface


https://knowledge.hitachivantara.com/



https://community.hitachivantara.com/welcome

https://community.hitachivantara.com/welcome

mailto:[email protected]

Chapter 1: Overview

Block Storage Driver for OpenStack is based on the OpenStack Block Storage architecture(Cinder) and it enables you to provide storage services that use high-performance andhigh-reliability Hitachi storage systems to build and deliver Infrastructure as a Service(IaaS).

System Configuration

A typical system configuration for Block Storage Driver for OpenStack contains the maincomponents shown in the figure below. This figure is an example of a multi-nodeconfiguration where the controller node and the compute nodes are configured ondifferent nodes.

Controller node

A server that manages cloud systems. The cinder-volume services run on this node.Install and use Block Storage Driver for OpenStack on this node.

Chapter 1: Overview


Compute node

A server managed by the controller node.

Configuration Manager REST API server

A server that receives REST API requests from Block Storage Driver for OpenStack, issuescommands to the storage system, and returns the execution results. The REST API servercan be installed independently or installed together as a part of the Hitachi CommandSuite.

Backend storage system

A storage system managed by Cinder. Block Storage Driver for OpenStack uses thin-provisioned volumes (DP-VOLs) from Hitachi Dynamic Provisioning (DP) pools as backendstorage. To use multiple DP pools, register each DP pool as a separate backend storagesystem.

LDEV

An individual logical data volume (on multiple drives in a RAID configuration) in a storagesystem.

Volume

Data unit managed by Block Storage Driver for OpenStack.

Supported Cinder functions

The following table lists the Cinder operations supported by Block Storage Driver forOpenStack.

Function Description

Create Volume Creates a volume.

Delete Volume1 Deletes a volume.

Attach Volume Connects a volume to a VM instance.

Detach Volume Disconnects a target volume from a VM instance.

Extend Volume Resizes a volume.

Create Snapshot2 Creates a snapshot that stores point-in-timedata.

Delete Snapshot Deletes a snapshot.

List Snapshot Lists snapshots.

Create Volume from Snapshot Creates a volume with the same content as thatof a snapshot.


Chapter 1: Overview



Create Volume from Image Retrieves image stored from Glance and loads itinto the specified volume. A VM can be startedbased on the stored image.

Create Volume from Volume (Clone) Creates a volume and then stores the data fromthe source volume.

Create Image from Volume Creates an image from a volume and uploadsthe image (Glance).

Volume Migration (host assisted)1 Moves a volume to another DP pool managed byanother storage system.

Consistency Group Consistency groups are used to group volumestogether for the purpose of data protection(snapshots, backups) and disaster recovery.

Over subscription Uses thin provisioning to manage the capacity ofthe storage system.

Volume Migration (storageassisted)1

Moves a volume to another DP pool.

Backup using temp Snapshot Uses a temporary snapshot or volume toperform non-disruptive backup. As a separatefeature, this function can be used to back upsnapshots. The Cinder backup service must berunning.

Multi-attach Support Simultaneously connects multiple hosts orservers to a volume.

Caution: It is the responsibility of theuser to ensure that a multiattach orclustered file system is used on thevolumes. Otherwise there may be ahigh probability of data corruption.

Backup Volume Backs up a volume to Swift. The Cinder backupservice must be running.

Restore Backup Restores data to a specified volume from Swift.The Cinder backup service must be running.

Revert to snapshot Reverts a volume to a previously taken snapshot.

Manage Volume Adds an LDEV created by a different OpenStacksystem to the volumes managed by Cinder.

Unmanage Volume Removes a volume created by Cinder fromCinder management.


Chapter 1: Overview



Retype Volume1 Changes the volume type.

Notes:

1. This function is not supported for volumes in a group.2. Snapshots are created using Thin Image (Snapshot).

Support for additional OpenStack operations

The following table lists the OpenStack operations supported by Block Storage Driver forOpenStack.

Table 1 OpenStack operations supported by Block Storage Driver for OpenStack

OpenStack operation Description

Live Migration Moves a volume managed by Block Storage Driverfor OpenStack and attached to a running VM fromone compute node to another.

Multipath for I/O path Multipath enabled for volumes managed by BlockStorage Driver for OpenStack.

High availability for Cindervolume services

You can use the high availability cluster software toset the cinder-volume service in a redundantactive-standby configuration. High availability is notsupported for SUSE OpenStack Cloud or MirantisOpenStack.

Fibre Channel Zone Manager When a volume managed by Block Storage Driverfor OpenStack is attached to a VM via FibreChannel, Fibre Channel zoning can automaticallybe created or deleted between the compute nodeand the storage system during a volume attach ordetach operation, respectively. See https://docs.openstack.org/mitaka/config-reference/block-storage/fc-zoning.html for how to specify settings.

Backend storage management configuration

Block Storage Driver for OpenStack uses thin-provisioned volumes (DP-VOLs) from DPpools as backend storage (a Hitachi storage feature that provides virtual volumecapability). To use multiple DP pools, register each DP pool as a separate backendstorage system. Each DP pool will be identified in the cinder.conf file.

Support for additional OpenStack operations

Chapter 1: Overview


https://docs.openstack.org/mitaka/config-reference/block-storage/fc-zoning.html



Volume operations

Block Storage Driver for OpenStack provides volume operation functions for managingLDEVs (logical devices or logical units) in the backend storage (DP pools). The figurebelow shows an overview of volume operations.

Figure 1 Overview of volume operations

Create and delete a volume

When Block Storage Driver for OpenStack receives the Cinder create volume request, itcreates a virtual volume (DP-VOL) as a logical device (LDEV) from the DP pool. DP-VOLsallow the storage to be provisioned on an as-needed basis. Volumes can be deleted byusing the Cinder delete volume command.

Extend a volume

Block Storage Driver for OpenStack allows you to resize the DP-VOL, ensuring that thevolume can be expanded to meet changing business requirements.

Note: You cannot expand DP-VOLs created by using Thin Image (Clone)during asynchronous copying or DP-VOLs that have pair volumes that werecreated by using Thin Image (Snapshot).

Volume operations

Chapter 1: Overview


Copy operations

When Block Storage Driver for OpenStack receives a Cinder copy volume request, BlockStorage Driver for OpenStack copies the volume in full by using Thin Image (Clone), andtakes a point-in-time snapshot of the volume by using Thin Image (Snapshot). Inaddition, snapshots for multiple volumes can be created by using a single command.This group of snapshots either guarantees or does not guarantee consistency,depending on the property of the group type to which the group belongs.

Figure 2 Snapshot operation example

Before you attempt to copy a volume attached to a VM, stop I/O on the VM.

The following table describes the copy methods available for Block Storage Driver forOpenStack. To perform copy operations, you will need a license for the Thin Imagesoftware product. A maximum of 1,024 clones and snapshots can be created for eachvolume.

Copy method Description

Thin Image (Clone) All data in the copy source volume (DP-VOL) isasynchronously copied to the destination volume. Bothvolumes can be used during the asynchronous copy.

Copy operations

Chapter 1: Overview


Copy method Description

Thin Image (Snapshot) Differential data with the copy destination volume isstored as needed in a virtual volume (V-VOLv2) as anLDEV. Both volumes can be used. Consistency groupscan also be copied. The virtual volume (V-VOLv2) canbe used in a cascade configuration.

Create a snapshot

Upon receiving a Cinder create snapshot request, Block Storage Driver for OpenStackcreates an LDEV linked to the snapshot, and then copies the snapshot data from thevolume to the LDEV by using one of the available copy methods (see the previous table).The snapshot cannot be attached to a VM, but it can be kept as a data backup.

Create a volume from a snapshot

Upon receiving a Cinder create volume from snapshot request, Block Storage Driver forOpenStack creates an LDEV linked to the volume, and then stores the specified snapshotdata in the LDEV by using one of the available copy methods (see the previous table). Youcan restore data by using the created snapshot.

Create a volume from a volume (clone)

Upon receiving a Cinder create volume from volume (clone) request, Block Storage Driverfor OpenStack creates an LDEV linked to the volume, and then stores the specifiedvolume data in the LDEV by using one of the available copy methods (see the previoustable). Volume cloning is useful when multiple users use the same data.

Restore a volume from a snapshot

If data in a volume is corrupted, the Cinder snapshot function restores the data bycreating a new volume from the snapshot. During this process, free space is temporarilyconsumed by the new volume and you must change the VM from the corrupted volumeto the newly created volume. By using the snapshot or volume restore operation, youcan restore the corrupted volume without having to create a new one.

Copy operations

Chapter 1: Overview


Figure 3 Snapshot and volume restore operation

Create or delete a group

Block Storage Driver for OpenStack enables you to create or delete a group of volumes.Deleting a group does not make changes to the backend storage if there are no volumesin the group. If you try to delete a group that has volumes in it by using cinderconsisgroup-delete --force or cinder group-delete --delete-volumes, thedriver deletes the LDEVs allocated to the volumes in the group.

Create a group from another group

You can create a group from another group. Block Storage Driver for OpenStack createsDP-VOLs in the backend storage and copies data from the volumes in the source groupto the volumes in the destination group. When data copy is complete, the driver updatesthe status of the destination group.

Create a group from a snapshot of another group

You can create a group from a snapshot of another group. Block Storage Driver forOpenStack creates DP-VOLs in the backend storage and copies data from the snapshotsof the source group to the volumes in the destination group. When data copy iscomplete, the driver updates the status of the destination group.

Note: Data consistency between source and destination groups is notmaintained even for groups that are consistency groups.

Copy operations

Chapter 1: Overview


Update a group

You can modify name and description of a group, as well as add or remove volumes to orfrom a group.

Create a snapshot of a group

You can create snapshots of multiple volumes by using a single command (cindercgsnapshot-create or cinder group-snapshot-create). These snapshots arecreated at the same point in time if the group is a consistency group. If the group is not aconsistency group, snapshots are created separately and the points in time at which thedata for each snapshot is created might differ.

Note:■ There are two methods for creating a consistency group. A group created

by using cinder consisgroup-create command is always a consistencygroup. A group created by using cinder group-create is a consistencygroup only if the consistent_group_snapshot_enabled property ofthe group type to which the group belongs is set to <is> True.

■ There are two types of group-related Cinder commands: CG commands(commands that begin with cinder consisgroup- or cindercgsnapshot-) and GVG commands (commands that begin with cindergroup-). It is not recommended to use CG commands. In the future, CGcommands will become obsolete and will no longer be supported. Inaddition, CG commands and GVG commands are not compatible with eachother. Snapshots created by using CG commands cannot be operated byusing GVG commands.

■ GVG-related commands require volume API version 3.20 or later (cinder--os-volume-api-version 3.20 or exportOS_VOLUME_API_VERSION=3.20).

■ openstack commands support CG-related operations, but do not supportGVG-related operations yet.

Volume attachment

Block Storage Driver for OpenStack supports storage attachment capability for storagesystems that use the following protocols: Fibre Channel, iSCSI, and Fibre Channel overEthernet. Block Storage Driver for OpenStack supports multipath configurations. Theport scheduler function is also supported. If this function is used, then, when volumesare attached, the active WWNs on the obtained compute nodes are distributed andregistered to the host groups of each port of the storage system. Volumes will beassigned based on this attachment information. The following figure shows an overviewof the volume attachment operations.

Volume attachment

Chapter 1: Overview


Figure 4 Volume attachment

Upon receiving a Cinder attach volume request, Block Storage Driver for OpenStackattaches a volume to a VM in the specified compute node. Block Storage Driver forOpenStack then directly connects the Hitachi storage system and the compute node.This allows the VM to access the attached volume to store data. The volume can also bedetached from the VM. The volume can be attached again to another VM. Block StorageDriver for OpenStack allows volume attach and detach operations in a multipathconfiguration.

Backup operations

You can use standard Cinder functions to back up or restore volumes created by BlockStorage Driver for OpenStack. Note that, if you restore a volume from external storageby using standard OpenStack functions, the metadata for the volume will be overwritten.To prevent this, perform the following procedure to restore a volume from externalstorage.

Procedure

1. Create a volume to which the data is to be restored. Note the LDEV metadata value,which can be acquired by using the cinder metadata-show command.

2. Restore the volume from external storage. If the volume ID of the restore target isnot specified, or if the specified volume ID is different from the backed-up volume,

Backup operations

Chapter 1: Overview


the type and LDEV metadata for the restore target volume will not be consistentwith the actual LDEV number.

3. Remove the metadata by using the cinder metadata command. Use the samecommand to restore the type and LDEV metadata values. For details about thiscommand, see the help messages or the Command-Line Interface Reference.

Manage and unmanage a volume

If you plan to move a volume from one OpenStack Cinder instance to another, you canuse the cinder manage and cinder unmanage commands. Specify source-id <LDEVNumber> in the --id-type option.

Volume migration

When Block Storage Driver for OpenStack receives a Cinder migrate volume request, avirtual volume (DP-VOL) is created as a logical device (LDEV) in the pool specified as themigration destination, and then the data on the source volume is copied.

When volumes are migrated within the same storage system, storage-assisted copyprocessing is performed. When volumes are migrated between different storagesystems, host-assisted copy processing is performed.

Manage and unmanage a volume

Chapter 1: Overview


Chapter 2: System requirements

This chapter describes the hardware and software necessary for using Block StorageDriver for OpenStack.

Operating systems

For details on the supported operating systems, see the Hitachi Block Storage OpenStackdriver support matrix at: https://support.HitachiVantara.com/en_us/interoperability.html.

OpenStack

For details on the supported OpenStack, see the Hitachi Block Storage OpenStack driversupport matrix at: https://support.HitachiVantara.com/en_us/interoperability.html.

Storage devices

For details on the supported storage systems, see the Hitachi Block Storage OpenStackdriver support matrix at: https://support.HitachiVantara.com/en_us/interoperability.html.

Storage firmware versions

The following table provides the Hitachi storage device firmware versions for each BlockStorage Driver for OpenStack version.

Table 2 Supported storage firmware versions

Storage model Firmware version

VSP F1500

VSP G1000, VSP G1500

80-05-43 or later

VSP F400, F600, F800

VSP G200, G400, G600, G800

83-04-43 or later

VSP F350, F370, F700, F900 88-01-04 or later



https://support.HitachiVantara.com/en_us/interoperability.html



Storage model Firmware version

VSP G350, G370, G700, G900

Software

This section describes the software required for each version of the Block Storage Driverfor OpenStack.

Prerequisite packages

The table below lists the prerequisite packages for Block Storage Driver for OpenStack.

Distribution Node Item Contents

SUSE Controllernode

Linuxenvironment

sysfsutils 1, sg3_utils 1, open-iscsi 2,multipath-tools 3

Computenode

Linuxenvironment

sysfsutils1, sg3_utils1, open-iscsi2,multipath-tools3

Ubuntu andMirantis

Controllernode

Linuxenvironment

sysfsutils1, sg3-utils1, open-iscsi2,multipath-tools3

Computenode

Linuxenvironment

sysfsutils1, sg3-utils1, open-iscsi2,multipath-tools3

Notes:

1. For configuring FC.2. For configuring iSCSI.3. For configuring multipath.

For other Hitachi driver specifications, see: https://www.HitachiVantara.com/en-us/products-solutions/application-solutions/hitachi-and-openstack.html.

For the supported storage platforms and the distribution releases, see: https://support.HitachiVantara.com/en_us/interoperability.html.

Storage management software

The following table shows the versions of Configuration Manager REST API that can beused to manage Hitachi storage devices.

Software



https://www.HitachiVantara.com/en-us/products-solutions/application-solutions/hitachi-and-openstack.html

https://www.HitachiVantara.com/en-us/products-solutions/application-solutions/hitachi-and-openstack.html



Table 3 Versions of Configuration Manager REST API

Storage model Version

VSP F1500

VSP G1000, VSP G1500

VSP F400, F600, F800

VSP G200, G400, G600, G800

8.5.4-00 or later

VSP F350, F370, F700, F900

VSP G350, G370, G700, G900

8.5.6-00 or later

Storage software licenses

The software licenses listed below are required on each storage device.■ Hitachi Storage Virtualization Operating System (SVOS)

● Hitachi LUN Manager software● Hitachi Dynamic Provisioning software

■ Hitachi Local Replication software (Hitachi Thin Image software)

■ Dedupe and compression (optional)

Software restrictions

Do not use Hitachi Dynamic Link Manager (HDLM) in controller nodes or compute nodes.Use DM-Multipath instead.

Storage software licenses



Chapter 3: Installation and configuration

This chapter describes how to install and configure Block Storage Driver for OpenStack.

Installation and setup workflow

This topic describes the workflow for preparing, installing and configuring Block StorageDriver for OpenStack.

Prepare for installation

1. Connect each nodes and the storage. See Connect nodes (on page 30) .2. Configure the node settings. See Configure node setting (on page 32) .3. Configure the node settings for storage resources used by Block Storage Driver for

OpenStack. See Configure storage resources (on page 33) .4. Install and configure the Configuration Manager REST API server. See Configure

Configuration Manager REST API server (on page 37) .

Deploy Block Storage Driver for OpenStack (Red Hat)

1. Deploy Block Storage Driver for OpenStack. See Deploy Block Storage Driver forOpenStack (Red Hat) (on page 38) .

2. Configure Block Storage Driver for OpenStack. See Initial setup (on page 43) .3. Verify the installation. See Verify Block Storage Driver for OpenStack installation (on

page 46) .

Install Block Storage Driver for OpenStack (SUSE/Mirantis/Ubuntu)

1. Check the required memory size and disk space, and verify the OpenStack packageinstallation. See Installation prerequisites (on page 41) .

2. Install Block Storage Driver for OpenStack. See Install Block Storage Driver forOpenStack (SUSE/Mirantis/Ubuntu) (on page 41) .

3. Configure Block Storage Driver for OpenStack. See Initial setup (on page 43) .4. Restart Block Storage Driver for OpenStack. See Restart Cinder (SUSE/Mirantis/

Ubuntu) (on page 45) .5. Verify the installation. See Verify Block Storage Driver for OpenStack installation (on

page 46) .



Supported configurations for Block Storage Driver forOpenStack

Hitachi recommends an active-standby cluster configuration of OpenStack controllernodes and the Configuration Manager REST API servers. The following figure illustratessuch a high-availability (HA) configuration.

The following table describes valid OpenStack system configurations.

Configuration Description

Single-controllerconfiguration

This configuration has a single controller node.

Active-standbyconfiguration

This configuration has multiple controller nodes. In thisconfiguration, only one node on which the cinder-volumeservice is running is an active node. The other nodes arestandby nodes. The storage system is shared amongst allnodes.

Note: Services other than the cinder-volume service can be used in an active-activeconfiguration in accordance with OpenStack recommendations.

The following table describes the valid system configurations of the ConfigurationManager REST API when used with Block Storage Driver for OpenStack.

Supported configurations for Block Storage Driver for OpenStack



Configuration Description

Single-serverconfiguration

This configuration has one Configuration Manager RESTAPI server. You can install the Configuration ManagerREST API on a controller node. For the prerequisites forinstalling the Configuration Manager REST API on acontroller node, see System Requirements for HitachiCommand Suite.

Active-standbyconfiguration

This configuration has multiple Configuration ManagerREST API servers. Only one server is an active server, andthe other servers are standby servers.

For details about high-availability cluster configurations of the Configuration ManagerREST API, see the Hitachi Command Suite Configuration Manager REST API ReferenceGuide.

Management software restrictions

Block Storage Driver for OpenStack does not lock storage systems. For this reason, ifstorage resources are also registered with another management software, an errormight occur due to management conflicts. To avoid such errors, you can use thefollowing parameters to specify resources that can be used by Block Storage Driver forOpenStack: hitachi_ldev_range to specify a range of LDEV IDs.

Do not use another management software to perform operations on the resourcesspecified by this parameter.

You can use Configuration Manager REST API to set up resource groups to configureaccess control on resources managed by various management software. For details, seethe description of resource groups in the Hitachi Command Suite Configuration ManagerREST API Reference Guide.

Environment setup

It is necessary to configure the storage device to allow Block Storage Driver forOpenStack to use it. Refer to the documentation provided with the storage device fordetails.

Management software restrictions



https://knowledge.hds.com/Documents/Management_Software/Configuration_Manager_REST_API




Connect nodes

Connect the controller nodes and compute nodes to the ports of the storage device. Thecompute nodes use the ports of the storage device as data paths. You can use BlockStorage Driver for OpenStack to manage both configurations in which controller nodesand compute nodes use the same ports of a storage device, and configurations in whichcontroller nodes and compute nodes use different ports. Design the connectionenvironment based on your operation policy.

The following figure shows a Fibre Channel (FC) connection example:

Figure 5 Connection example of node configuration

The ports of a storage device can be shared with other management software.

Single node configuration

Block Storage Driver for OpenStack allows single node configurations where a singleserver is configured to serve the role of the controller node and the compute node.There are a few operation restrictions to note for a single node environment. Theseoperations cause I/O disruptions and require you to detach a volume to perform theoperation, and reattach the volume.■ If a DP-VOL is attached, you cannot copy the volume to images.■ If a read-only volume is attached, you cannot create volumes for the original snapshot

for the volume.

Connect nodes



Controller node without I/O data paths

You can use the configuration on the Controller node without I/O data paths, as shown inthe following image. This configuration is a viable solution if you do not want to give upFibre Channel ports for management.

Figure 6 Connection example without I/O data paths for controller node

Use the following settings to configure the controller node without I/O data path.■ Specify the hitachi_compute_target_ports parameter.

■ Specify the hitachi_rest_pair_target_ports parameter.

■ Do not specify the hitachi_target_ports parameter for Block Storage Driver forOpenStack.

The following operations are not supported by the controller node without I/O datapaths:■ Perform a volume migration (host assisted)■ Create a volume from an image■ Create an image from a volume■ Back up a volume■ Restore a backup■ Retype a volume

Controller node without I/O data paths



Configure node setting

You can use the OpenStack configuration installer provided by each distribution to buildthe controller node and compute nodes beforehand. It is recommended to use a multi-node configuration in which the controller node and the compute node use separatedata paths. Some OpenStack configuration installers might require you to specify aCinder driver when deploying a Cinder component. When prompted, specify anotherdriver such as NFS (as you cannot select Block Storage Driver for OpenStack at this time)and install the Cinder driver after the deployment. Refer to online resources for theusage of OpenStack configuration installer provided by each distribution. After buildingthe controller node and the compute nodes, configure each node as described in thefollowing table.

Node Items Instruction

Controllernode

my_ip for cinder service

(/etc/cinder/cinder.conf)

Specify a unique value for the IPv4address for the management LANof the node.

Initiator IQN

(/etc/iscsi/initiatorname.iscsi)

Specify a unique value for theInitiator IQN. This item is for aniSCSI connection.

Computenode

my_ip for nova compute service

(/etc/nova/nova.conf)

Specify a unique value for the IPv4address for the management LANof the node.

Initiator IQN

(etc/iscsi/initiatorname.iscsi)

Specify a unique value for theInitiator IQN. This item is for aniSCSI connection.

About the communication mode of the Configuration Manager RESTAPI server

The Block Storage Driver for OpenStack uses Configuration Manager REST API server forstorage operations. The Block Storage Driver for OpenStack supports both in-band andout-of-band methods.

In the in-band management method, the Configuration Manager REST API serverconnects to the storage system through a SAN.

In the out-of-band management method, the Configuration Manager REST API serverconnects to the storage system through a LAN. This is the default communication modefor the Configuration Manager REST API server.

If the out-of-band method is used to connect the Configuration Manager REST API serverand the storage system, set the isSecure property to True to encrypt communicationsbetween the Configuration Manager REST API server and the storage system. For thesetting, see Changing the communication mode of the REST API server in HitachiCommand Suite Configuration Manager REST API Reference Guide.

Configure node setting





Note: The software used for internal processing has changed from CommandControl Interface (CCI) to Configuration Manager REST API in version 5. SeeUpdating the management parameters in the cinder.conf file (on page 48)for updating cinder.conf.

Configure storage resources

Common resources

The following table describes resource requirements for storage systems:

Resource type Contents

All resources All storage resources, such as DP pools and host groups, musthave a name in order for the driver to use them (name fieldscannot be left blank).

Resource groups If using a new resource group for exclusive use by an OpenStacksystem, create a new resource group, and assign the necessaryresources, such as LDEVs (including LDEVs for a commanddevice or pool), port, and host group (iSCSI target).

User accounts To access the storage system from the driver, you must createan account and be assigned to a user group with the followingroles:■ Storage Administrator (View Only)■ Storage Administrator (Provisioning)■ Storage Administrator (Local Copy)■ Storage Administrator (Performance Management)

The user groups have management privileges for the createdResource-Group. You can also use the built-in StorageAdministrator (View & Modify) user group.

DP Pool ■ Create a DP pool that is used by Block Storage Driver forOpenStack backend. The driver manages virtual capacity(capacity reserved for over-provisioning of the actual poolcapacity). However you can set the percentage of DP-VOLcapacity that can be created to the total capacity of the poolas the subscription limit. This can help prevent DP-VOLblocking caused by a full pool. For example, when thesubscription limit is set to 100%, the total DP-VOL capacity isequal to the DP pool capacity.

■ Use a pool that is not assigned to a virtual storage machine.You cannot use DP-VOLs that are assigned to a virtual storagemachine or volumes that have been migrated from anothersystem using nondisruptive migration.

Configure storage resources




TI pool If you want to create snapshots by using Thin Image (Snapshot)in a TI pool, create a TI pool.

Fibre Channel connectivity

The following table describes several Fibre Channel (FC) storage configurationrequirements.


Ports ■ Enable Port Security for the port used by the driver.■ To use the port scheduler function, enable fabric, and then

set Point to Point (P to P) for Connection Type.■ If you change the port configuration used by the driver for

connection, restart the openstack-cinder-volume service.If the volume is attached or detached without restarting theservice, the operation might fail.

Host group for I/Odata path

Manual configuration:■ Create a host group for the port that connects the controller

node and compute nodes. In a multipath configuration,create host group for all connecting ports.

■ For a multipath configuration, the LDEV numbers and theconnection order (LUN) must match within each host groupof the target node. If they do not match, change each LDEVconnection accordingly to match each LUN.

■ The host group must to be named HBSD-<target hostWWPN> (for example, HBSD-0123456789ABCDEF).

■ Specify HBSD-<target host WWPN> using the WWN of thesmallest WWPN used for the connecting node.

■ Register the WWN of the connecting node in the newlycreated host group.

■ If the host groups for a controller node and compute nodeare created, reboot the nodes to recognize these paths. If anew compute node is added and the host group for the nodeis created, reboot is necessary for only this node.

Fibre Channel connectivity




Automatic configuration:■ Automatically creating the host group requires the

hitachi_group_request parameter to be True. Inaddition, to add LDEVs to a host group being created at thesame time, Fibre Channel switches must be used to connectthe storage and the node, and the Fibre Channel ZoneManager must be enabled.

■ Upon a cinder volume attach request, the driverautomatically creates a host group for the VM port specifiedin hitachi_target_ports orhitachi_compute_target_ports if there is no host groupdefined for the port.

■ In the absence of existing host groups, the driverautomatically creates one when copying a volume using copyfunctions on the storage system. Do not manually create ordelete host names HBSD-pairXX (XX: number).

■ The driver creates host groups and registers all WWNs for allports specified in the hitachi_target_ports orhitachi_compute_target_ports parameter. Deleting hostgroups automatically requires the hitachi_group_deleteparameter to be set to True.

Fibre Channelzoning

Manual configuration:■ For Fibre Channel switches between a node and the storage

device, manually configure zoning.

Automatic configuration:■ When the driver attaches a volume to the target VM, Fibre

Channel Zone Manager automatically creates zoning betweenthe target node and the port used by the driver.

■ Fibre Channel Zone Manager must be enabled, andhitachi_zoning_request is True.

iSCSI connectivity

The following table describes several of the iSCSI storage configuration requirements.


Ports Enable port security for the ports used by the driver. Configurethe IP address and the TCP port number.

iSCSI connectivity




If you change the port configuration used by the driver forconnection, restart the openstack-cinder-volume service. Ifthe volume is attached or detached without restarting theservice, the operation might fail.

iSCSI target for I/Odata path

Manual configuration:■ Create an iSCSI target for the port that connects the

controller node and compute nodes. In a multipathconfiguration, create host group for all connecting ports.

■ The iSCSI target must be named HBSD-<my_ip> (for example,HBSD-10.20.30.40). Use the same IP address for my_ipthat you use for a cinder or nova compute service in eachnode.

■ Register the Initiator IQN of the connecting node in the newlycreated iSCSI target.

■ Register the Target IQN in the newly created iSCSI target. In amultipath configuration, register the same target IQN in alliSCSI targets connected to a node.

■ In a multipath configuration, make sure that the valuespecified in the hitachi_group_request parameter takeseffect. If you want to manually create an iSCSI target, use thestorage system management software to set 83 for the hostmode option.

■ If CHAP authentication is used, register the CHAP user nameand password with the iSCSI target. Use the same CHAP userand password for all iSCSI targets.

Automatic configuration:■ When the driver attaches a volume to a VM instance, the

driver automatically creates an iSCSI target for the VM portsthat are specified in hitachi_target_ports orhitachi_compute_target_ports if no SCSI target existsfor the ports.

■ In the absence of existing iSCSI targets, the driverautomatically creates one when copying a volume using copyfunctions on the storage. Do not manually create or deletethe iSCSI targets HBSD-pairXX (XX: number).

iSCSI connectivity




■ Automatic creation of iSCSI targets requires that thehitachi_group_request parameter is True. The drivercreates iSCSI targets and registers all Initiator IQNs for allports used by a node that are specified in thehitachi_target_ports orhitachi_compute_target_ports parameter. The driverregisters the target IQN "<Initiator IQN for the targetnode>.target" with the iSCSI targets.

■ Deleting iSCSI targets automatically requires the parameterhitachi_group_delete to be True.

Considerations for multipath configurations:■ For a multipath configuration, the LDEV numbers and the

connection order (LUN) must match within each iSCSI targetof the target node. If they do not match, change each LDEVconnection accordingly to match each LUN.

■ If the settings are automatic, the driver will use the smallestavailable iSCSI target number. Align the LUNs that are alreadybeing used for each port to force the LUNs created by thedriver to match.

Configure Configuration Manager REST API server

Use the procedure below to configure the Configuration Manager REST API server.

Procedure

1. Install the Configuration Manager REST API server.

For details, see installing the REST API in Hitachi Command Suite ConfigurationManager REST API Reference Guide.

2. Register information about the storage system to the Configuration Manager RESTAPI server.

For details, see Registering a storage system in Hitachi Command Suite ConfigurationManager REST API Reference Guide.

Configure Configuration Manager REST API server







Secure your storage system password

Your password file should be kept out of the file directories that are subject to datacollection for logs. Follow the procedure below to keep your password from being sharedwith unauthorized users.

Procedure

1. As a root user, create a password file using a text editor. For example:

File: /opt/hitachi/hbsd/rest_passwordPassword: !gh8M59Wz#

2. Confirm the password.

# cat /opt/hitachi/hbsd/rest_password!gh8M59Wz#

3. Hide the password file from all users except the Cinder group.

# sudo chgrp cinder /opt/hitachi/hbsd/rest_password# sudo chmod 640 /opt/hitachi/hbsd/rest_password

4. Specify the hitachi_rest_password_path parameter in the cinder.conf file(/etc/cinder/cinder.conf). For example,hitachi_rest_password_path=/opt/hitachi/hbsd/rest_password.

Note: Do not use the hitachi_rest_password parameter. Thehitachi_rest_password and hitachi_rest_password_pathparameters are mutually exclusive and using hitachi_rest_passwordwill conflict with the password file path you have added to thecinder.conf file.


In Red Hat OpenStack Platform 13 and later versions, RPM packages are no longerinstalled on controller nodes. Instead, Cinder components (including various drivers) aredeployed as a Docker image to create a virtual machine on which Cinder runs. As aresult, you can now use Block Storage Driver for OpenStack by deploying the containerimage of Block Storage Driver for OpenStack.

Use the openstack overcloud deploy command to deploy Block Storage Driver forOpenStack. For details on how to use this command, see the online documentation onthe Red Hat website.

Red Hat provides the following three deployment methods that acquire an image fromthe registry.■ Remote Registry■ Satellite Server■ Local Registry

Secure your storage system password



The procedure for each deployment method is different. For information about eachregistry (including how each registry is used), see the following Red Hat documentation:

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/13/html/keeping_red_hat_openstack_platform_updated/

The following is a sample deployment procedure that uses Remote Registry.

Procedure

1. Specify the container image of Block Storage Driver for OpenStack on the Red Hatwebsite.

Create a new custom_overcloud_images.yaml and set the Block Storage Driverfor OpenStack container image.

File: /home/stack/templates/custom_overcloud_images.yaml

parameter_defaults: DockerCinderVolumeImage: registry.connect.redhat.com/hitachi/rhosp13-openstack-cinder-volume-hbsd

The container image of Block Storage Driver for OpenStack is registered in thefollowing registry.

registry.connect.redhat.com/hitachi/rhosp13-openstack-cinder-volume-hbsd

2. Create an environment file for Block Storage Driver for OpenStack.

To apply the settings of Block Storage Driver for OpenStack to a Cinder componentduring deployment, create a new environment file (for example,custom_env.yaml) and then edit the file.

File: /home/stack/templates/custom_env.yaml

parameter_defaults: ControllerExtraConfig: cinder::config::cinder_config: VSPG1000/volume_driver: value: cinder.volume.drivers.hitachi.hbsd.hbsd_fc.HBSDFCDriver VSPG1000/hitachi_pool: value: 13 VSPG1000/hitachi_rest_user: value: HBSD_USER VSPG1000/volume_backend_name: value: VSPG1000 VSPG1000/hitachi_rest_password: value: password VSPG1000/hitachi_target_ports: value: CL1-E, CL2-E VSPG1000/hitachi_storage_id: value: 834000400003 VSPG1000/hitachi_rest_api_ip:






value: 172.16.18.108 cinder_user_enabled_backends: ['VSPG1000']

For information on how to set the environment file, see the following Red Hatdocumentation:

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/13/html/custom_block_storage_back_end_deployment_guide/

3. Deploy the container image.

Run the openstack overcloud deploy command to deploy the components.When you run the command, specify the following environment setting files:custom_overcloud_images.yaml and the environment file that you created instep 2.

# openstack overcloud deploy \--template -e /home/stack/templates/overcloud_images.yaml \-e /home/stack/templates/custom_overcloud_images.yaml \-e /home/stack/templates/custom_env.yaml ...

For information on the specifications of the openstack overcloud deploycommand and information on the deployment methods, see the following Red Hatdocumentation:

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/13/html/director_installation_and_usage/









Installation prerequisites

The installation prerequisites for Block Storage Driver for OpenStack are listed below.■ Verify that you have sufficient memory on the server. The physical memory size

required by the software is: 1 MB x the number of backends x 2.■ Verify that you have sufficient disk space required to install the driver. The following

table describes the required disk space.

Item Size Location

Block Storage Driver for OpenStack file 1 MB <PATH> /usr/share/pyshared/hitachi-hbsd

rootwrap file 1 MB /etc/cinder/rootwrap.d/

sudo file 1 MB /etc/sudoers.d

hbsdgetinfo 1 MB /opt/hitachi/hbsd/

Log files 1 MB <PATH> /var/log/hbsd/

■ Check the OpenStack package installation for any missing or invalid packages (seeSoftware (on page 25) ). Use the rpm command with the -V option specified (debsumsfor Ubuntu) to confirm that these packages are installed and are in a normal state. If apackage is not installed or an invalid package is found, install the package again.

Block Storage Driver for OpenStack installation for SUSE

Use the rpm command to install Block Storage Driver for OpenStack. You must log in as asuperuser (root) on the controller node where you want to perform the installation. Fordetails about how to use the rpm command, see the online documentation on the Linuxwebsite.

Procedure

1. Use the mount command to mount the CD file system when installing from a CD:

# /bin/mount -r -o mode=0544 /dev/cdrom /media

2. Before installing the driver, stop the Cinder volume service.

# /sbin/service openstack-cinder-volume stop

3. After the service is stopped, run the rpm command to install the driver. Install theappropriate RPM package for your OpenStack environment. The following table




shows the Block Storage Driver for OpenStack RPM package for each supportedOpenStack distribution.

RPM package name RPM storage directory

hbsd.6.1.0-0_11.0.noarch.rpm RPMS/noarch

An example of installing Block Storage Driver for OpenStack:

# /bin/rpm -ivh /media/RPMS/noarch/<RPM package name>

4. After the installation is completed, use the umount command to unmount the CD.

# /bin/umount/media

Block Storage Driver for OpenStack installation for Mirantis andUbuntu

Use the dpkg command to install Block Storage Driver for OpenStack. You must log in asa superuser (root) on the controller node where you want to perform the installation. Fordetails about how to use the dpkg command, see the Mirantis or Ubuntu onlinedocumentation.

Procedure

1. Use the mount command to mount the CD file system when installing from a CD:

# /bin/mount -r -o mode=0544 /dev/cdrom /media

2. Before installing the driver, stop the cinder-volume service.

# /usr/sbin/service cinder-volume stop

3. After the service is stopped, run the dpkg command to install the driver. Thefollowing table shows the DEB package for each supported OpenStack distribution.

DEB package name DEB storage directory

hbsd-6.1.0-0-11.0_all.deb DEBS/all

An example of installing Block Storage Driver for OpenStack:

# /usr/bin/dpkg -i /media/DEB/UBUNTU/all/<DEB package name>

4. After the installation is completed, use the umount command to unmount the CD.

# /bin/umount/media

Block Storage Driver for OpenStack installation for Mirantis and Ubuntu



Initial setup

Add a Block Storage Driver for OpenStack configuration (SUSE/Mirantis/Ubuntu)

Normally, a Block Storage Driver for OpenStack configuration is added to theconfiguration file /etc/cinder/cinder.conf provided by an openstack-cinderpackage. However, some OpenStack configuration installers might automatically changethe configurations of cinder.conf by running configuration management softwaresuch as Puppet. This topic describes additional necessary preparation steps and how toadd the Block Storage Driver for OpenStack configuration, which vary depending onwhich OpenStack configuration installer you use.

Using Crowbar (SUSE OpenStack Cloud)

A Chef agent runs on the controller node when an OpenStack environment is built withCrowbar. Chef resets cinder.conf for the controller node, and any configuration youhave built in the driver will be lost. To resolve this issue, follow the procedure below toadd your driver configuration to the Add New Cinder Backend page in the CrowbarWebGUI.

Procedure

1. Launch the WebGUI of Crowbar, and select OpenStack in the Barclamps menu.2. Select Edit in Cinder.3. Select Other Driver in the Type of Volume menu in the Add new Cinder Backend

field. Click Add Backend to enter the name of the backend.4. Enter the driver path in the Driver field and the parameters in the Options field for

the backend you have added.5. In the Deployment field, specify the controller node (only one selectable) in the

cinder-controller field. And specify the backend(s) in the cinder-volume field.6. Click Apply to save the configuration.

Using FUEL (Mirantis OpenStack)

To configure Block Storage Driver for OpenStack using Mirantis OpenStack, edit theconfiguration file (/etc/cinder/cinder.conf) on the controller node.

Using MAAS (Ubuntu OpenStack)

To configure the driver using Ubuntu, edit the configuration file (/etc/cinder/cinder.conf) on the controller node.

Linking a volume type and a backend

For creating an environment with multiple backends, you can create a volume type andlink it to a particular backend.

Initial setup



You can configure the backend specification (volume_backend_name) during backendsetup by using the cinder command in the controller node where a Cinder client isinstalled.

# /usr/bin/cinder type-create <volume type name> # /usr/bin/cinder type-key <volume type name> set volume_backend_name=<volume backend name>

The following commands show an example of creating a volume type calledHBSD_SAMPLE1 and linking it to the backend hbsd_backend1.

# /usr/bin/cinder type-create HBSD_SAMPLE1 # /usr/bin/cinder type-key HBSD_SAMPLE1 set volume_backend_name=hbsd_backend1

Use the cinder extra-specs-list command to check the volume type you createdand the value registered for the volume_backend_name key.

Edit cinder.conf (SUSE/Mirantis/Ubuntu)

A driver configuration is added using the OpenStack configuration installer provided bythe distribution in use (see Add a Block Storage Driver for OpenStack configuration(SUSE/Mirantis/Ubuntu) (on page 43) ). This topic describes how to edit the configurationfile /etc/cinder/cinder.conf provided by the openstack-cinder package.

Specify the driver settings in the configuration file /etc/cinder/cinder.conf. Youneed to manually update the configuration file with values that reflect the latest storageconfiguration. Specify "parameter=value" pair per line in the following format:

parameter=value

Edit cinder.conf (SUSE/Mirantis/Ubuntu)



Specify the driver-specific parameters and Cinder-provided parameters for eachbackend. An example Block Storage Driver for OpenStack configuration is shown below,followed by the description of each section of the file. For details about the parameters,see Parameters (on page 62) .

# cinder.conf sample #[DEFAULT]: (Omitted)enabled_backends=VSPG1000logging_context_format_string=%(asctime)s.%(msecs)03d % (process)d %(thread)s%(levelname)s %(name)s [%(request_id)s %(user_identity)s] % (instance)s%(message)s: (Omitted)[VSPG1000]volume_driver=cinder.volume.drivers.hitachi.hbsd.hbsd_fc.HBSDFCDrivervolume_backend_name=hbsd_backend1suppress_requests_ssl_warnings=Truehitachi_storage_id=800000054321hitachi_pool=0hitachi_thin_pool=1hitachi_rest_api_ip=192.0.2.100hitachi_rest_user=userhitachi_rest_password_path=/opt/hitachi/hbsd/rest_passwordhitachi_target_ports=CL1-A,CL2-Ahitachi_compute_target_ports=CL1-B,CL2-B

Note:■ If you want to share a port between multiple backends in a multipath

configuration, specify the same port name for all the ports used by thebackends. If the same port name is specified for only some of thebackends, volume-connection operations might fail.

■ If you use the Configuration Manager REST API server's default serverauthentication, set suppress_requests_ssl_warnings=True.

■ If you use attach operations for multiple volumes, it is recommended thatyou set rpc_response_timeout to a larger value.

Restart Cinder (SUSE/Mirantis/Ubuntu)

To complete the configuration, use the cinder command to restart the cinder-volumeservice.

Restart Cinder (SUSE/Mirantis/Ubuntu)



Run the following commands to restart the cinder-volume service.■ For SUSE, use the service command:

# /sbin/service openstack-cinder-volume restartCurrently stopped openstack-cinder-volume: [ OK ]Currently starting openstack-cinder-volume: [ OK ]

■ For Ubuntu and Mirantis, use the service command:

# /usr/sbin/service cinder-volume restartCurrently stopped cinder-volume: [ OK ]Currently starting cinder-volume: [ OK ]

Verify Block Storage Driver for OpenStack installation

This topic describes the methods that you can use to verify installation and configurationof Block Storage Driver for OpenStack.

Procedure

1. After the Cinder service restarts, make sure that Block Storage Driver for OpenStackis available for use by verifying the following.

■ The message MSGID0003-I is output to the following log file.

Red Hat OpenStack Platform: /var/log/cinder/volume.logSUSE OpenStack Cloud, Mirantis OpenStack, and Ubuntu OpenStack, for eachbackend that has been set: /var/log/cinder/cinder-volume.log

# /bin/grep MSGID0003-I /var/log/cinder/volume.log2014-03-10 11:34:05.564 28060 WARNING cinder.volume.drivers.hitachi.hitachi_common [req-c9c94628-988a-4bcb-8c6d-ac48910e5052 None None] MSGID0003-I: The storage backend can be used. (config group: VSP G1000)

■ The host status for the specified backend is up by using the cinder service-list command as shown in the example. The verified backend(s) can be usedfor volume operations. If the message is not output, review and update theconfiguration file.

Verify Block Storage Driver for OpenStack installation



2. Verify that the following volume operations can be performed from the Horizonportal:

■ Create a volume

■ Delete a volume

■ Attach a volume

■ Detach a volume

■ Create a Snapshot

■ Delete a Snapshot

■ Create a volume from Snapshot

If any of these volume operations fail, check the error messages output to theOpenStack Cinder log file.

Update the Block Storage Driver for OpenStack

Update the Block Storage Driver for OpenStack software for Red Hat

You can update the container image by running the commands openstack overcloudupdate prepare and run. In the same way as in the procedure to deploy Block StorageDriver for OpenStack, run the following command with the environment file for BlockStorage Driver for OpenStack specified.

# openstack overcloud update prepare \--templates -e /home/stack/templates/overcloud_images.yaml \-e /home/stack/templates/custom_overcloud_images.yaml \-e /home/stack/templates/custom_env.yaml

For a detailed update procedure, see the following Red Hat documentation:

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/13/html/keeping_red_hat_openstack_platform_updated/assembly-updating_the_overcloud

Update the Block Storage Driver for OpenStack software for SUSE

Use the procedure described below to update the driver software.

Procedure

1. Stop the cinder-volume service.


Update the Block Storage Driver for OpenStack





2. After the service has stopped, install a new version of the driver as shown below.The following table provides the information about the RPM packages andsupported OpenStack versions.

# /bin/rpm -Uvh /media/RPM-storage-directory/RPM-package-name

For the RPM package name and RPM storage name, see Block Storage Driver forOpenStack installation for SUSE (on page 41) .

Update the Block Storage Driver for OpenStack software for Mirantisand Ubuntu

Use the procedure described below to update the driver software for Mirantis andUbuntu.

Procedure



2. After the service stops, run the dpkg command to install the driver.

For the DEB package name and DEB storage name, see Block Storage Driver forOpenStack installation for Mirantis and Ubuntu (on page 42) .

Updating the management parameters in the cinder.conf file

The software used for internal processing was updated from CCI to ConfigurationManager REST API in Block Storage Driver for OpenStack version 5.0. If you are updatingfrom a version earlier than Block Storage Driver for OpenStack version 5.0, you mustupdate the parameters in the cinder.conf file.

Procedure

1. Uninstall the Command Control Interface.2. Modify the parameters in the cinder.conf file according to the table below. For

details on editing the cinder.conf file, see Edit cinder.conf (SUSE/Mirantis/Ubuntu) (on page 44) . For details on each parameter, see Parameters (onpage 62) .

Old Parameter New Parameter

hitachi_storage_id The format of this parameter value haschanged.

hitachi_horcm_numbers hitachi_rest_numberThe format of this parameter value haschanged.

Update the Block Storage Driver for OpenStack software for Mirantis and Ubuntu



Old Parameter New Parameter

hitachi_horcm_user hitachi_rest_user

hitachi_horcm_password orhitachi_horcm_password_path

hitachi_rest_password orhitachi_rest_password_path

hitachi_horcm_add_conf Delete this parameter.

hitachi_horcm_name_only_discovery

hitachi_rest_name_only_discovery

hitachi_horcm_disable_io_wait hitachi_rest_disable_io_wait

hitachi_horcm_pair_target_ports hitachi_rest_pair_target_ports

None Add this parameter:hitachi_rest_api_ip

3. Prepare the Configuration Manager REST API. See Configure Configuration ManagerREST API server (on page 37) .

4. Install the Block Storage Driver for OpenStack. See Update the Block Storage Driverfor OpenStack (on page 47) .

Uninstall Block Storage Driver for OpenStack (SUSE/Mirantis/Ubuntu)

Follow the procedure below to uninstall the driver.

Procedure


■ For SUSE:


■ For Ubuntu and Mirantis:


2. Uninstall the driver.

■ For SUSE:

# /bin/rpm -e hbsd


# /usr/bin/dpkg -purge hbsd

Uninstall Block Storage Driver for OpenStack (SUSE/Mirantis/Ubuntu)



Live migration

The Cinder live migration capability allows you to migrate a VM to another host forhardware maintenance and other purposes without disrupting workloads. See onlinedocumentation such as OpenStack Cloud Administrator Guide for details about the livemigration function on Nova components and the usage of the OpenStack configurationinstaller provided by the distribution in use.

When you perform live migration using Block Storage Driver for OpenStack, follow theseguidelines:■ Configure DM-Multipath in compute node by editing the configuration file (for

example, /etc/multipath.conf) and then restarting the multipath daemon. SeeConfigure multipathing (on page 50) .● user_friendly_names is set to "no"

● find_multipaths is set to "no"

DM-Multipath is required for performing live migration for both single and multipathconfigurations.

Note: Volume migration finishes even if it fails to delete the LDEV of theoriginal volume. In this case, delete it manually because the LDEV of theoriginal volume remains in storage.

Configure multipathing

Redundant I/O data paths to the storage device enable continuous operations when oneof the paths fails. Device mapper multipathing (DM-Multipath) provides path redundancyin OpenStack as illustrated in the figure in Connect nodes (on page 30) .

DM-Multipath creates and attaches a multi-path device (dm-X) to the VM.

The details of multipath configuration for controller and compute nodes are describedbelow. See Cinder-specific parameters (on page 75) for the parameter details. Inaddition, see the Linux website for documentation on setting up DM-Multipath.

Controller nodes:■ Set True for the use_multipath_for_image_xfer parameter.

■ Configure DM-Multipath for the port in the Block Storage Driver for OpenStackparameter hitachi_target_ports and hitachi_compute_target_ports.

■ Start multipath daemon after configuring the DM-Multipath setting.

Compute nodes:■ Set True for the volume_use_multipath parameter. List this parameter in the

libvirt section in the Nova configuration file.■ Start the multipath daemon after configuring the DM-Multipath setting.

Live migration



Note:■ The recommended value for the DM-Multipath varies depending on the

storage device. Refer to multipath configuration guidelines of your storagedevice.

■ Configure the live-migration parameters to use live migration (see Livemigration (on page 50) ).

■ Attach or detach volume operation of the volume may fail when one of theiSCSI paths fails. However, VMs that the volume is attached to can be usedwith the other path.

Configure high availability

High availability overview

You can configure multiple controller nodes in a cluster to ensure high availability. If onenode fails, the system falls over to another node to continue operations without anydisruption to the workloads. Each service can select active-standby or active-activeconfiguration with Pacemaker.

However, active-standby is the only controller-node fail-over configuration supported byBlock Storage Driver for OpenStack.

Pacemaker configurations for Cinder volumes

Block Storage Driver for OpenStack supports only active-standby configuration forCinder volumes, and fencing actions reboot when the system fails over. To allow this,configure Pacemaker parameters for cinder volumes as described in the following table.

Parameter Value

monitor fencing

stop fencing

start fencing

start-delay 10s

clone-set Delete this item

Configure the Pacemaker configuration using the pcs commands. You can reconfigurenode behaviors after the node has been rebooted.

Configure high availability



Build high availability environment of controller node

For information on how to build high availability environment, see the following Red Hatdocumentation:

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/13/html/understanding_red_hat_openstack_platform_high_availability/

Recoverable failures

When the system detects a storage control path failure that causes the Cinder volumeservice to abend, it switches the failed component to the normal one to continue theoperations. Other types of failures might not be detected and as a result the Cindervolume service becomes unavailable.

When the failed system switches over, the node associated with the failed system willreboot. During the reboot, all services on the node will become unavailable. You canreconfigure the node behaviors after it has been rebooted. If you reconfigure the nodeto be added back to the cluster, the Active-Active services can be used as Active again.

Note:

If the failed node is recovered and you want to switch the service back to therecovered node, make sure that there are no running snapshot volumes onthe failover node by using the cinder snapshot-list volume commandbefore you switch the node back.

Handling HA post-failover

When a controller node fails while storage operations are in progress, the operationtarget volumes might be left unprocessed in the storage. This may cause otheroperations that are involved with these resources to fail. Follow the procedure listedbelow to determine the correct actions.

Procedure

1. Check Pacemaker logs for the failover status and the time it has occurred.2. If the failover caused Cinder volume processing to stop, use the cinder list

command to find the volumes or snapshot being processed.3. If the status of a volume is "creating" then go to step 4. Otherwise, perform the

following steps:a. Get the metadata of the volume or the snapshot by using the cinder

metadata-show command and identify the LDEV number.

b. Find out the storage operation from the volume status.c. Based on the obtained LDEV number, in the storage system management

software, ensure that the volume is restored to the status it was in before theoperation.

d. Change the status for the corresponding entry on CinderDB to "available" usingthe cinder reset-state command.

e. Go to step 6.

Build high availability environment of controller node





4. Identify the incomplete volume processing from the file volume.log or debug.log(for Red Hat, the file hbsd_debug.log) around the time when the failover occurred.

5. Check whether any LDEV is associated with the volume. If no LDEV is associated, goto the following step d. If an LDEV is associated, perform the following steps:

a. Obtain the pair information from the LDEV ID by using the managementsoftware. If a pair exists, delete it.

b. If the LDEV is mapped to a host group or an iSCSI target, disable the mapping.c. Delete the LDEV by using the storage management software.d. Change the state of the volume to "available" using the cinder reset-state

command and delete the corresponding entry on CinderDB using the cinderdelete command.

6. If there are any other volumes with incomplete processing, repeat steps 3 through5.

Handling HA post-failover



Chapter 4: Hitachi extended functions

This section provides details and examples for using the extended storage operationcapabilities provided by Hitachi storage devices.

Copy methods

When cloning volumes or creating snapshots, you can choose from one of the two copymethods, Thin Image (Clone) and Thin Image (Snapshot), provided by storage systems.When creating snapshots, the copy method is set to Thin Image (Snapshot). Thefollowing table describes which copy method is used under each setting. The copymethod is selected by the hitachi_default_copy_method parameter and thecopy_method metadata for the destination volume. For example, setting pattern 1indicates that Thin Image (Clone) is used when you clone a volume if thehitachi_default_copy_method parameter is set to FULL and the copy_methodmetadata is not set.

Table 4 Copy methods used in volume data copy

Item Value

Setting Pattern

1 2 31 41 5 61 7 8 91 10

Settings Operation Create volumefrom volume(clone) or createvolume fromsnapshot

T T T T T T F T T F

Createsnapshot

F F F F F F T F F T

Copysource

Volume orsnapshot

T T T T T T T F F F

Group or groupsnapshot

F F F F F F F T T T

hitachi_default_copy_methodparameter

FULL T T T F F F F T F F

THIN F F F T T T F F T F

FULL or THIN F F F F F F T F F T



Item Value

Setting Pattern

1 2 31 41 5 61 7 8 91 10

copy_methodmetadata

Not set T F F T F F F T2 T2 F

FULL F T F F T F F F F F

THIN F F T F F T F F F F

FULL or THIN F F F F F F T F F T

Selected copymethod

Thin Image(Clone)

T T F F T F F T F F

Thin Image(Snapshot)

F F T T F T T F T T

Legend:■ T: True■ F: False

Note:

1. Creating volumes by using Thin Image (Snapshot) is not recommended because ofthe following: You cannot delete source volumes or snapshots without deletingthe destination volumes, and you cannot extend or unmanage source volumes,source snapshots, or destination volumes.

2. You cannot set copy_method metadata because all processing (creation of thedestination volumes and data copy) takes place in the program before destinationvolumes become available.

Copy methods



Note:■ Do not set or change metadata other than copy_method.

■ You can use Thin Image (Snapshot) in cascade configurations. You canconnect up to 64 levels.

■ When using Thin Image (Snapshot) in a cascade configuration, you cannotdelete any intermediary volumes. To delete an intermediary volume, youfirst must delete all volumes under the target volume.

■ For the following storage system models, if you use Thin Image (Clone) tocopy data to a volume of a different size, after asynchronous copy isperformed, the volume is expanded. For this reason, processing mighttake longer than the time required to copy to a volume of the same size.

- VSP F1500

- VSP G1000

- VSP F400, F600, F800

- VSP G200, G400, G600, G800

The following describes the differences between the two types ofprocessing:

- Cloning volumes of the same size: (volume creation process) +(initialization of asynchronous copy process)

- Cloning volumes of different sizes: (volume creation process) +(initialization of asynchronous copy process) + (asynchronous copycompletion wait time) + (volume capacity extension process)

■ By using Thin Image (Clone), you can repeat the data copy operation forthe target volume while it is being copied. You can repeat the operation upto three times. The fourth time will cause an error.

Copy methods



Maximum number of copy pairs and consistency groups

The maximum number of Thin Image pairs that can be created for each LDEV assignedto a volume (or snapshot) is restricted as shown in the following table. If the number ofpairs exceeds the maximum, copy operations will not be executed successfully.

Max. copy pairs pervolume

Max. copy pairs perstorage system

Max. copy pairs perconsistency group

Max. consistencygroups per storage

system

1,024 The number ofports used by thedriver x 1,024

8,192* 2,048*

Note:

* Including the number of pairs or consistency groups that are not created by using thedriver.

Port assignment using extra specs

Defining particular ports in the Hitachi-supported extra spec hbsd:target_portsdetermines which of the ports specified in the hitachi_target_ports or thehitachi_compute_target_ports parameters are used to create LUN paths duringvolume attach operations for each volume type.

The following example shows how to use commands to specify ports in the extra specs.If you want to add a new port, specify a different volume type.

Note: Use a comma to separate multiple ports.

Maximum number of copy pairs and consistency groups



Port scheduler

You can use the port scheduler function to reduce the number of WWNs, which arestorage system resource.

In Block Storage Driver for OpenStack, if host groups are created automatically, hostgroups are created for each compute node or VM (in an environment that has a WWN foreach VM). If you do not use the port scheduler function, host groups are created and thesame WWNs are registered in all of the ports that are specified for the parameterhitachi_compute_target_ports or for the parameter hitachi_target_ports. ForHitachi storage devices, a maximum of 255 host groups and 255 WWNs can be registeredfor one port. When volumes are attached, the upper limit on the number of WWNs thatcan be registered might be unexpectedly exceeded.

The figure below shows an example of automatically created host groups.

For the port scheduler function, when the cinder-volume service starts, the FibreChannel Zone Manager obtains the WWNs of active compute nodes and of active VMs.When volumes are attached, the WWNs are registered in a round-robin procedure, in thesame order as the order of ports specified for the parameterhitachi_compute_target_ports or for the parameter hitachi_target_ports.

If you want to use the port scheduler function, set the hitachi_port_schedulerparameter. For details about the parameter, see Block Storage Driver for OpenStackspecific parameters (on page 62) .

The figure below shows an example of host groups created from the port scheduler.

Port scheduler



Note:■ Fibre Channel is supported. For details about ports, see Fibre Channel

connectivity (on page 34) .■ If a host group already exists in any of the ports specified for the

parameter hitachi_compute_target_ports or for the parameterhitachi_target_ports, no new host group will be created on thoseports.

■ Restarting the cinder-volume service re-initializes the round robinscheduler as specified in the parameterhitachi_compute_target_ports or for the parameterhitachi_target_ports.

■ The port scheduler function divides up the active WWNs from each fabriccontroller and registers them to each port. For this reason, the number ofWWNs registered may vary from port to port.

Data deduplication and compression

Deduplication and compression (dedupe/comp) is a method of improving storageutilization by data reduction. Once your storage administrator has enabled dedupe/comp for the DP pool, you can create or delete system data volumes for use withdeduplication and compression.

Data deduplication and compression



For details, see Capacity saving function: data deduplication and compression in theProvisioning Guide for the applicable storage system, as listed in Referenced documents(on page 9) .

Enabling deduplication and compression

Enabling dedupe/comp functionality

To use the dedupe/comp function, your storage administrator must first enable thededupe/comp function for the DP pool. For details on how to enable this setting, see thedescription of pool management in the Hitachi Command Suite Configuration ManagerREST API Reference Guide.

Note:

Configure the virtualization-excess ratio to be unlimited. If you want to setsome other value for the virtualization-excess ratio, keep in mind that thecapacity of the system data volume is 40 TB.

Creating a volume with dedupe/comp enabled

To create a volume with the dedupe/comp setting enabled, you need to enable dedupe/comp for the relevant volume type.

Procedure

1. To enable the dedupe/comp setting, specify deduplication_compression forhbsd:capacity_saving in the extra specs for the volume type.The example below shows how to enable the dedupe/comp function for volumetype VSP-G1500-1.

2. When creating a volume of the volume type created in the previous step, you cancreate a volume with the dedupe/comp function enabled.

The example below shows how to create a volume (10 GB) with the dedupe/compfunction enabled, where the volume type is VSP-G1500-1.

Enabling deduplication and compression





Deleting a volume with dedupe/comp enabled

The cinder delete command finishes when the storage system starts the LDEVdeletion process. The LDEV cannot be reused until the LDEV deletion process iscompleted on the storage system.

Deleting a volume with dedupe/comp enabled



Chapter 5: Parameters

This section provides syntax for both Block Storage Driver for OpenStack-specificparameters and the Cinder-specific parameters. See the example configuration file inEdit cinder.conf (SUSE/Mirantis/Ubuntu) (on page 44) .

Block Storage Driver for OpenStack specific parameters

The table below describes parameters specific to Block Storage Driver for OpenStack,which are specified in the backend section of the following configuration file.■ For Red Hat: The environment file for configuring Block Storage Driver for OpenStack

(example: custom_env.yaml)

For information on how to set the environment file, see the following Red Hatdocumentation.


■ For SUSE/Mirantis/Ubuntu: cinder.conf

Parameter

Requiredor

optionalDefaultvalue Description

hitachi_storage_id Required None Specifies the storage deviceID (12 digits) registered onthe REST API server.

Storage device ID: fixed valueper device type (6 digits) +serial number (6 digits)

If the serial number hasfewer than 6 digits, addzeroes (0) to the front of theserial number.

hitachi_storage_cli Required REST If you specify REST, theConfiguration Manager RESTAPI is used for all storage-system operations.





Parameter

Requiredor


If you are using a VSP F350,F370, F700, F900 or VSP G350,G370, G700, G900 storagesystem, specifySIMPLE_REST. API requeststhat get information in asimple format and those thatreturn responses at a highspeed are used whenvolumes are attached orwhen volumes are created (asclones or snapshots). Youcannot specify thehitachi_ldev_rangeparameter.

hitachi_pool Required None Specifies the ID (integer) orthe name of the DP pool thatstores LDEVs for volumes (orsnapshots). Do not use theDP pool specified forhitachi_pool for otherpurposes.

hitachi_thin_pool Optional None If you use the TI pool forcreating snapshots, specifiesthe ID (integer) or the nameof the TI pool that storesLDEVs for volumes orsnapshots. If you omit thisparameter, the snapshotscreated by using Thin Image(Snapshot) are stored in thepool specified forhitachi_pool.




Parameter

Requiredor


hitachi_ldev_range Optional None Specifies a range of usableLDEV numbers in the<integer-value-1> -<integer-value-2> format.The value of <integer-value-1> must be equal toor smaller than the value of<integer-value-2>. If novalue is specified, one of thefollowing ranges applies: (1) Ifno resource group is used,the entire range permitted bythe storage system can beused, or (2) The entire rangepermitted in a resource groupfor the user specified in thehitachi_rest_user can beused. You can specify integervalues by using a decimalformat or colon-separatedhexadecimal format(xx:yy:zz).

hitachi_rest_number Optional 0 Specifies the number foridentifying the Cinder driverinstance. Created by addingtogether the storage devicecopy group name, devicegroup name, and snapshotname. Integer value (0-255).

hitachi_rest_user Required None Specifies the user name usedfor authentication to accessthe storage device. If thedriver manages multiplestorage devices, use the sameuser name, password,resource group andpermission for all storagesystems.




Parameter

Requiredor


hitachi_rest_password orhitachi_rest_password_path

Required None Specifies the password usedfor authentication to accessthe storage device. Only oneof the parameters should bespecified, not both. If neitherparameter is specified,startup of the backend willfail. For security reasons, it isstrongly recommended thatyou use thehitachi_rest_password_path parameter. For moreinformation about how tosecure the password, seeSecure your storage systempassword (on page 38) .

hitachi_rest_name_only_discovery Optional False Sets a search restriction onhost groups or iSCSI targetswhen attaching anddetaching volumes. If True isspecified, the driver searchesonly the host groups or theiSCSI targets that are namedHBSD-<target host WWPN>or HBSD-<IP Address ofthe connecting host(my_ip)>, and ignores therest. If host groups or iSCSItargets are created underdifferent names, attachingand detaching volumes willresult in an error.

If False is specified, thedriver searches the rest if itdoes not find specific hostgroups or iSCSI targets thatmatch these names. In thiscase, a search might takemore time.




Parameter

Requiredor


hitachi_target_ports Optional None Specifies the controller portname to search host groups(iSCSI targets) when attachingvolumes. Specify the portname in a format conformingto the storage system thatuses it (for example, VSPG1000: CL1-A). To usemultipath connection, specifycontroller port names,separated by a comma (forexample, CL1-A,CL2-A).When attaching volumes tothe Controller node, thecontroller port specified forthis parameter is used. Whenattaching to the Computenode, the controller portspecified for this parameter isused ifhitachi_compute_target_ports is None (default).

When this parameter is notspecified andhitachi_compute_target_ports as well ashitachi_rest_pair_target_ports are specified, thedriver operates as theenvironment without the I/Odata path of the Controllernode.

If you have a backend storagesystem for whichSIMPLE_REST is specified forthe hitachi_storage_cliparameter and a backendstorage system for which adifferent value is specified forthe parameter, do not set thesame port number for thosebackend storage systems.




Parameter

Requiredor


hitachi_compute_target_ports Optional None Specifies the controller portname to search host groups(iSCSI targets) when attachingvolumes to a compute node.Specify the port name in aformat conforming to thestorage system that uses it(for example, VSP G1000:CL1-A). To use the multipathconnection, specify thecontroller port namesseparated by a comma. IfNone (default) is specified,the controller port specifiedin hitachi_target_portsis used.

If you have a backend storagesystem for whichSIMPLE_REST is specified forthe hitachi_storage_cliparameter and a backendstorage system for which adifferent value is specified forthe parameter, do not set thesame port number for thosebackend storage systems.

hitachi_rest_pair_target_ports Optional None Specifies a port name forcreating a host group (iSCSItarget) of the HBSD-pairXX (XXis number) to register anLDEV when the volume iscopied with storage function.Specify the port name in aformat conforming to thestorage system that uses it(for example, VSP G1000:CL1-A). To specify more thanone port name, separate thenames with commas. If None(default) is specified, thecontroller port specified inhitachi_target_ports isused.




Parameter

Requiredor


hitachi_group_request Optional False Specifies True or False todetermine whether a hostgroup (iSCSI target) is createdautomatically if a host group(iSCSI target) correspondingto the connection target nodedoes not exist for the portspecified in thehitachi_target_ports orhitachi_compute_target_ports parameter. If False(default) is specified, it doesnot create the host groupautomatically.

hitachi_group_delete Optional False Defines specifications forautomatically deleting emptyhost groups or iSCSI targetsassigned to the target portsspecified in thehitachi_target_ports orhitachi_compute_target_ports parameter. Set Falseto not delete automatically.Set True to deleteautomatically. If you specifyTrue, you must also specifyTrue in thehitachi_group_requestparameter. If the FibreChannel Zone Manager isused (thehitachi_zoning_requestparameter must be enabled),Fibre Channel zonesconfigured for the hostgroups or iSCSI targets will bedeleted.




Parameter

Requiredor


hitachi_zoning_request Optional False Specify this parameter if youare using a Fibre Channelconnection. Specifies True orFalse to determine whetherFibre Channel zoningbetween the storage systemand connection target node isconfigured automatically bycollaborating with FibreChannel Zone Manager. Toconfigure automatically, youneed to enable Fibre ChannelZone Manager. See the onlinemanual for the configurationof Fibre Channel ZoneManager. If False (default) isspecified, Fibre Channelzoning is not configuredregardless of the availabilityof Fibre Channel ZoneManager.

hitachi_use_chap_auth Optional None Specify this parameter if youare using an iSCSI connection.When using CHAPauthentication of the iSCSItargets, set this parameter toTrue. For details, see CHAPauthentication in theProvisioning Guide for theapplicable storage system, aslisted in Referenceddocuments (on page 9) .

hitachi_auth_user Optional None Specify this parameter if youare using an iSCSI connection.Specifies the CHAP username used for authenticationof the iSCSI target. See therelevant user documentation.If nothing is specified, HBSD-CHAP-user is set.




Parameter

Requiredor


If True is specified for thehitachi_use_chap_authparameter, this parameter isrequired.

hitachi_auth_password Optional None Specify this parameter if youare using an iSCSI connection.Specifies the password forthe hitachi_auth_usersetting. See the relevant userdocumentation. If nothing isspecified, the HBSD-CHAP-password is set.

If True is specified for thehitachi_use_chap_authparameter, this parameter isrequired.

hitachi_auth_password_path Optional None Specify this parameter if youare using an iSCSI connection.Specifies the file path thatcontains the password hintfor hitachi_auth_user.Either thehitachi_auth_password orthehitachi_auth_password_path parameter should bespecified if using CHAPauthentication. Block StorageDriver for OpenStack returnsan error if both parametersare specified. The file must beplaced in a directory wherethe Cinder user or group canaccess but outside thedirectory in which the filesare collected fortroubleshooting purposes(for example, /opt/hitachi/hbsd/rest_password).

hitachi_default_copy_method Optional FULL Specifies the defaultcopy_method for copying




Parameter

Requiredor


volumes. You can specifyFULL for Thin Image (Clone)or THIN for Thin Image(Snapshot). For details aboutthis parameter, see Volumedetach operation fails (onpage 87) .

hitachi_copy_speed Optional 3 Specifies the copy speed forcopying volumes by usingThin Image (Clone) functions.You can specify a value in therange from 1 to 15. If nothingis specified, 3 is set. Specify 1or 2 to select slow copyspeed. Specify 3 to selectnormal speed, and specify 4or larger to specify highspeed (prior).

hitachi_copy_check_interval Optional 3 Specifies the interval(seconds) at which paircreation is confirmed duringa volume copy. You canspecify a value in the rangefrom 1 to 600. If nothing isspecified, 3 (seconds) is set.

hitachi_async_copy_check_interval Optional 10 Specifies the interval(seconds) at which copy pairsynchronization is confirmed.You can specify a value in therange from 1 to 600. Ifnothing is specified, 10(seconds) is set.




Parameter

Requiredor


hitachi_rest_disable_io_wait Optional False Specifies whether to enablethe I/O check suppressionoption for a host group whenthe host group is created. Ifthis parameter is disabled,before performing volumedetach operations, make surethat no storage I/Ooperations are beingperformed. By enabling thisparameter, you can avoid theproblem described in Volumedetach operation fails (onpage 87) .

hitachi_rest_api_ip Required None Specifies the REST API serverhostname or IP address.

hitachi_rest_api_port Optional 23451 Specifies the REST API serverport number. For detailsabout the REST API serverport number, see the HitachiCommand SuiteConfiguration Manager RESTAPI Reference Guide.

hitachi_rest_tcp_keepalive Optional True True: Use TCP keepalivefunctionality in thecommunication with the RESTAPI server. With this setting,REST API server failures aredetected in a short time.False: Do not use TCPkeepalive functionality in thecommunication with the RESTAPI server.

hitachi_over_subscription Optional False Enables the over-subscriptionfunction for VSP F350, F370,F700, F900 and VSP G350,G370, G700, G900 storagesystems.








Parameter

Requiredor


hitachi_server_auto_create Optional True Enables automaticconnection between theattached volume and theserver. If True is specified, theobject is automaticallycreated or updated everytime a Compute noderequests to connect to avolume. This parameter isenabled only if SIMPLE_RESTis specified for thehitachi_storage_cliparameter.

If False is specified, alsospecify False for thehitachi_server_auto_delete parameter.

hitachi_server_auto_delete Optional False Enables automatic disconnectof the server from thedetached volume. If thisparameter is enabled, theobject is automaticallydeleted if no volumes areattached to the relevant host.This parameter is enabledonly if SIMPLE_REST isspecified for thehitachi_storage_cliparameter.

hitachi_port_scheduler Optional False Specify this parameter toenable or disable the portscheduler function. If youspecify True, when an attachrequest is received, the activeWWNs that are obtained byFibre Channel Zone Managerwill be distributed andregistered to the host groupsof each port of the storagesystem. To use this function,specify True for thehitachi_group_requestand




Parameter

Requiredor


hitachi_rest_name_only_discovery parameter. If youspecify False for thehitachi_rest_name_only_discovery parameter, it willtake a long time to attachvolumes.

hitachi_discard_zero_page Optional True Enables discarding of discardzero-data pages after avolume is copied or asnapshot is created by usingthe DD command. If thisparameter is enabled, zero-data pages are discarded.

hitachi_host_mode_options Optional None Specifies the host modeoptions for the host group oriSCSI target to be created. Toset multiple host modeoptions, separate them byusing commas. Thisparameter is enabled only ifTrue is specified for thehitachi_group_requestparameter.

For iSCSI targets, the hostmode option 83 (Report iSCSIFull Portal List Mode) isautomatically set.

If True is specified for thehitachi_rest_disable_io_wait parameter, the hostmode option 91 (Disable I/Owait for OpenStack Option) isautomatically set.




Cinder-specific parameters

Default section (SUSE/Mirantis/Ubuntu)

The table below describes details for the Cinder parameters set in the default section ofthe cinder.conf file. Only the parameters relevant to Block Storage Driver forOpenStack are described here.

Parameter

Requiredor

optional Default value Description

enabled_backends Optional None Specifies the backenddefinition section to beused. To specifymultiple labels,separate them by acomma (for example,VSP G1000_1, VSPG1000_2). Do notspecify more than 32backends for theenabled_backendsparameter.*

my_ip Optional 127.0.0.1 Specifies the IP addressof the local host (of themanagement path). Youmust use a uniqueaddress that is not usedin other nodes.

logging_context_format_string Optional See the defaultvalue given inBlock StorageDriver forOpenStack logoutput format.

Specifies the outputformat of logs.




Parameter

Requiredor

optional Default value Description

rpc_response_timeout Optional 60 Specifies the timeoutperiod for attach ordetach processing on aVM. If attach or detachprocessing times out,the processing isrestarted. Thisparameter is specifiedin the DEFAULT sectionon the controller nodethat the cinder-api isrunning. To reflect theconfiguration, restartthe openstack-cinder-api service.

host Optional None Specifies a commonhost name for allbackends. In the HAconfiguration forcontroller nodes,configure the samevalue (for example,ha_cluster) for eachcontroller node. Thisparameter is notrequired if thebackend_hostparameter is specifiedin the backenddefinition section.

Note:

* A maximum of 32 backends supported by Block Storage Driver for OpenStack can be usedconcurrently.

Block Storage Driver for OpenStack log output format

For Block Storage Driver for OpenStack, add thread information after the processinformation in the default format for log analysis.




Default:

%(asctime)s.%(msecs)03d %(process)d %(levelname)s%(name)s [%(request_id)s %(user_identity)s]%(instance)s%(message)s

Block Storage Driver for OpenStack:

%(asctime)s.%(msecs)03d %(process)d %(thread)s%(levelname)s %(name)s[%(request_id)s %(user_identity)s]%(instance)s%(message)s

Backend definition section

The table below describes details for the Cinder parameters set in the backend section ofthe following configuration files.■ For Red Hat: The environment file for configuring Block Storage Driver for OpenStack

(example: custom_env.yaml)

For information on how to set the environment file, see the following Red Hatdocumentation.


■ For SUSE/Mirantis/Ubuntu: cinder.conf

Name

Requiredor


volume_driver Required None Specifies the path of thedriver to be used as follows:

To use the FC driver:

cinder.volume.drivers.hitachi.hbsd.hbsd_fc.HBSDFCDriverTo use the iSCSI driver:

cinder.volume.drivers.hitachi.hbsd.hbsd_iscsi.HBSDISCSIDriverIf no path is specified, startupof the backend will fail.

volume_backend_name Optional None Specifies the name of thebackend associated with thevolume type.






Name

Requiredor


reserved_percentage Optional 0 Specifies the reserved areasize for the back-end storage,using a value in the rangefrom 0 to 100 (%). To provideno reserved area, specify 0(default).

use_multipath_for_image_xfer Optional False When the controller nodeand storage are connectedvia multipath, specify True orFalse to determine whetherto set up a redundantconfiguration using a DM-Multipath in the controllernode. To set up a redundantconfiguration, you must startthe multipath daemon inadvance. If you do not wantto set up a redundantconfiguration, specify False(default).

backend_host Optional None Specifies a host name for atarget backend. In the HAconfiguration for controllernodes, configure the samevalue (for example,backend_ha_cluster) foreach backend of thecontroller node. If thisparameter and the hostparameter are specified, thisparameter is used.

image_volume_cache_enabled Optional None This parameter is for ImageVolume Cache, which cannotbe used with Block StorageDriver for OpenStack. Set thevalue of this parameter toFalse.

If you want to quickly create avolume from an image, youcan use the Volume-backedImage function.




Name

Requiredor


image_upload_use_cinder_backend Optional None This parameter is for theVolume-backed Image, whichcan be used if the parameterbelow is set to the valueshown.

hitachi_default_copy_method=FULLTo use this function, set thevalue of this parameter toTrue and set the parameterlisted above to the valueshown. To not use thisfunction, set the value of theparameter to False.

suppress_requests_ssl_warnings Optional False Suppress SSL certificatewarnings.

driver_ssl_cert_path Optional None Can be used to specify a non-default path to a CA_BUNDLEfile or directory withcertificates of trustedCertificate Authorities.

driver_ssl_cert_verify Optional False If set to True, the SSLcertificate of the REST APIserver will be enabled.

max_over_subscription_ratio Optional 20.0 Specify the maximum over-subscription ratio of the poolof the storage system byspecifying either a value of1.0 or more, or auto (forautomatic expansion). Thisparameter is enabled only ifTrue is specified for thehitachi_over_subscription parameter.




Chapter 6: Troubleshooting

This section describes troubleshooting procedures for Block Storage Driver forOpenStack.

Check the version of Block Storage Driver for OpenStack

The first step in troubleshooting is to make sure you are running the desired version ofBlock Storage Driver for OpenStack that provides the Cinder functions you want to use.

If you encounter a problem, perform the following procedure to check the version of thedriver and make sure the intended version is installed. If you are using an older versionof the driver, update the software and perform the operation to confirm that the updatehas resolved the problem.■ For Red Hat:

1. Run the docker ps command to obtain the container image ID for rhosp13-openstack-cinder-volume-hbsd.

2. Run the following command:

# docker inspect <container-image-ID>

Check Config->Labels->version in the command execution result.

■ For SUSE:

Run the following command:

# /bin/rpm -qi hbsd


Run the following command:

# /usr/bin/dpkg -s hbsd



hbsdgetinfo command

Function

The command hbsdgetinfo collects data needed to investigate driver errors andoutputs the data to hbsdgetinfo-aaa.bbb.ccc.ddd-yyyymmddhhmmss.tar.gz(where aaa.bbb.ccc.ddd is the control node IP address and yyyymmddhhmmss is thedate and time of collection).

Format

/opt/hitachi/hbsd/sbin/hbsdgetinfo [-d directory] [-e cinder]

Parameter Description

-d directory Specify the directory to save the data to be collected. Thedirectory name can be a maximum of 512 bytes long. Thedirectory can be specified as an absolute or relative path. If youomit this parameter, the /tmp directory will be used.

-e cinder Specify this parameter to remove data belonging to the Cindergroup (data to be collected by the data collection commandcinder) from the collection target.

Exit code■ 0: Success■ 1: Fail

Collected data

Data in the common group is always collected. You can remove data in the Cinder groupfrom the collection target by specifying the -e option.

Column Collected data Groups

Cinder (including BlockStorage Driver forOpenStack) setting

All files below /etc/cinder/ Common

/etc/sudoers.d/cinder* Common

Cinder log All files below /var/log/cinder/ Common

Block Storage Driver forOpenStack log

For Red Hat, all files below:

/var/log/cinder/hbsd_*For SUSE/Mirantis/Ubuntu, all files below:

Common

hbsdgetinfo command



Column Collected data Groups

/var/log/hbsd/

Setting related to FC /etc/multipath.conf Common

All files below /etc/multipath.d/ Common

System log /var/log/messages* Common

Setup of FC-related1 /etc/multipath directory Common

Build date1 /opt/hitachi/hbsd/build_date/* Common

Note:

1. Ubuntu only.

Column Command Output file name Groups

Workingstatus ofCinder

cinder absolute-limits cinder_absolute-limits

Cinder

cinder availability-zone-list cinder_availability-zone-list

Cinder

cinder backup-list cinder_backup-list

Cinder

cinder cgsnapshot-list cinder_cgsnapshot-list

Cinder

cinder consisgroup-list cinder_consisgroup-list

Cinder

cinder encryption-type-list cinder_encryption-type-list

Cinder

cinder extra-specs-list cinder_extra-specs-list

Cinder

cinder group-list cinder_group-list

Cinder

cinder group-snapshot-list cinder_group-snapshot-list

Cinder

cinder group-specs-list cinder_group-specs-list

Cinder

hbsdgetinfo command




cinder group-type-list cinder_group-type-list

Cinder

cinder list cinder_list Cinder

cinder qos-list cinder_qos-list

Cinder

cinder rate-limits cinder_rate-limits

Cinder

cinder service-list cinder_service-list

Cinder

cinder snapshot-list cinder_snapshot-list

Cinder

cinder transfer-list cinder_transfer-list

Cinder

cinder type-list cinder_type-list

Cinder

cinder list-extensions cinder_list-extensions

Cinder

pip show cinder pip_show_cinder

Cinder

Main status ofAllcomponent ofopenstack

openstack-status openstack-status

Common

Workingstatus ofhfcldd

cat /proc/scsi/hfcldd/* cat_proc_scsi_hfcldd

Common

cat /sys/class/scsi_host/host*/hfcldd_proc

cat_class_scsi_host_hfcldd_proc

Common

Workingstatus of iSCSI

iscsiadm -m discovery -P 1 iscsiadm_-m_discovery_-P_1

Common

iscsiadm -m session -P 3 iscsiadm_-m_session_-P_3

Common

hbsdgetinfo command




Workingstatus relatedto FC

ls -l /dev/disk/by-path ls -l_dev_disk_by-path

Common

multipath -ll multipath_-ll Common

cat /sys/class/fc_host/host*/node_name

cat_sys_class_fc_host_node_name

Common

cat /sys/class/fc_hosthost*/port_state

cat_sys_class_fc_host_port_state

Common

Systeminformation

uname -a uname_-a Common

dmidecode dmidecode Common

rpm -qa 1 rpm_-qa Common

rpm -qi openstack-cinder 1 rpm_-qi_openstack-cinder

Common

rpm -qi hbsd 1 rpm_-qi_hbsd Common

rpm -V python-cinder 1,4 rpm -Vpython-cinder

Common

rpm -V hbsd 1,4 rpm -V hbsd 4 Common

dpkg-l 2 dpkg_l Common

dpkg-s cinder-volume 2 dpkg_s_cinder-volume

Common

dpkg-s hbsd 2 dpkg_s_hbsd Common

ifconfig -a ifconfig_-a Common

ethtool_all 3 ethtool_all Common

System log journalctl journalctl Common

Notes:

1. SUSE only.2. Ubuntu, Mirantis only.3. Script that collects ethtool information about all network interfaces in a system.

4. The output format is SM5DLUGT c <file>. See the rpm online documentationfor more details about the output format.

hbsdgetinfo command



Example

The following example shows how to use the command hbsdgetinfo to collect data.

# /opt/hitachi/hbsd/sbin/hbsdgetinfo

Output example

The command hbsdgetinfo outputs as follows:

# /opt/hitachi/hbsd/sbin/hbsdgetinfohbsdgetinfo command started.creating directory ... succeeded.copying "/etc/cinder" ... succeeded.copying "/etc/sudoers.d/cinder" ... succeeded.copying "/var/log/cinder" ... succeeded.copying "/var/log/hbsd" ... succeeded.: (Omitted)executing "/usr/bin/cinder transfer-list" ... succeeded.executing "/usr/bin/cinder type-list" ... succeeded.executing "/usr/bin/cinder list-extensions" ... succeeded.archiving files ... succeeded.output to "/tmp/hbsdgetinfo-aaa.bbb.ccc.ddd-yyyymmddhhmmss.tar.gz"hbsdgetinfo command completed successfully.

Note:■ The data that can be collected varies depending on the environment. If

data collection fails, the command outputs error messages.■ The command outputs the message "hbsdgetinfo command

completed successfully" to confirm successful completion of thecommand.

■ To collect the data for the Cinder group, Keystone certification for theadministrator user must be kept in the environment variables. To changesettings for the environment variables, use the env command. If that isnot possible, specify the -e cinder option and delete the Cinder groupdata from the output.

Configuration Manager logs

If error messages starting with KART- are output to /var/log/cinder/volume.logand processing ends due to an error, Configuration Manager REST API log files might berequired to investigate the problem.

For details on getting the logs, see Collecting maintenance information about the REST APIin the Hitachi Command Suite Configuration Manager REST API Reference Guide.

Configuration Manager logs




Openstack-cinder-volume service does not start

If an error message for Block Storage Driver for OpenStack is output to /var/log/cinder/volume.log, see Messages to troubleshoot the problem.

If no error message is output for Block Storage Driver for OpenStack, a Cinder errormessage might be output to syslog.

Volume (snapshot) cannot be created

Check for an error message in volume.log, and see Messages (on page 88) totroubleshoot problem.

Volume (snapshot) cannot be attached

For error messages of Block Storage Driver for OpenStack in volume.log, see Messages(on page 88) to troubleshoot the problem.

Volume operations fail in a multi-controller node environment

Verify that your OpenStack configuration is valid. Refer to Supported configurations forBlock Storage Driver for OpenStack (on page 28) .

Volume attach and detach operations fail

Volume attach and detach operations might fail when multiple volume operations areperformed concurrently. This can be caused by time outs that occur during theprocessing of the Cinder requests in the backends.

You can increase the timeout threshold for all the nodes by modifying therpc_response_timeout parameter to 3600 in the nova.conf (/etc/nova/nova.conf) and the cinder.conf file (/etc/cinder/cinder.conf).

Note: Changing the value of the rpc_response_timeout parameter to alarger value may increase the time needed to complete processing if an erroroccurs during attach or detach operations.

Openstack-cinder-volume service does not start



Volume detach operation fails

If you are using a software that detaches volumes in which no data is written, when youperform a volume detach operation, the target volume might have already beendetached. In such cases, the volume detach operation fails because of a timeout error.To prevent this from occurring, set the I/O check suppression option (host mode option91) for the host group. If the hitachi_group_request parameter is set to True, and ifnew host groups are created automatically, specify this option by setting thehitachi_rest_disable_io_wait parameter to True.

If setting host groups or iSCSI targets for manual configuration, use the storage systemmanagement software to set 91 for the host mode option. For details on setting the hostmode option, see the Hitachi Command Suite Configuration Manager REST APIReference Guide.

To set this option for host groups that already exist, follow the usage listed below.

Volume attach performance issues after HBA replacement

Replacing a host bus adapter (HBA) in a multipath configuration can impact processing ofvolume attach requests in backend storage devices.

Make sure that the host group for the HBA has been updated after the replacement. Ifyou have not already updated the host group name, with Storage Navigator, change thename to "HBSD-xxx" where xxx is the smallest WWPN number available for the server.

Volume deletion causes error status

When deleting many volumes in one operation, some of the volumes may result in anerror_deleting status. If this happens, enter the cinder reset-state command. Verifyvolume status has returned to available, then retry deleting the volume(s).

Contacting Hitachi Vantara Corporation customer support

If you need to contact Hitachi Vantara customer support, provide as much informationabout the problem as possible. Collect the files below and provide them along with theactions you have taken to resolve the problem.■ Use the sosreport (Red Hat, Ubuntu, Mirantis) or supportconfig (SUSE) command

to collect data on all nodes.■ Use the hbsdgetinfo command to collect data on all controller nodes.

■ Copies of the operation logs of High Availability cluster software that collect data onthe controller node in the High Availability cluster. For example, /var/log/pacemaker.

Volume detach operation fails





Chapter 7: Messages

Message output format

This topic describes the format of messages that are output to the volume.log file.

The following is Block Storage Driver for OpenStack message format:

yyyy-mm-dd hh:mm:ss.fff PID loglevel filepath [request_id user tenant] message

Where:■ yyyy-mm-dd hh:mm:ss.fff : Date and time of output■ PID: Process ID■ loglevel: Log level■ filepath: File path of the output source■ request_id: Request ID■ user: User ID■ tenant: Tenant ID■ message: Message content

The actual message content (indicated by MSGID0000-t in the message format above) isoutput as follow:

MSGIDn1n2n3n4-t: Message text

Where:■ MSGID: Indicates that the message is a driver message■ n1n2n3n4: The serial number of the message■ t: The message type

The message type indicates the operation corresponding to the message. The messagetypes are as follows:

Type Description

E Error message indicating that processing cannot continue due to adriver error or an incorrectly specified option.

Chapter 7: Messages


Type Description

W Warning message indicating that a driver error occurred or that anoption was incorrectly specified, but that processing will continue.

I Message providing additional information about processing.Messages that are neither error messages nor warning messages.

List of messages

MessageID Message text Driver status Required actions

0000-I The method <method name>was called. (config group:<backend definition name>)

Continuesprocessing therequest.

None.

0001-I The parameter of the storagebackend. (config_group:<backend definition name>)


None.

0002-I The method <method name>completed successfully.(config_group: <backenddefinition name>)


None.

0003-I The storage backend can beused. (config_group:<backend definition name>)


None.

0300-W Failed to configure theinternal logging. (ret: <returnvalue>, stderr: <standard erroroutput>).


Verify that the user hassufficient permissionfor the directory.

0301-W A LUN (HLUN) was not found.(LDEV: <LDEV number>)


None.

0302-W Failed to specify a logicaldevice for the volume<volume ID> to be unmapped.


None.

0303-W An iSCSI CHAP user could notbe deleted. (username:<CHAP user name>)


If the CHAP user is nolonger needed, deleteit using the storagemanagement software.

List of messages

Chapter 7: Messages



0304-W Failed to specify a logicaldevice to be deleted.(method: <method name>, id:<volume ID | snapshot ID>)


Make sure that thelogical devices do notexist for unnecessaryvolumes.

0305-W The logical device forspecified <volume|snapshot><volume ID | snapshot ID>was already deleted.


Make sure that noinvalid volumes orsnapshots exist.

0306-W A host group could not bedeleted. (port: <port name>,gid: <group ID>)


Take the actionsspecified in theprevious message.

0308-W A host group could not beadded. (port: <port name>)

Continuesprocessing therequest forother ports.


0309-W An iSCSI target could not beadded. (port: <port name>)



0310-W Failed to unmap a logicaldevice. (LDEV: <LDEVnumber>)


Make sure that thelogical devices do notexist for unnecessaryvolumes.

0311-W A free LUN (HLUN) was notfound. Add a different hostgroup. (LDEV: <LDEV number>)


None.

0312-W Failed to get a storageresource. The system willattempt to get the storageresource again. (resource:<resource>)


None.

0313-W Failed to delete a logicaldevice. (LDEV: <LDEVnumber>)


Make sure that thelogical devices do notexist for unnecessaryvolumes or snapshots.

List of messages

Chapter 7: Messages



0314-W Failed to map a logical device.(LDEV: <LDEV>, LUN: <LUNnumber>, port: <port name>,id: <group ID>)

Continuesprocessing therequest for theother hostgroups (iSCSItargets).


0315-W Failed to perform a zero-pagereclamation. (LDEV: <LDEVnumber>)


None.

0317-W Failed to assign the WWN.(port: <port name>, gid:<group ID>, wwn: <WWN>)

Continuesprocessing therequest for theother ports.


0318-W Failed to copy meta data ofdestination volume <volumeID> to source volume<volume>. (reason: <detailedmessage>)


None.

0319-W The logical device does notexist in the storage system.(LDEV: <LDEV>)


None.

0321-W Failed to perform userauthentication of the RESTAPI server. (user: <user>)


Verify userauthenticationinformation. Enter thecorrect values andretry the operation.

0324-W Failed to delete full copy pair.(P-VOL: <LDEV number>, S-VOL: <LDEV number>)



0325-W Failed to delete thin copypair. (P-VOL: <LDEV number>,S-VOL:<LDEV number>)



0326-W Failed to change the status offull copy pair. (P-VOL: <LDEVnumber>, S-VOL:<LDEVnumber>)



List of messages

Chapter 7: Messages



0329-W Failed to detach the logicaldevice. (LDEV: <LDEVnumber>, reason: <detailedmessage>)

Continuesprocessing therequest for theother ports.


0330-W The port name specified forthe extra spec key"hbsd:target_ports" of thevolume type is not specifiedfor the hitachi_target_portsorhitachi_compute_target_portsparameter in cinder.conf.(port: <port>, volume type:<volume type>)


Correct the port namefor the extra spec keyhbsd:target_ports.

0331-W Volume copy to a largervolume started. This processwaits until all data is copiedto the destination volume,and therefore it may take along time before thedestination volume becomesavailable. Consider copying toa volume with the same sizeto save time because itperforms data copy in thebackground and thereforeends much faster. (source<volume | snapshot>:<volume-ID | snapshot-ID>,destination volume: <volume-ID>, source size: <source-size>,destination size: <destination-size>)


Include the timerequired for datacopying to theestimated time untilthe copy destinationvolume can be used.For faster subsequentcopying of the volume,set the source volumeand the destinationvolume to the samesize.

0332-W Failed to change a volumetype. The storage systemdoes not supportdeduplication, ordeduplication is not enabledfor the pool. (pool: <pool>)

Continuesprocessing therequest usingstandard Cinderfunctions.

Check if the storagesystem supportsdeduplication. If itdoes, enable it, andthen retry theoperation.

List of messages

Chapter 7: Messages



0333-W Retyping the volume will beperformed using migrationbecause the specified volumeis being rehydrated. Thisprocess may take a long timedepending on the data size.(volume: <volume-ID>, volumetype: <volume type>)


To change volume typequickly, do not changevolume types thatenable the dedupe/compression functionon volumes that justhad the functiondisabled.

0334-W Retyping the volume will beperformed using migrationbecause inconsistency wasfound in the deduplicationsystem data volume. Thisprocess may take a long timedepending on the data size.(volume: <volume-ID>, volumetype: <volume type>)


To resolve theinconsistency in thesystem data volume,see your systemadministrator.

0335-W Failed to create the hostgroup because the hostgroup maximum of the portis exceeded. (port: <port>)

Continuesprocessing byusing anotherport.

Check whether theport has anyunnecessary hostgroups, and thendelete those hostgroups.

0600-E The Command <command>failed. (ret: <return value>,stdout:<standard output>,stderr:<standard erroroutput>)

Stoppedprocessing therequest.

Remove the cause ofthe error by followingthe message output bythe externalcommand.

0336-W Failed to add the wwns to thehost group port because thethe WWN maximum of theport is exceeded. (port:<port>, WWN: <WWN>)

Continuesprocessing byusing anotherport.

Check whether theport has anyunnecessary WWNs,and then cancel theassignment of thoseWWNs.

0601-E A parameter is invalid.(<parameter name | detailedmessage>)


Check and, ifnecessary, revise thespecified parametervalues, and then trythe operation againwith the correct valuesspecified.

List of messages

Chapter 7: Messages



0602-E A parameter value is invalid.(<meta data name>)


Check and, ifnecessary, revise thespecified parametervalues, and then trythe operation againwith the correct valuesspecified.

0603-E Failed to acquire a resourcelock. (serial: <serial number>,inst: <HORCM instancenumber>, ret: <return value>,stderr: <standard erroroutput>)


Remove the cause ofthe error by followingthe message output bythe externalcommand.

0606-E The snapshot <snapshot ID>cannot be deleted, because aread-only volume for thesnapshot exists.


Make sure thesnapshot operationtarget is correct.Alternatively, deletethe target snapshotafter deleting read-onlyvolume related to thetarget snapshot.

0610-E The status change of full copypair could not be completed.(S-VOL: <LDEV number>)



0611-E The status change of thincopy pair could not becompleted. (S-VOL: <LDEVnumber>)



0612-E The source logical device tobe replicated does not existin the storage system. (LDEV:<LDEV number>)


Specify the correctvolume and retry theoperation.

0613-E The volume <volume ID> to beextended was not found.


Specify the correctvolume and retry theoperation.

0614-E No WWN is assigned. (port:<port name>, gid: <group ID>)



List of messages

Chapter 7: Messages



0615-E A pair could not be created.The maximum number ofpair is exceeded. (copymethod: <copy-methodname>, P-VOL: <LDEVnumber>)


If FULL is specified,wait for copying tofinish, and then try theoperation again. IfTHIN is specified,delete the unnecessarypairs, and then try theoperation again.

0616-E A pair cannot be deleted. (P-VOL: <LDEV number>, S-VOL:<LDEV number>(<pair status>)[, <LDEV number>(<pairstatus>)...])


Wait until the pair canbe deleted, and thentry the operation again.For Thin Image(Snapshot), you cannotdelete only the P-VOL.You must first deletethe S-VOL. If the pairstatus is PSUE, resolvethe issue on thestorage system, andthen retry theoperation.

0617-E Failed to create a volumefrom <volume | snapshot>.The size of the new volumemust be equal to or greaterthan the size of the original<volume | snapshot>. (newvolume: <volume-ID>)


Set the size of thedestination volumeequal to or greaterthan the size of theoriginal volume orsnapshot.

0618-E The volume <volume-ID>could not be extended. Thevolume type must be Normaland the volume must not bean S-VOL in a cascade pair.


Verify the targetvolume is correct. If thetype metadata isNormal, after the copyoperation completesand the pair is deleted,retry the operation. Ifotherwise, since thevolume cannot beextended, set thecopy_methodmetadata to FULL, andthen clone the volume.Extend and use thisnewly created volume.

List of messages

Chapter 7: Messages



0619-E The volume <volume ID> to bemapped was not found.


Specify the correctvolume, and then trythe operation again. Ifthe volume is nolonger needed, deletethe volume.

0620-E Failed to provide informationabout a pool. (pool: <pool>)



0621-E Failed to create a volumefrom <volume | snapshot>.The size of the new volumemust be equal to the size ofthe original <volume |snapshot> when the newvolume is created by Thincopy. (new volume: <volume-ID>)


Set the size of thedestination volumeequal to the size of theoriginal volume orsnapshot.

0624-E HBSD has stoppedprocessing the requests.


Specify the correctcopy-source volume,and then try theoperation again.

0631-E Failed to create a file. (file:<file name>, error: <errornumber>, strerror: <errormessage>)


Check that the userhas sufficientpermission to performthe action on thedirectory.

0633-E Permission denied. Stoppedprocessing therequest.

Check that the userhas sufficientpermission to performthe action on the file.

0634-E Failed to attach the logicaldevice. (LDEV: <LDEVnumber>, reason: <detailedmessage>)



0636-E Failed to add the logicaldevice.



List of messages

Chapter 7: Messages



0638-E Failed to add the pair target. Stoppedprocessing therequest.


0639-E Failed to map a logical deviceto any pair targets. (LDEV:<LDEV number>)



0640-E A pool could not be found.(pool: <pool>)


Check and, ifnecessary, revise theparameter, and thenrestart the service.

0643-E The iSCSI CHAP user <CHAPuser name> does not exist.


Create the specifiedCHAP user.Alternatively, enablethe parameterhitachi_add_chap_user to enableautomatic creation of aCHAP user whencreating an iSCSItarget.

0648-E There are no resourcesavailable for use. (resource:<resource>)


Check and, ifnecessary, revise thestorage device settingsand parameter settingsto secure the targetresources.

0649-E The host group or iSCSI targetwas not found.


Create the host groupor iSCSI target.Alternatively, if you areusing iSCSI, enable theparameterhitachi_group_request to enableautomatic creation ofan iSCSI target.

0650-E The resource <resource> wasnot found.


Check the setting forthe target resources.

List of messages

Chapter 7: Messages



0651-E The IP Address was notfound.

Stoppedprocessingrequests.

Make sure an IPaddress has been setfor the storage deviceiSCSI port.

0652-E Failed to delete a logicaldevice. (LDEV: <LDEVnumber>)



0653-E The creation of a logicaldevice could not becompleted. (LDEV: <LDEVnumber>)



0654-E A volume status is invalid.(status: <status>)


Make sure theoperation targetvolume is correct.Alternatively, wait untilthe status of the targetvolume becomesAvailable, and then trythe operation again.

0655-E A snapshot status is invalid.(status: <status>)


Make sure thesnapshot operationtarget is correct.Alternatively, wait untilthe status of the targetsnapshot becomesAvailable, and then trythe operation again.

0656-E The volume <volume ID>could not be restored.(reason: <detailed message>)

1. Invalid input:<volume ID| snapshot ID>

2. Status of target volume<volume ID> is not"available":<status ofvolume>

3. Status of source volume<volume ID | snapshotID> is not"available":<status ofvolume>


Make sure that thestatus and metadatafor the specifiedvolume are correct.

List of messages

Chapter 7: Messages



0657-E A read-only volume cannotbe created from the snapshot<snapshot ID>. A read-onlyvolume already exists.


Make sure that thespecified snapshot iscorrect.

0658-E A new volume cannot becreated from the snapshot<snapshot ID>. A read-onlyvolume of the snapshot isattached.


Make sure that thespecified snapshot iscorrect. Alternatively,detach the read-onlyvolume from theinstance beforecreating a new volumefrom the specifiedsnapshot. After thenew volume is created,reattach the read-onlyvolume.

0659-E A host group is invalid. (hostgroup: <host group name>)


Create a host group.

0660-E The specified <volume |snapshot> <volume ID |snapshot ID> is busy.


Make sure that thespecified volume orsnapshot is correct.Alternatively, wait forthe other processing tofinish, and then try theoperation again.

0700-E No valid value is specified for"storage_id". A valid valuemust be specified for"storage_id" to manage thevolume.


Make sure that thestorage identifierinformation or thecommand is correct,and then try theoperation again.

0701-E No valid value is specified for"ldev". A valid value must bespecified for "ldev" tomanage


Make sure that theLDEV information orthe command iscorrect and retry theoperation.

List of messages

Chapter 7: Messages



0702-E Failed to manage thespecified LDEV (<LDEVnumber>). The LDEV must bean unpaired DP-VOL <volumetype>.


Make sure that thetarget LDEVinformation is correct.Alternatively, if thetarget LDEV has a pair,delete the pair andretry the operation.The driver does notmanage LDEVs that arenot DP-VOL. Create aDP-VOL, copy the datafrom the LDEV, andthen retry theoperation.

0703-E Failed to manage thespecified LDEV (<LDEVnumber>). The LDEV sizemust be expressed ingigabytes.


Make sure that thetarget LDEVinformation is correct.Extend the LDEV sothat it is expressed ingigabytes, and thenretry the operation.

0704-E Failed to manage thespecified LDEV (<LDEVnumber>). The LDEV must notbe mapped.


Make sure that thetarget LDEVinformation is correct.Unmap the LDEV andtry the operation.

0705-E Failed to manage thespecified LDEV (<LDEVnumber>). The LDEV must notbe mapped.


Make sure the targetLDEV information iscorrect. Clone thevolume and retry theoperation.

List of messages

Chapter 7: Messages



0706-E Failed to unmanage volume<volume ID>. The volume typemust be Normal and thevolume must not be an S-VOLin a cascade pair.


Verify the targetvolume is correct. If thetype metadata isNormal, retry theoperation after copycompletes and the pairis deleted. If otherwise,since the volumecannot be removedfrom Cindermanagement, set thecopy_methodmetadata to FULL, andthen clone the volume.Remove the newlycreated volume fromCinder management.

0707-E No valid value is specified for"source-id". A valid LDEVnumber must be specified in"source-id" to manage thevolume.


Make sure that theLDEV information orthe command iscorrect, and then trythe operation again.

0710-E Failed to create a clonedvolume for the volume<volume ID>. The volume typemust be Normal.


Check the typemetadata of thevolume. If the typemetadata of thevolume is not Normal,replication of thevolume might be inprogress. Retry theoperation after thereplication finishes.

0711-E A source volume for clonewas not found. (volume_uuid:<volume ID>)


Specify the volume IDof an existing bootablevolume involume_uuid.

List of messages

Chapter 7: Messages



0712-E Failed to create a consistencygroup snapshot. (copymethod: <copy-method>) Thenumber of pairs in theconsistency group or thenumber of consistency groupsnapshots has reached thelimit.


Verify that the numberof pairs in theconsistency group isnot exceeding the maxpermitted (8,192). Ifthe copy method isFULL, make sure thereare no otherconsistency snapshotoperations in progress,and then retry theoperation. If the copymethod is THIN, deleteany unnecessarysnapshots for theconsistency group andretry the operation.

0713-E V-VOLs cannot be added to aconsistency group.


Add only DP-VOLs tothe consistency group.Change the copymethod so that DP-VOLs are added to theconsistency group.

0714-E Failed to delete unused fullcopy pair. (Copy Group: <copygroup >)



0716-E No logical device exists in thestorage system for thevolume <volume-ID> to beadded to the consistencygroup <consistencygroup-ID>.


Wait for the LDEVs tobe created, and thenretry the operation.

0717-E Multiple mappings forvolume <volume_id> found;no host specified.


Verify the volume usingthe storagemanagement software.Manually delete anyunnecessarymappings.

0718-E Failed to create a thin or fullcopy pair because specifiedvolume (<volume-ID>) hascascade pair of clone or thincopy pair of snapshot.


Delete the clone orsnapshot cascade pairfor the specified LDEV,and then retry theoperation.

List of messages

Chapter 7: Messages



0719-E Failed to create a cascadepair because the micro ofstorage system does notsupport the copy functionspecified by thehitachi_copy_versionparameter.(hitachi_storage_id:<hitachi_storage_id>,hitachi_copy_version:<hitachi_copy_version>,hitachi_thin_pool:<hitachi_thin_pool>, P-VOL:<pvol>, S-VOL:<svol>, Microversion:<micro_version>)


Update the microversion of the storagesystem software, andthen retry theoperation.

0722-E Failed to unmanage thesnapshot <snapshot-ID>. Thisdriver does not supportunmanaging snapshots.


Use the cindersnapshot-reset-state command asnecessary to modifythe status of thesnapshot.

0723-E Failed to create a volume. Aninvalid value is specified forextra spec key "<key>" of thevolume type. (value: <value>)


Set the correct valuefor the extra spec keyfor the volume type,and retry theoperation.

0724-E Failed to create adeduplicated volume. Thestorage system does notsupport deduplication, ordeduplication is not enabledfor the pool. (pool: <pool>)


Verify the storagesystem supportsdeduplication. Ifsupported, enablededuplication of thepool, and retry theoperation.

0725-E Failed to copy the volume.(copy method: <copy-method>, P-VOL: <pvol>, S-VOL: <svol>)



List of messages

Chapter 7: Messages



0726-E A volume or snapshot cannotbe deleted. The logical deviceconsistency for the volume orsnapshot cannot beguaranteed. (LDEV: <LDEV>)


After backing up anyrequired data, refer tothe storage user'sguide, and theninitialize datareduction.

0727-E Failed to change the volumetype. An invalid value isspecified for extra spec key"<key>" of the volume typeafter change. (value: <value>)


Specify a valid value forextra spec key <key>for the volume typeafter the change, andthen retry theoperation.

0728-E The volume type changecould not be completed.(LDEV: <LDEV>)



0730-E A newer version of the RESTAPI is required.(current:<current_version>,required: <required_version>or newer)


Update the REST APIserver to the requiredversion.

0731-E Failed to communicate withthe REST API server.(exception: <exception>,message: <message>,method: <method>, url: <url>,params: <params>, body:<body>)


Remove the cause ofthe error by followingthe message output bythe HTTP library.

0732-E The REST API failed. (source:<errorSource>, ID:<messageId>, message:<message>, cause: <cause>,solution: <solution>, code:<errorCode>, method:<method, url: <url>, params:<params>, body: <body>)


Remove the cause ofthe error by followingthe message output bythe REST API server. Ifthe "code" value in themessage is {u'SSB1':u'2E13', u'SSB2':u'6003'}, run thecinder migratecommand with the --force-host-copyTrue option.

List of messages

Chapter 7: Messages



0733-E The REST API timed out. (jobID: <job_id>, job status:<status>>, job state: <state>,method: <method>, url: <url>,params: <params>, body:<body>)


Verify the REST APIoperation log andstorage log, and thenrespond to the causeof the timeout. Verifyvolume status by usingthe storagemanagement software.If any unnecessaryvolumes exist, removethem manually.

0734-E The REST API failed. (HTTPstatus code: <status_code>,response body:<response_body>, method:<method>, url: <url>, params:<params>, body: <body>)


Verify the REST APIserver operation log.

0735-E Failed to create a consistencygroup snapshot. V-VOLs existin the consistency group.(group: <group-ID>, groupsnapshot: <group-snapshot-ID>, group type: <group-type-ID>, volumes: <volume-ID>[,<volume-ID>...], snapshots:<snapshot-ID>[, <snapshot-ID>...])


Snapshots for volumesin the consistencygroup cannot becreated because V-VOLs exist in theconsistency group.Delete the volumesindicated in themessage or delete theconsistent_group_snapshot_enabled attributeof the group type, andthen retry theoperation.

0736-E Failed to delete a {volume|snapshot} in a {group|groupsnapshot}. ({group|groupsnapshot}: <{group|group-snapshot}-ID>, {volume|snapshot}: <{volume|snapshot}-ID>, LDEV: <LDEV>,reason: <reason>)



List of messages

Chapter 7: Messages



0737-E Failed to create a volumesnapshot in a group snapshotthat does not guaranteeconsistency. (group: <group-ID>, group snapshot: <group-snapshot-ID>, group type:<group-type-ID>, volume:<volume-ID>, snapshot:<snapshot-ID>)


Refer to previousmessages andeliminate the cause ofthe failure. Then createa snapshot of thevolume specified inthis message.

0738-E Failed to migrate a volume.The volume status must be'available'. (volume: <volume-ID>, status: <status>)


Run the cindermigrate commandwith the --force-host-copy Trueoption.

0739-E The Simple REST API failed.(source: <error-source>, ID:<message-ID>, message:<message>, cause: <cause>,solution: <solution>, code:<error-code>)


Take the actionsspecified in theprevious message. IfSIMPLE_REST isspecified for thehitachi_storage_cli parameter, makesure that the model ofthe storage systemwhose ID is specified inhitachi_storage_idis VSP F350, F370,F700, F900 or VSPG350, G370, G700,G900. If the model isneither VSP F350, F370,F700, F900 nor VSPG350, G370, G700,G900, specify REST forthehitachi_storage_cli parameter or omitthe parameter value.

0740-E The Simple REST API timedout. (request ID: <request-ID>,command progress:<progress>, command result:<result>)


Check the REST APIserver operation log orthe storage log toaddress the cause ofthe timeout.

List of messages

Chapter 7: Messages



0741-E The Simple REST API failed.(HTTP status code: <status-code>, response body:<response-body>)


Check the REST APIserver operation log.

0742-E Failed to attach the volume tothe host because the serverconnection managementobject corresponding to thehost was not found in thestorage system. (servernickname: <server-nickname>,volume: <volume-ID>)


Create a serverconnectionmanagement object inthe storage system.Alternatively, specifyTrue for thehitachi_server_auto_create parameter.

0743-E Failed to initialize volumeconnection because the extraspec key "hbsd:target_ports"is set for the volume typewhen hitachi_storage_cliparameter is set to"SIMPLE_REST". (volume:<volume-ID>, volume type:<volume type>,hbsd:target_ports:<hbsd:target_ports>)


Delete the extra speckeyhbsd:target_ports,and then retry theoperation.

0744-E Failed to create a serverconnection managementobject in the storage systembecause the number of usedobjects has reached the limit.(server nickname: <server-nickname>, protocol:<protocol>, OS type: <OS-type>, OS type option: <OS-type-option>, iSCSIauthentication method:<iSCSI-authentication-method>, iSCSI mutualsetting: <iSCSI-mutual-setting>)


Delete unnecessaryserver connectionmanagement objectsin the storage system.

List of messages

Chapter 7: Messages



0745-E Failed to associate a serverconnection managementobject with a port in thestorage system because thenumber of objects that canbe associated with a port hasreached the limit. (servernickname: <server-nickname>,connector ID: <connector ID>,ports: <ports>)


Delete unnecessaryserver connectionmanagement objectsthat are associatedwith the port.

0746-E Failed to attach the volume tothe host because the pathsetting for the serverconnection managementobject corresponding to thehost is invalid. (servernickname: <server-nickname>,volume: <volume-ID>, ports:<port>[, <port>...])


From the path settingfor the serverconnectionmanagement object,delete any ports thatare not specified forthehitachi_target_ports parameter or forthehitachi_compute_target_portsparameter.Alternatively, specifyTrue for thehitachi_server_auto_create parameter.

0747-E Failed to initialize volumeconnection because no activeWWN was found for theconnector. (WWN: <WWN>[,<WWN> ...], volume: <volume-ID>)


Check the fabricnetwork configuration,and configure thenetwork so that activeWWNs can be found.

0748-E Failed to initialize volumeconnection because no portwith an active WWN wasfound. (port, WWN: <port>,<WWN>[, port, WWN: <port>,<WWN>...], volume: <volume-ID>)


Check the fabricnetwork configuration,and configure thenetwork so that theports with an activeWWN can be found.

List of messages

Chapter 7: Messages



0749-E The Fibre Channel ZoneManager is not available. TheFibre Channel Zone Managermust be up and runningwhen hitachi_port_schedulerparameter is set to True.


Revise the settings ofFibre Channel ZoneManager so that it canrun.

0750-E Failed to initialize volumeconnection because noavailable resource of hostgroup or wwn was found.(ports: <port>)


Revise the host groupsor WWNs assigned tothe port to secureavailable resources.

Messages output by the command hbsdgetinfo

Message text Driver status Required actions

hbsdgetinfo commandstarted.

Continues processing therequest.

None.

hbsdgetinfo commandcompleted successfully.


None.

output topathDesignated/hbsdgetinfo-yyyymmddhhmmss.tar.gz.


None.

creating directory ...{succeeded | failed}


None.

"<list of collection files> |<list of collectioncommands>" is not found

Has stopped processingthe requests.

Reinstall the driver.

"<collection relevant files> |<collection commands>" isnot found


None.

copying "<fileName>" ...{succeeded | failed}.


None.

Messages output by the command hbsdgetinfo

Chapter 7: Messages


Message text Driver status Required actions

executing"<commandName>" ...{succeeded | failed |skipped}.


None.

archiving files ...{succeeded | failed}.


None.

hbsdgetinfo is alreadyrunning


None.

hbsdgetinfo [-ddirectory] [-e cinder]


Check and, if necessary,revise the specifiedarguments, and then trythe operation again.

directory name is too long. Has stopped processingthe requests.

Check and, if necessary,revise the specifieddirectory.

"<pass which you designatedin -d>" is not a directory


Specify a directory.

"<group name which youdesignated in -e>" is not agroup name


Check and if necessary,revise the specified groupname.

Messages output by the installer

Message text Driver installer status Required actions

---- <service name> service isrunning

Installer has stopped. Stop the Cinder service.

Messages output by the installer

Chapter 7: Messages


Appendix A: OpenStack overview

This appendix provides overviews of OpenStack and Cinder.

About OpenStack

OpenStack is open source software for setting up a cloud environment of the IaaS layer.By linking components, OpenStack automatically combines necessary resources fromthe hardware resource pool that contains servers, storages, and network devices toprovide users or groups with a private-server environment.

The list of the main OpenStack components is shown in the following table.Table 5 OpenStack main components

Component Feature Description

OpenStack Compute (Nova) Hypervisor control Manages virtual machinesin a multi-hypervisorenvironment.

OpenStack Image (Glance) Image, Snapshot control Manages VM images.

OpenStack Network(Neutron)

Virtual network control Manages L2/L3 networks.

OpenStack Object Storage(Swift)

Object storage control Provides highly-availabledistributed object storage.

OpenStack Block Storage(Cinder)

Block storage control Provides permanent blockstorage to VM.

OpenStack Identity(Keystone)

Integrated authenticationinfrastructure

Manages authenticationand operationauthorization common toeach component.

OpenStack Dashboard(Horizon)

Self-service WebUI Provides the self-serviceWeb portal.



Cinder overview

Cinder is an OpenStack service component that provides persistent block device storageto VM OpenStack Compute instances as a volume. Data in a Cinder volume persists(remains undeleted) when the volume is detached from a VM instance. Since the dataremains on the block device corresponding to the volume, it can always be reattached bychanging the connection to other VM instances. In addition, high I/O performance isexpected because it has direct access to the block device corresponding to the volumefrom the VM.

Storage providers include a Cinder driver for their storage devices so they can be used toprovide storage in an OpenStack environment.

Cinder commands

The OpenStack Cinder commands can operate backends through the OpenStack CinderAPI. Before using the commands, you must configure the available Keystone userauthentication for the environment variables.

The OpenStack configuration installer included in each distribution creates the filecontaining the authentication information on the controller node. Load this file into theenvironment variables using the source command. The following is an example of anOpenStack environment configuration with the packstack command for the Red HatOpenStack Platform.

# source /root/keystonerc_admin

Authentication information for admin user is described in keystonerc_admin andplaced under /root.

For details about cinder command options, see the help message output by enteringthe following:

# /usr/bin/cinder help

Cinder functions available via CLI vary according to the version of the API. Refer to anonline help, such as OpenStack Command-Line Interface Reference, for details about CLIsupport for Cinder functions.

OpenStack commands

Commands of all OpenStack projects are being integrated into openstack commands.For example, cinder create is being replaced by openstack volume create. Usingcinder commands is recommended because not all volume use cases are available inthe openstack commands, such as GVG functions.

Cinder overview



Appendix B: Block Storage Driver for OpenStackLicense

Apache License 2.0 is applied to Block Storage Driver for OpenStack.

# Copyright (C) 2014, 2018, Hitachi, Ltd.

#

# Licensed under the Apache License, Version 2.0 (the "License"); you may

# not use this file except in compliance with the License. You may obtain

# a copy of the License at

#

# http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the

# License for the specific language governing permissions and limitations

# under the License.

Appendix B: Block Storage Driver for OpenStack License


Glossary

Cascade pair

A pair created by the Thin Image function.

Consistency group (CG)

A consistency group allows a storage device to take a snapshot of multiple volumessimultaneously so that all of the snapshots have the same point-in-time data consistency.

DP pool

Area in which Dynamic Provisioning manages virtual volumes (DP-VOL).

DP-VOL

A virtual volume where physical storage space is only consumed when needed (thinprovisioning).

Dynamic Provisioning

Dynamic Provisioning is Hitachi's implementation of thin provisioning. Instead of reserving afixed amount of storage for a volume, capacity from an available pool (DP pool) is used at thetime data is written to the storage.

Generic volume group (GVG)

A group of volumes. This concept is an extension of consistency group. A GVG eitherguarantees or does not guarantee consistency. A GVG that guarantees consistency is similarto a consistency group, but is operated through different commands. A GVG is also simplyreferred to as a group.

In-band

In the in-band management method, the Configuration Manager REST API server connects tothe storage system through a SAN.

Out-of-band

In the out-of-band management method, the Configuration Manager REST API serverconnects to the storage system through a LAN. This is the default communication mode forthe Configuration Manager REST API server.

Snapshot

Data unit in which data of a volume at any point in time is stored.

Thin Image (Clone)

A copy method where the data on the source volume (DP-VOL) is copied asynchronously tothe destination volume (DP-VOL).

Thin Image (Snapshot)

A copy method where a snapshot of the data on the source volume (DP-VOL) is created on thecopy destination volume (DP-VOL).

TI pool

Thin Image pool used by Thin Image.

Glossary


Hitachi Vantara

Corporate Headquarters

2845 Lafayette Street

Santa Clara, CA 95050-2639 USA

HitachiVantara.com | community.HitachiVantara.com

Contact Information

USA: 1-800-446-0744

Global: 1-858-5474526

HitachiVantara.com/contact

https://www.linkedin.com/company/hitachi-vantara

https://twitter.com/hitachivantara

https://www.facebook.com/HitachiVantara

https://www.youtube.com/user/HDScorp