OpenStack Integration

OpenStack HEAT

The mission of the OpenStack Orchestration program is to create a human- and machine-accessible service for managing the entire lifecycle of infrastructure and applications within OpenStack clouds.

Heat is the main project in the OpenStack Orchestration program. It implements an orchestration engine to launch multiple composite cloud applications based on templates in the form of text files that can be treated like code. A native Heat template format is evolving, but Heat also endeavours to provide compatibility with the AWS CloudFormation template format, so that many existing CloudFormation templates can be launched on OpenStack. Heat provides both an OpenStack-native ReST API and a CloudFormation-compatible Query API.

Why ‘Heat’? It makes the clouds rise!

HEAT Provisioning example

In the first part of the lab you have learned:

  • how to design a Service Dialog
  • how to create a Service Catalog
  • put everything together with a Service Catalog Item
  • order from the Service Catalog

In the second part of the lab, we want to use HEAT to create a new instance and to provision an application inside the instance. We are using the probably most popular example: Wordpress. The HEAT template we use, can be found in the OpenStack Git Repository.

Earlier in this lab, we had to create a Service Dialog manually. For a number of templates CloudForms can create a Service Dialog automatically. In this lab we will see how we can create a Service Dialog from a HEAT template. We can still edit this automatically created Service Dialog to adjust it to our needs.

Prepare the HEAT Template

Before we can import the template into CloudForms, we need to download it or have it open in a separate browser window.

Please make sure to use the forked version of the HEAT Template, which has an additional field “Network” defined. Without this field, running the HEAT Template will fail with an error indicating that multiple networks are available and hence a network has to be specified.

  1. Go to the template on the GitHub project page.

  2. Make sure to open the file in “RAW” mode or use this link:

  3. Download the HEAT Template or open it in a separate browser window so you can copy and paste it into the CloudForms Web UI

Import the HEAT Template

The following procedure will import a HEAT template, create a Service Dialog and tie everything together in a service catalog item.

  1. Navigate to Services -> Catalogs

    navigate to services catalogs

  2. Click on Orchestration Templates in the accordion on the left

    orchestration templates

  3. Create a new Orchestration template by clicking on Configuration -> Create new Orchestration Template

  4. Give the template a name and description:

    Name: Wordpress HEAT Template

    Description: This template can be used to deploy a Wordpress instance on OpenStack

    Template Type: OpenStack Heat

    Copy and paste the HEAT Template you downloaded before into the large text area below those fields. Make sure you copy the entire HEAT template by opening the RAW page of the file on GitHub.

    wordpress template

The screenshot is truncated! Make sure you copy the entire HEAT Template! The first line should be:

    heat_template_version: 2013-05-23

And the last line should be:

    host: { get_attr: [wordpress_instance, first_address] }
  1. Click Add to save the orchestration template

    orchestration template saves

Create a Service Dialog from a HEAT template

Earlier in this lab you learned how to manually create a Service Dialog. Now we will see that CloudForms can do this work for us, if we use an orchestration template.

  1. Navigate to the orchestration template you just created

  2. Click on Configuration -> Create Service Dialog from Orchestration Template

    create Service Dialog from wordpress heat template

  3. Enter a name for the new Service Dialog

    Service Dialog Name: Wordpress HEAT Template

    create Service Dialog from orchestration template

  4. Click on Save to create the Service Dialog

    Service Dialog from orchestration template created

Verify the Service Dialog

