Openstack Support
Roboconf has a target implementation for Openstack.
It supports the creation of compute VMs and block storage.
To install it, open the DM’s interactive mode and use one of the following options.
With the roboconf:target command:
# The version will be deduced automatically by the DM
roboconf:target openstack
Or with the native Karaf commands:
# Here in version 0.8
feature:install jclouds-for-roboconf
bundle:install --start mvn:net.roboconf/roboconf-target-iaas-openstack/0.8
The implementation can associate a public address to the created VM.
The behavior depends on the target.properties file.
Roboconf keeps memory of the most public address for the created VM.
This address will be used by other components which resolve their dependencies through Roboconf.
As an example, if a MySQL server is deployed on OpenStack but only has an internal address (i.e. not visible the IaaS), then any web application server that uses it will have to be inside the same network. This can lead to some issues in case of hybrid cloud. For the moment, Roboconf does not check anything with respect to this. It is assumed the administrator knows what he does.
Sample target.properties.
Just copy / paste and edit.
# Configuration file for Openstack
handler = iaas-openstack
# Provide a meaningful description of the target
id = a unique identifier
name =
description =
# The URL of Keystone, Openstack's identity component
openstack.keystone-url =
# Credentials to connect
openstack.tenant-name =
openstack.user =
openstack.password =
# VM configuration
openstack.image-name =
openstack.flavor-name = m1.small
openstack.security-group = default
openstack.key-pair = default
# openstack.region-name =
# VM networking
# openstack.floating-ip-pool =
# openstack.network-id =
# Block storage
# openstack.use-block-storage = vol1, vol2
#
# openstack.volume-name.vol1 = cache-%APP%-%NAME%
# openstack.volume-size.vol1 = 10
# openstack.volume-mount-point.vol1 = /dev/vdf
# openstack.volume-type.vol1 = SSD
# openstack.delete-volume-on-termination.vol1 = true
#
# openstack.volume-size.vol2 = 100
# Object storage
#openstack.obj-storage = domain1, domain2
General Parameters
Here is a description of the general parameters for OpenStack.
Block storage is detailed further in the page.
| Property | Description | Default | Mandatory |
|---|---|---|---|
| handler | Determines the target handler to use | none, must be “iaas-openstack” | yes |
| id | A unique identifier for the target properties. | - | yes |
| name | A human-readable name for the target | - | no |
| description | A description of the target. | - | no |
| openstack.keystone-url | The URL of Keystone, Openstack’s identity component. The URL of all the other Openstack services will be found through Keystone. | none | yes |
| openstack.tenant-name | The tenant name (not the ID). | none | yes |
| openstack.user | The name of the user to connect. | none | yes |
| openstack.password | The password of the user to connect. | none | yes |
| openstack.image-name | The name of the VM image or snapshot used as a template for the VM. | none | yes |
| openstack.flavor-name | The hardware configuration for new VMs. Example: m1.tiny | none | yes |
| openstack.security-group | The VM security group | default | yes |
| openstack.key-pair | The name of the key pair used to connect to new VMs. | none | yes |
| openstack.floating-ip-pool | A pool of available public IPs, so that one of them be associated to the VM (if no pool is provided, the VM only has a private IP). | none | no |
| openstack.network-id | A neutron (aka quantum) network ID, to use for networking. | none | no |
| openstack.region-name | The name of the region to use. If not specified, then the first available region will be used. | none | no |
| openstack.obj-storage | A list of container names, separated by a comma, for object storage. Only those that do not already exist will be created. | none | no |
Block Storage
Roboconf’s Openstack driver allows you to create and attach several volumes to a VM.
Here is a sample that will show you to use this feature.
# Create two volumes with different properties.
# vol1 and vol2 are only references to block storages in this configuration file.
# They will not appear anywhere in Openstack meta-data.
openstack.use-block-storage = vol1, vol2
# Volume 1
openstack.volume-name.vol1 = cache-%APP%-%NAME%
openstack.volume-size.vol1 = 10 # Gb
openstack.volume-mount-point.vol1 = /dev/vdf
openstack.volume-type.vol1 = SSD
openstack.delete-volume-on-termination.vol1 = true
# Volume 2: use default values, except for the size.
openstack.volume-size.vol2 = 100 # Gb
Here are the parameters related to block storage in Openstack.
| Property | Description | Default | Mandatory |
|---|---|---|---|
| openstack.use-block-storage | A list of block storage IDs. Items are separated by a comma. | - | no |
| openstack.volume-name. | The prefix to indicate the name of a volume. Since several Roboconf instances may share the same Openstack configuration, it is strongly recommended to use a template tag to define the name. Two templates tags are currently available. %NAME% will be replaced by the instance name. %APP% will be replaced by the application name. | roboconf-%APP%-%NAME% | no |
| openstack.volume-size. | The prefix to specify the volume's size (in Gb). | 5 | no |
| openstack.volume-mount-point. | The prefix to indicate the mount point of the block storage in the created VM. | /dev/vdb | no |
| openstack.volume-type. | The prefix to indicate the volume type. This depends on your Openstack configuration and of the available storages. Example: SSD. To use the default storage type, do not mention this property or let its value empty. | - | no |
| openstack.delete-volume-on-termination. | The prefix to specify whether the volume should be deleted when the VM is terminated. If set to true, the volume will be deleted when the VM is killed. Otherwise, it will remain available for future reuse. | no | false |
Notice that when openstack.delete-volume-on-termination is false, Roboconf will first search for a volume with this name and try to reuse it. If it does not exist, or if the volume is supposed to be deleted after VM termination, then Roboconf will create the volume. This is why persistent block storages should have a unique name in your installation. Roboconf guarantees the uniqueness of the couple (application name, root instance name). This is why you can use the %APP% and %NAME% tags to generate the volume name.
Notice also that creating a volume only means creating a disk.
Attaching it means linking your server with this disk. So, once your server is up, you should find the disk.
On Linux systems, you can use the following command to list the available disks.
sudo fdisk -l
If your volumes were never initialized, you might see something like Disk /dev/vdb doesn't contain a valid partition table.
It means you need to format the disk and mount it in the system. This is not an operation performed by the IaaS. You have to do
it in your system. For Roboconf, we suggest you create a script that will be invoked at startup to format and mount partitions if necessary.
This last point may be improved in the future.
Additional information about volumes configuration can be found here.