1. Home

Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

name	path	methods	description
CloudConfigurationController0	/user/v0.0/switch/account/configure/ec2 /user/v0.0/switch/account/configure/geni	POST POST	This controller is responsible for handling cloud credentials used by the provisoner to request for resources (VMs).
CloudCredentialsController	/user/v1.0/credentials/cloud /user/v1.0/credentials/cloud/ids /user/v1.0/credentials/cloud/{id} /user/v1.0/credentials/cloud/upload/{id}	POST GET DELETE GET POST	This controller is responsible for handling CloudCredentials. CloudCredentials are a represntation of the credentials that are used by the provisoner to request for resources (VMs)
DeployController	/user/v1.0/deployer/ids /user/v1.0/deployer/{id} /user/v1.0/deployer/deploy/{id}/	GET DELETE GET GET	This controller is responsible for deploying a cluster on provisoned resources.
DeployController0	/user/v0.0/switch/deploy/kubernetes /user/v0.0/switch/deploy/swarm	POST POST	This controller is responsible for deploying a cluster on provisoned resources.
PlannerController	/user/v1.0/planner/ids /user/v1.0/planner/{id} /user/v1.0/planner/plan/{tosca_id} /user/v1.0/planner/tosca/{id}	GET DELETE GET GET GET	This controller is responsible for planing the type of resources to be provisopned based on a TOSCA description.
PlannerController0	/user/v0.0/switch/plan/planning	POST	This controller is responsible for planing the type of resources to be provisopned based on a TOSCA description.
ProvisionController	/user/v1.0/provisioner/ids /user/v1.0/provisioner/provision /user/v1.0/provisioner/{id}	GET POST DELETE GET	This controller is responsible for obtaining resources from cloud providers based the plan generated by the planner
ProvisionController0	/user/v0.0/switch/provision/execute /user/v0.0/switch/provision/upload	POST POST	This controller is responsible for obtaining resources from cloud providers based the plan generated by the planner and uploaded by the user
ToscaController	/user/v1.0/tosca/ids /user/v1.0/tosca/upload /user/v1.0/tosca/{id}	DELETE GET HEAD OPTIONS PATCH POST PUT TRACE POST DELETE GET	This controller is responsible for storing TOSCA descriptions that can be used by the planner.
UserController	/manager/v1.0/user//all /manager/v1.0/user//ids /manager/v1.0/user//modify /manager/v1.0/user//register /manager/v1.0/user//{id}	GET GET POST POST DELETE GET	This controller is responsible for handling user accounts
UserController0	/manager/v0.0/switch/account/register	POST	This controller is responsible for handling user accounts
UserPublicKeysController	/user/v1.0/user_key /user/v1.0/user_key/ids /user/v1.0/user_key/upload /user/v1.0/user_key/{id}	POST GET POST DELETE GET	This controller is responsible for handling user public keys. These keys can be used by the provisoner to allow the user to login to the VMs from the machine the keys correspond to.
UserPublicKeysController0	/user/v0.0/switch/provision/confuserkey	POST	This controller is responsible for handling user public keys. These keys can be used by the provisoner to allow the user to login to the VMs from the machine the keys correspond to.
UserScriptController	/user/v1.0/user_script/ids /user/v1.0/user_script/upload /user/v1.0/user_script/{id}	GET POST DELETE GET	This controller is responsible for handling user scripts. These user can be used by the provisoner to run on the created VMs.
UserScriptController0	/user/v0.0/switch/provision/confscript	POST	This controller is responsible for handling user scripts. These user can be used by the provisoner to run on the created VMs.

Data Types

JSON

type	description
CloudCredentials	This class represents the cloud credentials for a cloud. They are used by the provisoner to request for resources.
ClusterCredentials	This class represents the cluster credentials for a cloud. They can used to login to the cluster created by the deployer
DeployParameter
KeyValueHolder
LoginKey	This class represents a login key. This key can be used to either login to a VM created by the provisiner or by the VM to allow the user to login to the VMs from the machine the keys correspond to.
OwnedObject
Plan	This class represents a plan generated by the planner.
ProvisionInfo
Script	This class represents a simple script that can run on a provisioned VM.
ToscaRepresentation
Type
User	This class represents a user.

XML

Default Namespace (schema)

type	description
attribute
confScript
confUserKey
configure
deploy
execute
loginKey0
plan	This class represents a plan to be provided to the planner.
register
result
upload
cloudCredentials	This class represents the cloud credentials for a cloud. They are used by the provisoner to request for resources.
clusterCredentials	This class represents the cluster credentials for a cloud. They can used to login to the cluster created by the deployer
deployParameter
keyValueHolder
loginKey	This class represents a login key. This key can be used to either login to a VM created by the provisiner or by the VM to allow the user to login to the VMs from the machine the keys correspond to.
type
ownedObject
provisionInfo
script	This class represents a simple script that can run on a provisioned VM.
toscaRepresentation
user	This class represents a user.