The Service Dialog was automatically created. We want to verify it was created properly and has all the expected fields.

  1. Navigate to Automation -> Automate -> Customization

    navigate to Automation, Automate, Customization

  2. Navigate to Service Dialogs in the accordion on the left.

    navigate to Service Dialogs

  3. Click on the new Service Dialog “Wordpress HEAT Template”

  4. A preview will show how the Service Dialog will look like, when it’s used in a Service Catalog Item.

    Service Dialog preview

  5. The preview shows us that the Service Dialog is using a default image called “fedora-20.x86_64”. We do not have such an image and want to change the Service Dialog accordingly.

  6. Click on Configuration -> Edit this Dialog. Navigate to the element called “Image” and click the little pen icon next to it.

    edit the image name

  7. Click on Options and then change the value of the field “Default Value”

    Default Value: rhel7

    change the image name

  8. Save the changes of the element by clicking on Save

  9. Commit the changes of the dialog by clicking on Save

  10. You should see an updated preview of your dialog with the new default value “rhel7” in the “Image” field

    after saving the changes

Build a HEAT Service Catalog

The following steps will create a service catalog.

  1. The next step is to create a service catalog. First we have to navigate to Services -> Catalogs.

    navigate to services, catalog

  2. On this screen click on Catalogs on the left

    You should already see three Service Catalogs:

    Ansible: the Service Catalog we created in the Ansible part of the lab

    OpenShift Templates: the Service Catalog we created in the OpenShift part of the lab

    Virtual Machines: the Service Catalog we created in the Virtual Machine part of the lab

    service catalogs

  3. Click on Configuration and Add a New Catalog

  4. Fill out name and description:

    Name: HEAT Templates

    Description: Deploy HEAT Templates from the Catalog

    add a new catalog

  5. Click Add to save the Service Catalog

Build a HEAT Service Catalog Item

To put everything together we create a Service Catalog Item similar to before.

  1. Navigate to Services -> Catalogs

    navigate to services, catalog

  2. Click on Catalog items in the accordion on the left.

    navigate to catalog items

  3. In the Configuration Menu, click on Add a New Catalog Item

  4. Chose the Catalog Item Type. For this example we want to use HEAT on OpenStack which is an Orchestration provider, so click on Orchestration

    select catalog item type

  5. The next dialog will ask for the details for the new Catalog Item

    The name of the Catalog Item shown in the UI:

    Name: Wordpress

    A more descriptive text about the Catalog Item:

    Description: Wordpress from HEAT

    Check the “Display in Catalog” box. If not selected, the Catalog Item will not be visible to users. This can be used for Items which are either still in draft mode, or should only be ordered as a part of a bundle.

    Display in Catalog: check this box

    Select the previously created Service Catalog:

    Catalog: HEAT Templates

    Select the previously created Service Dialog:

    Dialog: Wordpress HEAT Template

    The template to execute:

    Orchestration Template: Wordpress HEAT Template

    Select on which provider the HEAT Template should be executed:

    Provider: OpenStack

    All other fields on this tab can remain unchanged.

    service catalog item details

    For this lab, we want to stick with the out of the box experience and leave those fields unchanged.

Click on the Details tab. You can provide some more descriptive explanation about the Service Catalog Item. We can even use basic HTML formatting in this box.

  1. Finally click on Add to save the Service Catalog Item

    catalog item saved

Order the HEAT Wordpress Catalog Item

For sure you want to test the Catalog Item you just created!

  1. Navigate to Services -> Catalogs and then click on Service Catalogs in the accordion on the left.

    navigate to services, catalog

  2. You should see the Service Catalog Item we just created:

    all services

  3. Click on the Service Catalog Item to see more details.

    service item details

  4. Click on Order

  5. Fill out the form:

    Select the tenant into which you want to deploy. There is only one tenant in OpenStack called “admin”

    Tenant: Admin

    Specify a stack name for your deployment:

    Stack Name: wordpress001

    For all other fields the provided default values can be accepted. Note that the image name is “rhel7” as you specified in your dialog.

    order HEAT template

    Click on Submit to start the deployment.

  6. You will be redirected to the request queue where you can see CloudForms working on your request.

Since we are using nested virtualization to run these labs, performs will be slow and it can take several minutes to complete the request (20-30 minutes).

![after ordering heat service catalog item](/img/summit-fy19-after-ordering-heat.png)