Hedvig Plugin For Fuel DocumentationRelease 1.0-1.0.0-1.0

Hedvig Inc.

September 21, 2016

CONTENTS

1 User documentation 11.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11.2 Hedvig Cinder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11.3 License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11.4 Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11.5 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11.6 Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.7 Install Hedvig Cinder Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.8 Configuring Hedvig plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.9 Hedvig Cinder plugin OpenStack operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.10 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101.11 Appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

i

CHAPTER

ONE

USER DOCUMENTATION

1.1 Overview

This document provides instructions for installing, configuring and using Hedvig Cinder plugin for Fuel. Once theHedvig Cinder plugin for fuel has been installed, you can create OpenStack environments that use Hedvig storage asa Cinder backend.

1.2 Hedvig Cinder

The Hedvig Cinder Fuel plugin provides an automated method to insert the necessary lines into the cinder.conf file.The plugin extends the Fuel GUI to provide the necessary entry locations for the information for configuration file.

1.3 License

Component License typeNo Components are present

1.4 Requirements

These are the plugin requirements:

Requirement Version/CommentMirantis OpenStack compatibility 7.0Hedvig Version >= 1.0Controller and Compute Nodes’ Operative System CentOS 6.5/Ubuntu 14.04 LTSOpenStack Cluster (Controller/cinder-volume node) can access Hedvig Cluster via a TCP/IP NetworkOpenStack Cluster (Compute nodes) can access Hedvig Cluster via a TCP/IP Network

1.5 Prerequisites

1. The Hedvig cluster should be configured and on the network prior to starting Cinder with the Hedvig configu-ration in place. In order to deploy cluster Hedvig has to be contacted.

2. Cinder relies on the open-iscsi package to perform many functions such as image to volume. This plugin requiresthe open-iscsi package.

1

Hedvig Plugin For Fuel Documentation, Release 1.0-1.0.0-1.0

1.6 Limitations

1. The only limitation today is that the cinder driver has to run on the controller node therefore the cinder role hasto be assigned to the controller node as well.

1.7 Install Hedvig Cinder Plugin

To install the Cinder Hedvig plugin, follow these steps:

1. Download it from the Fuel Plugins Catalog.

2. Copy the plugin’s RPM to the Fuel Master node (if you don’t have the Fuel Master node, please see MirantisOpenStack User Guide.):

[root@home ~]# scp fuel-plugin-hedvig-cinder-1.0-1.0.0-1.noarch.rpm root@fuel-master:/tmp

3. Log into Fuel Master node and install the plugin using the Fuel CLI:

[root@fuel-master ~]# fuel plugins –install fuel-plugin-hedvig-cinder-1.0-1.0.0-1.noarch.rpm

4. Verify that the plugin is installed correctly:[root@fuel-master ~]# fuel plugins

[root@fuel-master ~]# fuel pluginsid | name | version | package_version---|---------------------------|---------|----------------1 | fuel-plugin-hedvig-cinder | 1.0.0 | 1.0.0

Also can be verified using Plugins tab in Fuel UI.

1.8 Configuring Hedvig plugin

1. Create a new OpenStack environment using the Fuel UI wizard following Mirantis OpenStack User Guide.

2. Create new OpenStack Environment,

1.6. Limitations 2

Hedvig Plugin For Fuel Documentation, Release 1.0-1.0.0-1.0

3. Once the environment is created, open the Settings tab of the Fuel Web UI and scroll down the page. Select theFuel plugin for Hedvig cinder driver option.

4. Configure the plugin. Select Multibackend enabled checkbox if you would like Hedvig driver to be used asthe Cinder Multibackend feature:

5. Add IP address or hostname of a hedvig server node in the cluster.

6. Using Nodes tab, add nodes and assign roles to them. Please, note that all controller nodes should be configured

1.8. Configuring Hedvig plugin 3

Hedvig Plugin For Fuel Documentation, Release 1.0-1.0.0-1.0

with Cinder role.

7. Go to Networks tab, and configure network settings.

1.8. Configuring Hedvig plugin 4

