Mistral API¶

Using the default plan¶

When the undercloud is installed, it will create a default plan with the name overcloud. To create a new plan from the packaged version of tripleo-heat-templates on the undercloud use the workflow tripleo.plan_management.v1.create_default_deployment_plan. This workflow accepts a name which will be used for the Swift container and Mistral environment.

The following command creates a plan called my_cloud.

$ openstack workflow execution create tripleo.plan_management.v1.create_default_deployment_plan \
    '{"container": "my_cloud"}'
+-------------------+-----------------------------------------------------------+
| Field             | Value                                                     |
+-------------------+-----------------------------------------------------------+
| ID                | dc4800ef-8d0a-436e-9564-a7ee81ba93d5                      |
| Workflow ID       | fa8256ec-b585-476f-a83e-e800beb26684                      |
| Workflow name     | tripleo.plan_management.v1.create_default_deployment_plan |
| Description       |                                                           |
| Task Execution ID | <none>                                                    |
| State             | RUNNING                                                   |
| State info        | None                                                      |
| Created at        | 2016-08-23 10:06:45.372767                                |
| Updated at        | 2016-08-23 10:06:45.376122                                |
+-------------------+-----------------------------------------------------------+

Using custom templates¶

Manually creating a plan with custom templates is a three stage process. Each step must use the same name for the container, we are using my_cloud, but it can be changed if they are all consistent. This will be the plan name.

1. Create the Swift container.

   openstack action execution run tripleo.plan.create_container \
       '{"container":"my_cloud"}'
   

   Note

   Creating a swift container directly isn’t sufficient, as this Mistral action also sets metadata on the container and may include further steps in the future.

2. Upload the files to Swift.

   swift upload my_cloud path/to/tripleo/templates
   

3. Trigger the plan create Workflow, which will create the Mistral environment for the uploaded templates, do some initial template processing and generate the passwords.

   openstack workflow execution create tripleo.plan_management.v1.create_deployment_plan \
       '{"container":"my_cloud"}'
   

Register Nodes¶

Baremetal nodes can be registered with Ironic via Mistral. The input for this workflow is a bit larger, so this time we will store it in a file and pass it in, rather than working inline.

$ cat nodes.json
{
    "remove": false,
    "ramdisk_name": "bm-deploy-ramdisk",
    "kernel_name": "bm-deploy-kernel",
    "instance_boot_option": "local",
    "nodes_json": [
        {
            "pm_password": "$RSA_PRIVATE_KEY",
            "pm_type": "pxe_ssh",
            "pm_addr": "192.168.122.1",
            "mac": [
                "00:8f:61:0d:6a:e1"
            ],
            "memory": "8192",
            "disk": "40",
            "arch": "x86_64",
            "cpu": "4",
            "pm_user": "root"
        }
    ]
}

• If remove is set to true, any nodes that are not passed to the workflow will be removed.
• ramdisk_name and kernel_name are the Glance names for the kernel and ramdisk to use for the nodes.
• instance_boot_option defines whether to set instances for booting from the local hard drive (local) or network (netboot).
• The format of the nodes_json is documented in instackenv.json.

$ openstack workflow execution create tripleo.baremetal.v1.register_or_update \
    nodes.json

The result of this workflow can be seen with the following command.

$ mistral execution-get-output $EXECUTION_ID
{
    "status": "SUCCESS",
    "new_nodes": [],
    "message": "Nodes set to managed.",
    "__task_execution": {
        "id": "001892c5-4197-4c04-af74-aff95f6d584f",
        "name": "send_message"
    },
    "registered_nodes": [
        {
            "uuid": "93feecfb-8a4d-418c-9f2c-5ef8db7aff2e",
            ...
        },
    ]
}

The above information is accessible like this, or via the zaqar queue. The registered_nodes property will contain each of the nodes registered with all their properties from Ironic, including the UUID which is useful for introspection.

Introspect Nodes¶

To introspect the nodes, we need to either use the Ironic UUID’s returned by the register_or_update workflow or retrieve them directly from Ironic. Then those UUID’s can be passed to the introspection workflow. The workflow expects nodes to be in the “manageable” state.

$ openstack workflow execution create tripleo.baremetal.v1.introspect \
    '{"nodes_uuids": ["UUID1", "UUID2"]}'

Cleaning Nodes¶

It is recommended to clean previous information from all disks on the bare metal nodes before new deployments. As TripleO disables automated cleaning, it has to be done manually via the manual_clean workflow. A node has to be in the manageable state for it to work.

To remove partitions from all disks on a given node, use the following command:

$ openstack workflow execution create tripleo.baremetal.v1.manual_cleaning \
    '{"node_uuid": "UUID", "clean_steps": [{"step": "erase_devices_metadata", "interface": "deploy"}]}'

To remove all data from all disks (either by ATA secure erase or by shredding them), use the following command:

$ openstack workflow execution create tripleo.baremetal.v1.manual_cleaning \
    '{"node_uuid": "UUID", "clean_steps": [{"step": "erase_devices", "interface": "deploy"}]}'

The node state is set back to manageable after successful cleaning and to clean failed after a failure. Inspect node’s last_error field for the cause of the failure.

Provide Nodes¶

After the nodes have been introspected they will still be in the manageable state. To make them available for a deployment, use the provide workflow, which has the same interface as introspection.

$ openstack workflow execution create tripleo.baremetal.v1.provide \
    '{"nodes_uuids": ["UUID1", "UUID2"]}'