Getting Started with Cloudify

This page will guide you through installing Cloudify and deploying your first Hello World application on your local machine.

Get Started

Install Cloudify Manager locally with Docker then deploy your first application locally or on the cloud

For more advanced users, other manager packages can be downloaded below.

Install Locally

First install Cloudify Manager on your local machine

This tutorial assumes that you have Docker installed on your local machine

Open your terminal and create/start the Docker container (requires password)

sudo docker run --name cfy_manager_local -d --restart unless-stopped -v /sys/fs/cgroup:/sys/fs/cgroup:ro --tmpfs /run --tmpfs /run/lock --security-opt seccomp:unconfined --cap-add SYS_ADMIN -p 80:80 -p 8000:8000 cloudifyplatform/community:19.01.24

↓ Now that you’ve installed Cloudify, continue below and deploy your first application! ↓

Deploy the Hello World Example on your local machine

Using the Terminal
Using the UI

1. Run the Hello-World blueprint inside the container (see the blueprint on Github)

docker exec -it cfy_manager_local sh -c "cfy install https://github.com/cloudify-examples/local-simple-python-webserver-blueprint/archive/master.zip"

2. Go to localhost:8000 in your browser
If you see the following image on the page, you did it!

To check out some more commands to use with Cloudify Manager, run cfy --help
3. Tear down the deployment

docker exec -it cfy_manager_local sh -c "cfy uninstall local-simple-python-webserver-blueprint-master"

4. You can uninstall Cloudify by removing the Docker container using

docker rm -f cfy_manager_local

1. Go to localhost in your browser to see the Cloudify UI. Login and password are both admin.

2. Click on
3. Paste in this URL: https://github.com/cloudify-examples/local-simple-python-webserver-blueprint/archive/master.zip and change the Blueprint name to “local-simple-python-webserver-blueprint” then click “Upload”
4. Go to the Local Blueprints page and click on
5. Give the deployment a name and click “Deploy”
6. Go to the Deployments page, click on and choose “Install” then “Execute”
7. Finally, go to localhost:8000in your browser
If you see the following image on the page, you did it!

Want to learn more about the Cloudify Manager UI? Click on the image at the bottom right corner to take a tour.
8. Tear down your deployment by clicking on and choosing “Uninstall” then “Execute”
9. You can uninstall Cloudify by removing the Docker container using docker rm -f cfy_manager_local in the terminal

Install on the Cloud

First install Cloudify Manager on your local machine

This tutorial assumes that you have Docker installed on your local machine

Open your terminal and create/start the Docker container (requires password)

sudo docker run --name cfy_manager_local -d --restart unless-stopped -v /sys/fs/cgroup:/sys/fs/cgroup:ro --tmpfs /run --tmpfs /run/lock --security-opt seccomp:unconfined --cap-add SYS_ADMIN -p 80:80 -p 8000:8000 cloudifyplatform/community:19.01.24

Deploy the Hello World Example on AWS, GCP, Azure, or OpenStack

Using the Terminal
Using the UI

1. Create the secrets (credentials) on your local manager for the cloud of your choice from the below list:

For AWS

docker exec -it cfy_manager_local sh -c "cfy secrets create aws_access_key_id --secret-string <value>"
docker exec -it cfy_manager_local sh -c "cfy secrets create aws_secret_access_key --secret-string <value>"

For Azure

docker exec -it cfy_manager_local sh -c "cfy secrets create subscription_id --secret-string <value>"
docker exec -it cfy_manager_local sh -c "cfy secrets create tenant_id --secret-string <value>"
docker exec -it cfy_manager_local sh -c "cfy secrets create client_id --secret-string <value>"
docker exec -it cfy_manager_local sh -c "cfy secrets create client_secret --secret-string <value>"

For GCP

docker exec -it cfy_manager_local sh -c "cfy secrets create gcp_client_x509_cert_url --secret-string <value>"
docker exec -it cfy_manager_local sh -c "cfy secrets create gcp_client_email --secret-string <value>"
docker exec -it cfy_manager_local sh -c "cfy secrets create gcp_client_id --secret-string <value>"
docker exec -it cfy_manager_local sh -c "cfy secrets create gcp_project_id --secret-string <value>"
docker exec -it cfy_manager_local sh -c "cfy secrets create gcp_private_key_id -f <value>"
docker exec -it cfy_manager_local sh -c "cfy secrets create gcp_private_key --secret-string <value>"
docker exec -it cfy_manager_local sh -c "cfy secrets create gcp_project_id --secret-string <value>"
docker exec -it cfy_manager_local sh -c "cfy secrets create gcp_zone --secret-string <value>"

For Openstack

docker exec -it cfy_manager_local sh -c "cfy secrets create keystone_username --secret-string <value>"
docker exec -it cfy_manager_local sh -c "cfy secrets create keystone_password --secret-string <value>"
docker exec -it cfy_manager_local sh -c "cfy secrets create keystone_tenant_name --secret-string <value>"
docker exec -it cfy_manager_local sh -c "cfy secrets create keystone_url --secret-string <value>"

