Jump to: navigation, search

Difference between revisions of "Solum/CLI"

(Solum CLI)
Line 5: Line 5:
 
  pip install python-solumclient
 
  pip install python-solumclient
 
  solum -h
 
  solum -h
 +
 +
== Identity Credentials ==
 +
Solum works like existing OpenStack CLI commands. If you are not familiar with the prerequisites for using these tools, you can use DevStack, and just source the <code>devstack/openrc</code> script like this:
 +
 +
source devstack/openrc
  
 
== Using ==
 
== Using ==
Line 30: Line 35:
 
  +-------------+---------------------------------------------------------------------+
 
  +-------------+---------------------------------------------------------------------+
  
Now, you can start that application as many times as you want from that plan by creating an application <code>assembly</code> from it. THe following command shows the creation of an assemvbly named 'ex1' from the plan named 'ex1' registered in the previous step.
+
Now, you can start that application as many times as you want from that plan by creating an application <code>assembly</code> from it. THe following command shows the creation of an assembly named 'ex1' from the plan named 'ex1' registered in the previous step.
  
  $ solum assembly create ex1 --assembly ex1
+
  $ solum assembly create ex1 --assembly my_assembly
  
 
  Note: using plan_uri=http://10.0.2.15:9777/v1/plans/e7e6aaea-146d-494d-b2eb-3da8a648b87e
 
  Note: using plan_uri=http://10.0.2.15:9777/v1/plans/e7e6aaea-146d-494d-b2eb-3da8a648b87e
  +-----------------+--------------------------------------------------------------------------+
+
  +-----------------+----------------------------------------------------+
  | Property        | Value                                                                   |
+
  | Property        | Value                                             |
  +-----------------+--------------------------------------------------------------------------+
+
  +-----------------+----------------------------------------------------+
  | status          | None                                                                     |
+
  | status          | None                                               |
  | description    | None                                                                     |
+
  | description    | None                                               |
  | application_uri | None                                                                     |
+
  | application_uri | None                                               |
  | name            | ex1                                                                      |
+
  | name            | my_assembly                                        |
  | trigger_uri    | http://10.0.2.15:9777/v1/public/triggers/4009c664-710b-4521-a468-cc24f04 |
+
  | trigger_uri    | http://10.0.2.15:9777/v1/public/triggers/7a34065c- |
  |                | 04e6b                                                                    |
+
  |                | da6a-4443-a8d4-8e7abd292a21                        |
  | uuid            | 050ff625-d32a-483b-8df4-715ed623b8af                                    |
+
  | uuid            | 1221ea22-7913-4813-8982-48246db36e0f              |
  +-----------------+--------------------------------------------------------------------------+
+
  +-----------------+----------------------------------------------------+
 +
Now you can use watch the build process traverse through the various states of BUILDING, DEPLOYING, and finally READY.
  
Now you can use watch the build process traverse through the various states of BUILDING, DEPLOYING, and finally READY.
+
$ solum assembly show my_assembly
 +
 
 +
+-----------------+----------------------------------------------------+
 +
| Property        | Value                                              |
 +
+-----------------+----------------------------------------------------+
 +
| status          | BUILDING                                           |
 +
| description    | None                                              |
 +
| application_uri | None                                              |
 +
| name            | my_assembly                                        |
 +
| trigger_uri    | http://10.0.2.15:9777/v1/public/triggers/7a34065c- |
 +
|                | da6a-4443-a8d4-8e7abd292a21                        |
 +
| uuid            | 1221ea22-7913-4813-8982-48246db36e0f              |
 +
+-----------------+----------------------------------------------------+
 +
 
 +
$ solum assembly show my_assembly
 +
 
 +
+-----------------+----------------------------------------------------+
 +
| Property        | Value                                              |
 +
+-----------------+----------------------------------------------------+
 +
| status          | DEPLOYING                                         |
 +
| description    | None                                              |
 +
| application_uri | None                                              |
 +
| name            | my_assembly                                        |
 +
| trigger_uri    | http://10.0.2.15:9777/v1/public/triggers/7a34065c- |
 +
|                | da6a-4443-a8d4-8e7abd292a21                        |
 +
| uuid            | 1221ea22-7913-4813-8982-48246db36e0f              |
 +
