Toggle Menu

Cloud Model


Before deploying an application with the Cloudiator framework the first step is the definition of a cloud target.

For this purpose, three entities have to be created:

  1. An Api, depicting the programming interface the cloud uses, e.g. Nova in case of Openstack.
  2. A Cloud, depicting the endpoint where the API of the cloud is reachable.
  3. A CloudCredential, depicting the user credentials for the given cloud endpoint.

Openstack Example

In this example we will create the required entities using an Openstack Cloud.

For this purpose, we will need the following information for your Openstack Cloud.

  1. The endpoint of the Openstack Cloud.
  2. Your tenant name.
  3. Your username.
  4. Your API password.

For other cloud providers, you can have a look at the examples section of Sword. The code examples list the information required for those providers.

You can easily retrieve this information from the Openstack dashboard:

  1. Login
  2. Select the correct tenant from the tenant dropdown menu near the Openstack logo in the top-left edge. (If it does not exist, you only have one tenant and you can skip this step)
  3. Go to the “Compute” tab on the left navigation bar.
  4. Click Access & Security.
  5. Click the button “Download Openstack RC File”.
  6. Open the file in the editor: endpoint maps to OS_AUTH_URL, tenant maps to OS_TENANT_NAME, username maps to OS_USERNAME and password is most likely the password you also used for dashboard authentication or OS_PASSWORD.

API Interaction

Finally, you can start creating the entities in Cloudiator. Throughout the example, we will list three possibilities: Using the colosseum-client , direct REST (e.g. by using a client like Insomnia) or the user interface.

Before starting you may want to read the basic guide about API authentication and the guides about the respective components.

Create API


    String apiName = "openstack-nova";
    String internalProviderName = "openstack-nova";

        new ApiBuilder().name(apiName)


    "internalProviderName": "openstack-nova",
    "name": "openstack-nova"


Creating a Cloud using the web interface

Create Cloud


Long apiId = 1;
String endpoint = "";
String cloudName = "My Openstack";

    new CloudBuilder().api(apiId).endpoint(endpoint)


    "name": "My Openstack", 
    "endpoint": "", 
    "api": 1 


Creating an API using the web interface

Create CloudCredential


Long cloudId = 1;
String username = "MyCloudUsername";
String secret = "MySecretCloudPassword";

    new CloudCredentialBuilder()


    "user": "MyCloudUsername",
    "secret": "MySecretCloudPassword",
    "cloud": 1,
    "tenant": 1


Creating a Credential using the web interface


After having created the above entities, the discovery of colosseum will start, importing the various offers (Images, Hardware and Locations) of the cloud provider. You can see the discovered entities, when accessing the corresponding API endpoints.