2. Upload the default plugins (this takes a few minutes)

docker exec -it cfy_manager_local sh -c "cfy plugins bundle-upload"

3. Run the Hello-World blueprint on the cloud of your choice (see the blueprint on Github):

For AWS

docker exec -it cfy_manager_local sh -c "cfy install https://github.com/cloudify-cosmo/cloudify-hello-world-example/archive/master.zip -n aws.yaml -i aws_region_name=<AWS_REGION_NAME>"

For Azure

docker exec -it cfy_manager_local sh -c "cfy install https://github.com/cloudify-cosmo/cloudify-hello-world-example/archive/master.zip -n azure.yaml -i location=<YOUR_LOCATION> -i agent_password=<CHOOSE_PASSWORD_PER_AZURE_AMDINPWD_REQS>"

For GCP

docker exec -it cfy_manager_local sh -c "cfy install https://github.com/cloudify-cosmo/cloudify-hello-world-example/archive/master.zip -n gcp.yaml region=<YOUR_REGION>"

For Openstack

docker exec -it cfy_manager_local sh -c "cfy install https://github.com/cloudify-cosmo/cloudify-hello-world-example/archive/master.zip -n openstack.yaml -i region=<YOUR_REGION> -i external_network_name=<NETWORK_NAME> -i image=<UBUNTU_TRUSTY_IMAGE_ID> -i flavor=<IMAGE_FLAVOR>"

4. Get the URL of the webserver
For AWS

docker exec -it cfy_manager_local sh -c "cfy deployment outputs cloudify-hello-world-example-master.aws"

For GCP

docker exec -it cfy_manager_local sh -c "cfy deployment outputs cloudify-hello-world-example-master.gcp"

For Azure

docker exec -it cfy_manager_local sh -c "cfy deployment outputs cloudify-hello-world-example-master.azure"

For OpenStack

docker exec -it cfy_manager_local sh -c "cfy deployment outputs cloudify-hello-world-example-master.openstack"

You will see output like this:

Retrieving outputs for deployment cloudify-hello-world-example-master.aws...
 - "application_endpoint":
     Description: The external endpoint of the application.
     Value: http://3.122.71.142:80

Copy and paste the URL “Value” into your browser, and if you see something similar to the below image on the page, you did it!

To check out some more commands to use with Cloudify Manager, run cfy --help
5. Tear down the deployment

docker exec -it cfy_manager_local sh -c "cfy uninstall cloudify-hello-world-example-master.<aws/gcp/azure/openstack>"

6. You can uninstall Cloudify by removing the Docker container using

docker rm -f cfy_manager_local

1. Go to localhost in your browser to see the Cloudify UI. Login and password are both admin.

2. Go to “Cloudify Catalog” on the left side menu and find the Plugins widget. Click for the Cloudify plugin for your specific cloud (AWS SDK for AWS) and choose “Upload”.

3. Go to “System Resources” on the left side menu and scroll down to the ‘Secret Store Management’ widget. Create secrets using the ‘Create’ button according to your cloud provider’s specifications (make sure to use the exact names below for each secret):

aws_access_key_id
aws_secret_access_key

For Azure

subscription_id
tenant_id
client_id
client_secret

For GCP

gcp_client_x509_cert_url
gcp_client_email
gcp_client_id
gcp_project_id
gcp_private_key_id
gcp_private_key
gcp_project_id
gcp_zone

For OpenStack

keystone_username
keystone_password
keystone_tenant_name
keystone_url

4. Go to “Local Blueprints” on the left side menu and click the “Upload” button.

In the “Blueprint package” URL section paste https://github.com/cloudify-cosmo/cloudify-hello-world-example/archive/master.zip and hit Tab to autofill the rest.
In the “Blueprint YAML file” section select the file based on your cloud (aws.yaml, azure.yaml, etc). Then, click “upload”.

5. In the Blueprints widget, find the ‘cloudify-hello-world-example-master’ blueprint and click on .

Type cloudify-hello-world-example-master in the deployment name field
Complete the inputs’ values:

For AWS

aws_region_name

For Azure

location
agent_password

For GCP

region

For Openstack

region
external_network
image
flavor

Click “Deploy”

6. Go to Deployments on the left side menu, find your deployment, then click the hamburger menu on the right and select “Install” and “Execute”.

7. Click on your blueprint link to see the details and scroll down a bit to find the “Deployment Outputs” widget which will contain the URL of your application. Paste that URL into your browser.
If you see the something similar to the following image on the page, you did it!

Want to learn more about the Cloudify Manager UI? Click on the image at the bottom right corner to take a tour.
8. Tear down your deployment by going back to the Deployments menu, clicking on , and choosing “Uninstall” then “Execute”
9. You can uninstall Cloudify by removing the Docker container using docker rm -f cfy_manager_local in the terminal