☰

OpenStack hello-world

This example demonstrates a simple infrastructure setup in OpenStack, the deployment consists of:

In this example we will deploy virtual infrastructure and a “hello world” application using the OpenStack and Ansible plugins.

Prerequisites

This example expects the following prerequisites:

Cloudify CLI or Cloudify Management Console?

Cloudify allows for multiple user interfaces. Some users find the Cloudify Management Console (web based UI) more intuitive while others prefer the Cloudify CLI (Command Line Interface). This tutorial and all following ones will describe both methods.

Cloudify Management Console

This section explains how to run the above described steps using the Cloudify Management Console. The Cloudify Management Console and Cloudify CLI can be used interchangeably for all Cloudify activities.

Create Secrets

To connect to OpenStack, credentials are required. Cloudify recommends storing such sensitive information in a Cloudify secret. Secrets are kept encrypted in a secure way and used in run-time by the system. Learn more about Cloudify secrets here.

OpenStack credentials can be downloaded by following the guide here.

To store the access keys as secrets in the Cloudify Manager, login to the Cloudify Management Console and select the System Resources page. Scroll to the Secret Store Management widget and use the Create button to add the following new secrets:

* openstack_username
* openstack_password
* openstack_tenant_name
* openstack_auth_url
* openstack_external_network
* openstack_region
* base_image_id
* base_flavor_id
* openstack_user_domain_name
* openstack_project_domain_name

Notes

Required secrets for this example

Upload Plugins

Plugins are Cloudify’s extendable interfaces to services, cloud providers and automation tools. I.e., connecting to OpenStack requires the OpenStack plugin.

To upload the required plugins to your manager, select the Cloudify Catalog page, scroll to the Plugins Catalog widget and select the plugins you wish to upload.

For this example, upload the following plugins:

Upload Blueprint

A blueprint is a general purpose model for describing systems, services or any orchestrated object topology. Blueprints are represented as descriptive code (yaml based files) and typically stored and managed as part of the source repository. The blueprint is available here.

The flow required to setup a service consists of:

  1. Upload the blueprint describing the service to the Cloudify Manager.
  2. Create a deployment from the uploaded blueprint. This generates a model of the service topology in the Cloudify database and provides the “context” needed for running workflows.
  3. Run the install workflow for the created deployment to apply the model to the infrastructure.

Let’s run these one by one.

To upload a blueprint to the Cloudify Manager, select the Cloudify Catalog page, and use the Upload blueprint button next to the OpenStack-Basics-Simple-Service-Setup blueprint.

Deploy & Install

Once the blueprint is uploaded, it will be displayed in the Blueprints widget. to deploy the blueprint click the Create deployment button next to the blueprint you wish to deploy. Specify a deployment name, update any inputs, and click Deploy & Install. Changing inputs is completely optional and the defaults are safe to use.

You will be directed to the Deployment page and will be able to track the progress of the execution.

The deployment you have created should be displayed in the deployments list in the Deployments page.

Track the progress of a Workflow

Validate

In this example we have setup a simple infrastructure. A virtual instance (VM) was created in the region specified in the Deployment inputs alongside a new network and various other resources.

To access your new service, you can look at the Deployment Outputs/Capabilities widget on the Deployment screen to find your new application_endpoint output containing a URL to the service. Simply put that URL into a web browser to view the deployed service.

Get Deployment outputs

Teardown

To remove the deployment and destroy the orchestrated service, run the Uninstall workflow by clicking the Execute workflow menu next to the deployment, expanding Default workflows, and selecting Uninstall.

Cloudify CLI

Create a CLI profile instructing your CLI how to connect with the Cloudify Manager by running the following CLI commands

cfy init
cfy profiles use <your manager hostname / URL / IP> -u admin -p <the admin  password> --ssl
cfy profiles set --manager-tenant default_tenant

Create Secrets

To enable Cloudify to connect to OpenStack, credentials are required. Cloudify recommends storing such sensitive information as a Cloudify secret. Secrets are encrypted in a secure way and used during run-time by the system. Learn more about Cloudify secrets here.

OpenStack credentials can be created by following the guide here.

To store the access keys as secrets via the Cloudify CLI, run the following (replacing with the actual string retrieved from OpenStack):

cfy secrets create openstack_username --secret-string <user_name>
cfy secrets create openstack_password --secret-string <password>
cfy secrets create openstack_tenant_name --secret-string <tenant_name>
cfy secrets create openstack_auth_url --secret-string <url>
cfy secrets create openstack_external_network --secret-string <external_network_name>
cfy secrets create openstack_region --secret-string <openstack_region>
cfy secrets create base_image_id --secret-string <base_image_id>
cfy secrets create base_flavor_id --secret-string <base_flavor_id>
cfy secrets create openstack_user_domain_name --secret-string <value>
cfy secrets create openstack_project_domain_name --secret-string <value>

Notes

Advanced users tip:

You can also source the OpenStack RC file, then use the environment variables, for example:

cfy secrets create openstack_username -s ${OS_USERNAME}