+-----------------+----------------------------------------------------+
 +
 
 +
$ solum assembly show my_assembly
 +
 
 +
+-----------------+----------------------------------------------------+
 +
| Property        | Value                                              |
 +
+-----------------+----------------------------------------------------+
 +
| status          | READY                                             |
 +
| description    | None                                              |
 +
| application_uri | None                                              |
 +
| name            | my_assembly                                        |
 +
| trigger_uri    | http://10.0.2.15:9777/v1/public/triggers/7a34065c- |
 +
|                | da6a-4443-a8d4-8e7abd292a21                        |
 +
| uuid            | 1221ea22-7913-4813-8982-48246db36e0f              |
 +
+-----------------+----------------------------------------------------+
  
If something goes wrong, the assembly will display ERROR state. Here is how to find out what happened:
+
== Troubleshooting ==
 +
When something goes wrong using the CLI, here are some tips for tracking down the problem. If something goes wrong while creating an assembly, it will display ERROR state. Here is how to find out what happened:
  
 
  $ solum assembly show ex1
 
  $ solum assembly show ex1

Revision as of 03:57, 12 May 2014

Solum Command Line Interface

Installing

To install the solum CLI on any host that has Python and pip:

pip install python-solumclient
solum -h

Identity Credentials

Solum works like existing OpenStack CLI commands. If you are not familiar with the prerequisites for using these tools, you can use DevStack, and just source the devstack/openrc script like this:

source devstack/openrc

Using

To build and run an application with Solum, you can register your app using a YAML file called a plan file. Example:

name: ex1
description: Nodejs express.
artifacts:
- name: nodeus
  artifact_type: application.heroku
  content:
    href: https://github.com/paulczar/example-nodejs-express.git

For demonstration purposes, I have saved this in a file named ex1.yaml. First register the application:

$ solum app create ex1.yaml 
+-------------+---------------------------------------------------------------------+
| Property    | Value                                                               |
+-------------+---------------------------------------------------------------------+
| description | Nodejs express.                                                     |
| uri         | http://10.0.2.15:9777/v1/plans/e7e6aaea-146d-494d-b2eb-3da8a648b87e |
| uuid        | e7e6aaea-146d-494d-b2eb-3da8a648b87e                                |
| name        | ex1                                                                 |
+-------------+---------------------------------------------------------------------+

Now, you can start that application as many times as you want from that plan by creating an application assembly from it. THe following command shows the creation of an assembly named 'ex1' from the plan named 'ex1' registered in the previous step.

$ solum assembly create ex1 --assembly my_assembly
Note: using plan_uri=http://10.0.2.15:9777/v1/plans/e7e6aaea-146d-494d-b2eb-3da8a648b87e
+-----------------+----------------------------------------------------+
| Property        | Value                                              |
+-----------------+----------------------------------------------------+
| status          | None                                               |
| description     | None                                               |
| application_uri | None                                               |
| name            | my_assembly                                        |
| trigger_uri     | http://10.0.2.15:9777/v1/public/triggers/7a34065c- |
|                 | da6a-4443-a8d4-8e7abd292a21                        |
| uuid            | 1221ea22-7913-4813-8982-48246db36e0f               |
+-----------------+----------------------------------------------------+

Now you can use watch the build process traverse through the various states of BUILDING, DEPLOYING, and finally READY.

