Setting Up OpenStack VMR Machine Images

This tutorial will walk you through the steps required to get a single Solace Virtual Message Router (VMR) machine image instance running in OpenStack and ready for messaging.

Assumptions

  • You have access to an OpenStack deployment.

System Requirements

For Evaluation and Enterprise VMR editions, the system resources that you provision for the VM automatically determines the number of client connections to the VMR that can be made. If you provision:

  • 30 GB of disk space, 4 GB of RAM, and two vCPUs—a maximum of 1,000 client connections are possible. This is the minimum required system resources.
  • 30 GB of disk space, 12 GB of RAM, and four vCPUs or greater—a maximum of 10,000 client connections are possible.

For Community VMR editions, a maximum of 100 client connections is permitted. Increasing the system requirements will not increase the number of available client connections.

Note:  To deploy VMRs in high-availability (HA) redundancy groups, you must set up three separate VMR instances as discussed in this section, and then configure them appropriately as a group. For more information on how to configure existing VMRs as an HA group, see Managing VMR Redundancy.

Step 1: Get a VMR

The first requirement is to download an edition of the VMR. For Openstack, the VMR is distributed as a Compressed QCOW2.

  • Evaluation or Community edition of the VMR—Go to dev.solace.com/downloads/, then in the VMR Community Edition or VMR Evaluation Edition areas, select Cloud Images, then select OpenStack (Cloud QCOW2). After you read and agree to the license agreement, a compressed QCOW2 file called soltr-<version>-vmr-<type>.qcow2.xz will be downloaded.
  • Enterprise version of the VMR—If you have purchased an Enterprise version of the VMR, Solace will provide information for how to download an enterprise version of the VMR QCOW2 file package from a secure Solace server. Contact Solace Support at support@solace.com if you require assistance.

Once you have the compressed QCOW2 package, you need to extract it so that you are left with the desired QCOW2 image. The compressed QCOW2 can be extracted using the tar command.
Extract qcow2 image
Then you are left with a file called soltr-<version>-vmr-cloud-<type>.qcow2. This is the file you will use going forward with OpenStack.
Note: Some OpenStack implementations claim to support direct qcow2.tar.gzfiles imports. However, Solace strongly recommends importing a decompressed image.

Step 2: Import the VMR into OpenStack

Note: Your OpenStack GUI may be slightly different than shown below. The following procedure may need to be adjusted to work in your OpenStack environment.

To import the VMR into OpenStack and start it with a basic configuraiton, do the following:

  1. In the OpenStack GUI under Images, click Create Image.
    Create OpenStack Image
  2. Enter details for your VMR Image, then click Create Image. The creation of the image may take several minutes to complete.
  3. Prior to launching an instance base on the newly created image, you should configure a security group to be used by the instance.

    Go to Access & Security and select Create Security Group. When prompted, provide a name and description, then select Create Security Group.The new security group will appear in the list of configured security groups.

    The next step is to an appropriate security rule for each port that the VMR uses for a service to enable connectivity to your VMR; Select Manage Rules.

    For information on the default ports the VMR uses, refer to VMR Configuration Defaults. The example below includes rules for all service ports that the VMR may use. Alternatively you may only expose the services required for your application.

    Note:   

    • Consult your local security policy before configuring access rules.
    • If you will be using the VMR in an HA redundancy group with other VMRs, you must ensure that a UDP security rule is created for port 5404, and TCP security rules are created for ports 5405 and 8741.

    Security Group Rules

  4. To launch the instance, go to Images, and click Launch Instance.
  5. On the Details tab, specify an Instance Name and Flavor; under Instance Boot Source, select Boot from Image; and under Image Name, select the VMR image that was created in the previous section.

    Note:  The VMR will inherit the Instance Name as its hostname.

    OpenStack Instance Details

  6. On the Access & Security tab, select or create a Key Pair, and assign a security group.
    OpenStack Access and Security
  7. On the Networking tab, assign one and only one network interface to the VMR.
    OpenStack Networking Properties
  8. Click the Launch button. The VMR will launch and the OpenStack dashboard will display the running instance. Here you can find the IP address of the instance.
    OpenStack Dashboard
  9. To log into the Linux Host shell, enter the following command:

    ssh -p 2222 -i <auth_key> sysadmin@<public_ip>

Step 3: Access the Solace CLI

You can access the Solace CLI from the console in the Linux host environment. This is done through the Solace Control Utility.

When you first access the Solace CLI, you should do the following:

  • set a password for the admin user, which has access to all CLI commands
  • determine the VMR’s IP address so that you can enable remote access

  • To access the Solace CLI, do the following:
    1. To enter the Solace CLI from the console in the Linux host environment, enter the following command in the Linux host shell.

      [sysadmin@solace ~]$ solacectl cli

      A CLI banner and prompt appears.

      At the > prompt, you are at the User EXEC level of the Solace CLI command structure.

    2. Within the Solace CLI, enter the following commands to set the password for the admin user:

      solace> enable

      solace# configure

      solace(configure)# username admin

      solace(configure/username)# change-password <password>

    3. To determine the IP address assigned to the VMR, enter the following command:

      solace> show ip vrf management

      The displayed output lists the IP address assigned to the VMR (listed for eth0:1), which can be used to remotely manage the VMR (that is, not from the VM console).

      show ip vrf management command

    4. To remotely access the Solace CLI for the VMR, you can now ssh to port 22 of the VMR’s IP address and login in as the admin user.
  • Tip:  In addition to the admin CLI User, you can create additional CLI and file transfer users through the Solace CLI in the manner described in Managing Management User Authentication/Authorization.

    Step 4: Review VMR Configuration Defaults

    Unlike a Solace appliance, by default, a VMR starts with a basic configuration that has most common services enabled and ready for use. This basic configuration and the default ports that are used can be modified as required. For details, see VMR Configuration Defaults.

    Additional VMR Machine Image Configuration

    You now have a VMR machine image with a basic configuration that is ready for messaging tasks. However, there are additional configuration tasks that you can perform. At this stage, you should do the following:

    1. Review the extra configuration tasks specific to VMR machine images presented on the Additional VMR Machine Image Configuration page.

      These additional configurations allow you to further customize your VMR machine image to better suit your particular use-case and to make it more suitable for a production deployment.

    2. Begin to configure and manage the VMR machine image’s messaging operations through the Solace CLI in the same manner as you would other Solace messaging routers (say, a Solace messaging appliance or a Solace VMR Docker container). For information on how to perform these configuration and management tasks, see the topics in the Router Configuration category of the Solace customer documentation.