Upload Plugins

Plugins are Cloudify’s extendable interfaces to services, cloud providers, and automation tools. Connecting to OpenStack requires the OpenStack plugin. You may upload specific plugins or, for simplicity, upload the plugin bundle containing all of the basic, pre-packaged, plugins.

To upload the default plugins bundle (this may take a few minutes depending on your internet speed):

cfy plugins bundle-upload

Tip: Read more about plugins and writing your own plugins.

Upload Blueprint and Deploy

A blueprint is a general purpose model for describing systems, services or any orchestrated object topology. Blueprints are represented as descriptive code (YAML-based files) and are typically stored and managed as part of the source code repository.

The OpenStack infrastructure blueprint is available here.

Uploading a blueprint to Cloudify can be done by direct upload or by providing the link in the source code repository. The flow to do that is:

  1. Upload the blueprint.
  2. Create a deployment from the uploaded blueprint. This generates a model of the service topology in the Cloudify database and provides the “context” needed for running workflows.
  3. Run the install workflow for the created deployment to apply the model to the infrastructure.

In order to perform this flow as a single unit, we will use the install command.

cfy install https://github.com/cloudify-community/blueprint-examples/releases/download/latest/hello-world-example.zip -n openstack.yaml

Validate

In this example we have setup a simple infrastructure. A virtual instance (VM) was created in the region specified in the Deployment inputs alongside a new network and various other resources.

$ cfy nodes list -d hello-world-example.openstack

Listing nodes for deployment hello-world-example.openstack...

Nodes:
+------------------+-------------------------------+-------------------------------+---------+----------------------------------------+------------+----------------+---------------------+-----------------------------+------------+
|        id        |         deployment_id         |          blueprint_id         | host_id |                  type                  | visibility |  tenant_name   | number_of_instances | planned_number_of_instances | created_by |
+------------------+-------------------------------+-------------------------------+---------+----------------------------------------+------------+----------------+---------------------+-----------------------------+------------+
|    cloud_init    | hello-world-example.openstack | hello-world-example.openstack |         |  cloudify.nodes.CloudInit.CloudConfig  |   tenant   | default_tenant |          1          |              1              |   admin    |
|        ip        | hello-world-example.openstack | hello-world-example.openstack |         |  cloudify.nodes.openstack.FloatingIP   |   tenant   | default_tenant |          1          |              1              |   admin    |
|      subnet      | hello-world-example.openstack | hello-world-example.openstack |         |    cloudify.nodes.openstack.Subnet     |   tenant   | default_tenant |          1          |              1              |   admin    |
|   hello-world    | hello-world-example.openstack | hello-world-example.openstack |         |    cloudify.nodes.ansible.Playbook     |   tenant   | default_tenant |          1          |              1              |   admin    |
|     network      | hello-world-example.openstack | hello-world-example.openstack |         |    cloudify.nodes.openstack.Network    |   tenant   | default_tenant |          1          |              1              |   admin    |
|  security-group  | hello-world-example.openstack | hello-world-example.openstack |         | cloudify.nodes.openstack.SecurityGroup |   tenant   | default_tenant |          1          |              1              |   admin    |
|        vm        | hello-world-example.openstack | hello-world-example.openstack |    vm   |    cloudify.nodes.openstack.Server     |   tenant   | default_tenant |          1          |              1              |   admin    |
| external-network | hello-world-example.openstack | hello-world-example.openstack |         |    cloudify.nodes.openstack.Network    |   tenant   | default_tenant |          1          |              1              |   admin    |
|      router      | hello-world-example.openstack | hello-world-example.openstack |         |    cloudify.nodes.openstack.Router     |   tenant   | default_tenant |          1          |              1              |   admin    |
|       port       | hello-world-example.openstack | hello-world-example.openstack |         |     cloudify.nodes.openstack.Port      |   tenant   | default_tenant |          1          |              1              |   admin    |
+------------------+-------------------------------+-------------------------------+---------+----------------------------------------+------------+----------------+---------------------+-----------------------------+------------+

Showing 10 of 10 nodes

Tip: To check out some more commands to use with the Cloudify Management Console, run cfy --help

To get the Outputs of our deployment run:

cfy deployment outputs hello-world-example.openstack

The returned output would look like:

Retrieving outputs for deployment hello-world-example.openstack...
 - "application_endpoint":
     Description: The external endpoint of the application.
     Value: http://40.79.42.39:80

Copy and paste the URL Value into your browser, you should see a simple web page.

An even easier way to review your deployment is through the Cloudify Management Console. Login to the console and browse to the Deployments page. Select the deployment (hello-world-example.openstack) and explore the topology, inputs, outputs, nodes, and logs.

Successful Cloudify Deployment

This is also a good time to examine the blueprint used in the example. The blueprint can be examined in the Cloudify Management Console, however in this case we will go to the Cloudify examples repository in Github and examine it there: hello-world-example

Teardown

To remove the deployment and delete all resources from OpenStack simply run the uninstall command:

cfy uninstall hello-world-example.openstack