rhosp-vxflexos-deploy

Deployment tools for DellEMC VxFlex OS support in RedHat OpenStack Platform 13.

Overview

This instruction provide detailed steps on how to enable VxFlex OS driver.

NOTICE: this README represents only the basic steps necessary to enable VxFlex OS driver. It does not contain steps on how update the overcloud or other components of the system applicable to your particular installation.

For more information please refer to Product Documentation for Red Hat OpenStack Platform 13.

Prerequisites

• Red Hat OpenStack Platform 13.
• VxFlex OS Gateway has to be installed and accessible in the network.
• VxFlex OS Storage Data Client (SDC) has to be installed on all OpenStack nodes.

Steps

Prepare DellEMC container images

Red Hat OpenStack Platform supports remote registry and local registry for overcloud deployment. In this document, we only introduce local registry.

in below examples, 192.168.24.1:8787 acts as a local registry.

Get container images

There are 2 options to get container images:

Pull container images from Red Hat Container Catalog

Login to the registry.connect.redhat.com and pull container images from Red Hat Container Catalog.

$ docker login -u username -p password registry.connect.redhat.com
$ docker pull registry.connect.redhat.com/dellemc/rhosp13-cinder-volume-dellemc-vxflexos
$ docker pull registry.connect.redhat.com/dellemc/rhosp13-nova-compute-dellemc-vxflexos
$ docker pull registry.connect.redhat.com/dellemc/rhosp13-glance-api-dellemc-vxflexos

Build container images from the Dockerfiles

Build images for both cinder and nova containers from Dockerfiles.

$ docker build -f Dockerfile-cinder .
$ docker build -f Dockerfile-nova .
$ docker build -f Dockerfile-glance .

Push container images to the local registry

Tag and push it to the local registry.

$ docker tag <image_id> 192.168.24.1:8787/dellemc/openstack-cinder-volume-dellemc-vxflexos
$ docker push 192.168.24.1:8787/dellemc/openstack-cinder-volume-dellemc-vxflexos

$ docker tag <image_id> 192.168.24.1:8787/dellemc/openstack-nova-compute-dellemc-vxflexos
$ docker push 192.168.24.1:8787/dellemc/openstack-nova-compute-dellemc-vxflexos

$ docker tag <image_id> 192.168.24.1:8787/dellemc/openstack-glance-api-dellemc-vxflexos
$ docker push 192.168.24.1:8787/dellemc/openstack-glance-api-dellemc-vxflexos

Prepare custom environment yaml

Define the custom docker registry

Create or edit /home/stack/templates/custom-dellemc-container.yaml.

parameter_defaults:
  DockerCinderVolumeImage: 192.168.24.1:8787/dellemc/openstack-cinder-volume-dellemc-vxflexos
  DockerCinderBackupImage: 192.168.24.1:8787/dellemc/openstack-cinder-volume-dellemc-vxflexos
  DockerNovaComputeImage: 192.168.24.1:8787/dellemc/openstack-nova-compute-dellemc-vxflexos
  DockerGlanceApiImage: 192.168.24.1:8787/dellemc/openstack-glance-api-dellemc-vxflexos
  DockerGlanceApiConfigImage: 192.168.24.1:8787/dellemc/openstack-glance-api-dellemc-vxflexos
  DockerInsecureRegistryAddress:
    - 192.168.24.1:8787

Above adds the director local registry IP 192.168.24.1:8787 to the undercloud.

Prepare environment yaml for VxFlex OS cinder backend

Create or edit /home/stack/templates/custom-dellemc-cinder-conf.yaml.

If you do not want to use Cinder as a Glance backend to store images, remove GlanceBackend: cinder from the following yaml.

parameter_defaults:  
  GlanceBackend: cinder
  ControllerExtraConfig:
    cinder::config::cinder_config:
      scaleio/volume_driver:
        value: cinder.volume.drivers.dell_emc.scaleio.driver.ScaleIODriver
      scaleio/volume_backend_name:
        value: scaleio
      scaleio/san_ip:
        value: <VxFlexOS GATEWAY IP>
      scaleio/san_login:
        value: <SIO_USER>
      scaleio/san_password:
        value: <SIO_PASSWD>
      scaleio/sio_storage_pools:
        value: <Comma-separated list of protection domain:storage pool name>
    cinder_user_enabled_backends: ['scaleio']

For full detailed instruction of options please refer to VxFlex OS backend configuration.

Prepare custom volume mappings for connector configuration

Create or edit /home/stack/templates/custom-dellemc-volume-mappings.yaml.

parameter_defaults:
  NovaComputeOptVolumes:
    - /opt/emc/scaleio/openstack:/opt/emc/scaleio/openstack
  CinderVolumeOptVolumes:
    - /opt/emc/scaleio/openstack:/opt/emc/scaleio/openstack
  GlanceApiOptVolumes:
    - /opt/emc/scaleio/openstack:/opt/emc/scaleio/openstack

Deploy configured changes

(undercloud) $ openstack overcloud deploy --templates \
  -e /home/stack/templates/overcloud_images.yaml \
  -e /home/stack/templates/custom-dellemc-container.yaml \
  -e /home/stack/templates/custom-dellemc-cinder-conf.yaml \
  -e /home/stack/templates/custom-dellemc-volume-mappings.yaml \
  -e <other templates>

The sequence of -e matters, Make sure the /home/stack/templates/custom-dellemc-container.yaml appears after the /home/stack/templates/overcloud_images.yaml, so that custom VxFlex OS containers can be used instead of the default one.

Verify configured changes

After the deployment finishes successfully, /etc/cinder/cinder.conf in the Cinder container should reflect changes made above.

[DEFAULT]
...
enabled_backends=scaleio
...
[scaleio]
round_volume_capacity=True
san_ip=192.168.100.200
san_login=admin
san_password=password
san_thin_provision=True
sio_protection_domain_name=domain1
sio_storage_pool_name=pool1
sio_storage_pools=domain1:pool1
sio_unmap_volume_before_deletion=True
volume_backend_name=scaleio
volume_driver=cinder.volume.drivers.dell_emc.scaleio.driver.ScaleIODriver
...

Configure connector

Before using attach/detach volume operations VxFlex OS connector must be properly configured. On each node where VxFlex OS SDC is installed do the following:

1. Create /opt/emc/scaleio/openstack/connector.conf if it does not exist.

   $ mkdir -p /opt/emc/scaleio/openstack
   $ touch /opt/emc/scaleio/openstack/connector.conf

2. For each VxFlex OS section in the cinder.conf create the same section in the /opt/emc/scaleio/openstack/connector.conf and populate it with passwords. Example:

   [vxflexos]
   san_password = SIO_PASSWD
   replicating_san_password = REPLICATION_SYSTEM_SIO_PASSWD # if applicable
   
   [vxflexos-new]
   san_password = SIO2_PASSWD
   replicating_san_password = REPLICATION_SYSTEM_SIO2_PASSWD # if applicable

OpenStack Fast Forward Upgrades OSP10 -> OSP13

To upgrade your RHOSP10 environment to RHOSP13 Red Hat FFU Documentation has to be used.

In order to use VxFlex OS cinder backend custom container sources and cinder configuration should be included in openstack overcloud ffwd-upgrade prepare/converge commands.

NOTICE: if kernel version or OS version changed during upgrade procedure then appropriate VxFlex OS Storage Data Client (SDC) has to be installed.