Skip to content

Deployment Fields

The specification for Deployment has these fields:

type

Note

The other metadata in this section should be completed according to the type (e.g. CloudBroker-specific metadata is not required if type: edge)

cloudbroker

Cloudbroker

deployment_id

Required-string (UUID)
A CloudBroker deployment ties together software, resource and region. Indicative IDs are given below, but any LTS Debian-based Linux distribution should be supported. It is recommended to use the MiCADO-Optimised deployment.

1860cb3f-4f23-417f-a1f1-3705158cd3b3

16b1e2d4-3a2c-406e-8c45-5637099021f0

5a081b54-8992-4ff7-8a21-74e425062507

# Find a deployment_id by inspecting the URL
https://<cloudbroker-endpoint>/deployments/<deployment-id>
instance_type_id

Required-string (UUID)
The CloudBroker instance type defines the CPU and RAM that will be available on the infrastructure. Indicative IDs are given below. The minimum requirements are a 2 vCPU/2GB RAM

ca727925-a5ca-4697-b2c3-8788d82457d5

ffb42759-fb52-4401-9c75-889ea0ed9602

664330f3-42b1-4f52-a675-fd182a21ef51

# Find an instance_type_id by inspecting the URL
https://<cloudbroker-endpoint>/instance_types/<instance-type-id>
key_pair_id

Optional-string (UUID)
ID of CloudBroker Key Pair

# Find a key_pair_id by inspecting the URL
https://<cloudbroker-endpoint>/key_pairs/<key-pair-id>
opened_port

Required-string (comma separated integers)
A comma-separated string listing port numbers, which will be opened on the instance (both TCP and UDP protocols will be affected).

Danger

Port 51820 must be included in this list to ensure containers can communicate

51820

51820,22,80,443
cloud_config

Optional-string (JSON)
cloud-init config for contextualisation of the provisioned virtual machine.

{"runcmd": ["echo 'task one'", "echo 'task two'"]}
endpoint

Required-string (URL)
The endpoint of the CloudBroker platform that will handle the deployment of the above infrastructure.

https://cloudsme-cbp.scaletools.com.ua
domain_name

Optional-string
Subdomain (on cbp-routing.ch) to create and attach to this instance using dynamic DNS. For the given example, the domain my-subdomain.cbp-routing.ch will be assigned to the instance.

Warning

Only letters, numbers and hyphens are allowed in domain names.

my-subdomain

Edge

endpoint

Required-string
The endpoint of the bring-your-own Edge device that provides this Deployment.

192.168.1.1
ssh_private_key

Optional-String
private key for SSH connection.

-----BEGIN RSA PRIVATE KEY-----
MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tPf9Cnzj4p4WGeKLs1Pt8Qu
KUpRKfFLfRYC9AIKjbJTWit+CqvjWYzvQwECAwEAAQJAIJLixBy2qpFoS4DSmoEm
...
ssh_username

Optional-String
username for SSH connection. Defaults to ubuntu

ubuntu