$ solum assembly show my_assembly
+-----------------+----------------------------------------------------+
| Property        | Value                                              |
+-----------------+----------------------------------------------------+
| status          | BUILDING                                           |
| description     | None                                               |
| application_uri | None                                               |
| name            | my_assembly                                        |
| trigger_uri     | http://10.0.2.15:9777/v1/public/triggers/7a34065c- |
|                 | da6a-4443-a8d4-8e7abd292a21                        |
| uuid            | 1221ea22-7913-4813-8982-48246db36e0f               |
+-----------------+----------------------------------------------------+
$ solum assembly show my_assembly
+-----------------+----------------------------------------------------+
| Property        | Value                                              |
+-----------------+----------------------------------------------------+
| status          | DEPLOYING                                          |
| description     | None                                               |
| application_uri | None                                               |
| name            | my_assembly                                        |
| trigger_uri     | http://10.0.2.15:9777/v1/public/triggers/7a34065c- |
|                 | da6a-4443-a8d4-8e7abd292a21                        |
| uuid            | 1221ea22-7913-4813-8982-48246db36e0f               |
+-----------------+----------------------------------------------------+
$ solum assembly show my_assembly
+-----------------+----------------------------------------------------+
| Property        | Value                                              |
+-----------------+----------------------------------------------------+
| status          | READY                                              |
| description     | None                                               |
| application_uri | None                                               |
| name            | my_assembly                                        |
| trigger_uri     | http://10.0.2.15:9777/v1/public/triggers/7a34065c- |
|                 | da6a-4443-a8d4-8e7abd292a21                        |
| uuid            | 1221ea22-7913-4813-8982-48246db36e0f               |
+-----------------+----------------------------------------------------+

Troubleshooting

When something goes wrong using the CLI, here are some tips for tracking down the problem. If something goes wrong while creating an assembly, it will display ERROR state. Here is how to find out what happened:

$ solum assembly show ex1
+-----------------+--------------------------------------------------------------------------+
| Property        | Value                                                                    |
+-----------------+--------------------------------------------------------------------------+
| status          | ERROR                                                                    |
| description     | None                                                                     |
| application_uri | None                                                                     |
| name            | ex1                                                                      |
| trigger_uri     | http://10.0.2.15:9777/v1/public/triggers/4009c664-710b-4521-a468-cc24f04 |
|                 | 04e6b                                                                    |
| uuid            | 050ff625-d32a-483b-8df4-715ed623b8af                                     |
+-----------------+--------------------------------------------------------------------------+

We can look at the associated Heat stack:

$ heat stack-list
+--------------------------------------+------------+---------------+----------------------+
| id                                   | stack_name | stack_status  | creation_time        |
+--------------------------------------+------------+---------------+----------------------+
| ba6f1ecf-77f8-434f-b4ff-4555d1b71d2e | ex1        | CREATE_FAILED | 2014-05-09T20:30:26Z |
+--------------------------------------+------------+---------------+----------------------+
$ heat stack-show ex1 | grep stack_status
| stack_status        | CREATE_FAILED                                                |
| stack_status_reason | Resource CREATE failed: Error: Creation of server ex1 failed |

Now we can look at the event history for that stack:

$ heat event-list ba6f1ecf-77f8-434f-b4ff-4555d1b71d2e
+-----------------+--------------------------------------+---------------------------------------+--------------------+----------------------+
| resource_name   | id                                   | resource_status_reason                | resource_status    | event_time           |
+-----------------+--------------------------------------+---------------------------------------+--------------------+----------------------+
| compute         | 09876afc-7547-4268-bd19-2b908f768ad9 | Error: Creation of server ex1 failed. | CREATE_FAILED      | 2014-05-09T20:30:41Z |
| compute         | ae7dc18f-5a63-48d4-af98-469e45aae52d | state changed                         | CREATE_IN_PROGRESS | 2014-05-09T20:30:27Z |
| external_access | 7a22de89-509d-457e-bfd9-e518cba6b9f2 | state changed                         | CREATE_IN_PROGRESS | 2014-05-09T20:30:26Z |
| external_access | f421fd64-6b71-495a-8fbc-9e29148f500b | state changed                         | CREATE_COMPLETE    | 2014-05-09T20:30:27Z |
+-----------------+--------------------------------------+---------------------------------------+--------------------+----------------------+

This is showing you that the compute service failed to create a compute instance (server).

So, let's look at that particular event:

$ heat event-show ba6f1ecf-77f8-434f-b4ff-4555d1b71d2e compute 09876afc-7547-4268-bd19-2b908f768ad9 | grep physical_resource_id
| physical_resource_id   | b282f2b9-88e2-4666-85bfa5fd86c9979a | 

Now we can look at that individual nova instance to find out why it is in ERROR state.

$ nova show b282f2b9-88e2-4666-85bf-a5fd86c9979a| grep fault
| fault | {"message": "No valid host was found. ", "code": 500, "created": "2014-05-09T20:30:40Z"} |

This indicates that the scheduler can not find any compute nodes that have room for the new assembly.