Hedvig Plugin For Fuel Documentation, Release 1.0-1.0.0-1.0

1.8. Configuring Hedvig plugin 5

Hedvig Plugin For Fuel Documentation, Release 1.0-1.0.0-1.0

8. Run the network verification check and press Deploy button once you are done with environment configuration.

9. When the deployment is done, you should see a success message. It may take an hour or more for the OpenStackdeployment to complete, depending on your hardware configuration

Note: Once the OpenStack instance is deployed by Fuel, the Hedvig plugin provides no user configurable ormaintainable options. The Hedvig driver (once configured by Fuel) will output all logs into the cinder-volumeprocess log file with the ‘hedvig’ title.

1.9 Hedvig Cinder plugin OpenStack operations

Once the OpenStack Cluster is setup, we can setup Hedvig Volumes. This is an example in how to create a new Volumeusing Hedvig Storage.

1. Login into the OpenStack Cluster:

1.9. Hedvig Cinder plugin OpenStack operations 6

Hedvig Plugin For Fuel Documentation, Release 1.0-1.0.0-1.0

2. Review the Block storage services by navigating: Admin -> System -> System Information secction. You shouldsee the Hedvig Cinder Volume.

1.9. Hedvig Cinder plugin OpenStack operations 7

Hedvig Plugin For Fuel Documentation, Release 1.0-1.0.0-1.0

3. Review the System Volumes by navigating to: Admin -> System -> Volumes. You should see the HedvigVolume Type:

4. Create a new OpenStack Volume:

1.9. Hedvig Cinder plugin OpenStack operations 8

Hedvig Plugin For Fuel Documentation, Release 1.0-1.0.0-1.0

5. View the newly created Volume:

6. View volume details:

1.9. Hedvig Cinder plugin OpenStack operations 9

Hedvig Plugin For Fuel Documentation, Release 1.0-1.0.0-1.0

7. Volume created on Hedvig cluster can be viewed on Hedvig UI under “Virtual Disk Management”

1.10 Troubleshooting

1. How do I debug a volume creation failure?

(a) Any errors at the time of volume creation will be logged in /var/log/cinder/cinder-volume.log.

(b) If the error is related to the hedvig cinder driver, then you will see a HedvigDriverEx-ception in the logs. When this happens, a corresponding error can be found under/var/log/cinder/cinder/cinder.ERROR.

2. What do I do if I don’t see the virtual disk corresponding to the cinder volume I created?

(a) The main reason for this can be a failure in communication between the hedvig cinder driver and thehedvig server nodes.

(b) Open the /etc/cinder/cinder.conf file and make a note of the value associated with the parameter ‘hed-vig_metadata_server’ under the ‘hedvig’ section. Check whether you can ping this hostname fromthe openstack controller node.

3. When I attach a volume to a compute instance, I don’t see device path listed for that volume. How do I debug this?

(a) This can happen when iscsi utils are not installed on the openstack controller node where the hedvigcinder driver runs.

(b) The openstack nodes in your openstack cluster are missing the /dev/disk/by-path directory. This canhappen when the udev/60-persistent-storage.rules aren’t applied correctly. This is systemd bug that is

1.10. Troubleshooting 10

Hedvig Plugin For Fuel Documentation, Release 1.0-1.0.0-1.0

related to the underlying setup - https://bugs.launchpad.net/ubuntu/+source/systemd/+bug/1193705.

4. When I attach a volume to a compute instance, I get an error. How do I debug this?

(a) To interoperate with the hedvig cluster, every openstack compute host must be associated with a iscsitarget provided by hedvig.

(b) If the attach volume operation fails, the openstack compute node where the corresponding instance isrunning might not have an iscsi target associated with it.

5. I cannot perform an I/O on the cinder volume from the compute instance. How do I debug this?

(a) This indicates that the iscsi target associated with the compute host (where the instance is running) isinoperational.

(b) Restart the iscsi target can fix this issue.

1.11 Appendix

• Hedvig Web Site

• Fuel Enable Experimental Features

• Fuel Plugins Catalog

1.11. Appendix 11