MiCADO Nodes

Methods available on client.micado:

class micado.models.micado.Micado
attach(micado_id)

Configure the micado object to handle the instance created by the def:create()

Parameters:

micado_id (string) – micado ID returned by def:create()

create(**kwargs)

Creates a new MiCADO VM and deploy MiCADO services on it.

Parameters:

  • auth_url (string) – Authentication URL for the NOVA resource.

  • image (string) – Name or ID of the image resource.

  • flavor (string) – Name or ID of the flavor resource.

  • network (string) – Name or ID of the network resource.

  • keypair (string) – Name or ID of the keypair resource.

  • security_group (string, optional) – name or ID of the security_group resource. Defaults to ‘all’.

  • region (string, optional) – Name of the region resource. Defaults to None.

  • user_domain_name (string, optional) – Define the user_domain_name. Defaults to ‘Default’

  • project_id (string, optional) – ID of the project resource. Defaults to None.

  • micado_user (string, optional) – MiCADO username. Defaults to admin.

  • micado_password (string, optional) – MiCADO password. Defaults to admin.

Usage:

>>> client.micado.create(
...     auth_url='yourendpoint',
...     project_id='project_id',
...     image='image_name or image_id',
...     flavor='flavor_name or flavor_id',
...     network='network_name or network_id',
...     keypair='keypair_name or keypair_id',
...     security_group='security_group_name or security_group_id'
... )
Returns:

ID of MiCADO

Return type:

string

destroy()

Destroy running applications and the existing MiCADO VM.

Usage:

>>> client.micado.destroy()