Jump to: navigation, search

Difference between revisions of "Solum/CLI"

(→‎Proposed Plan)
(→‎Using)
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
Solum Command Line Interface
+
= Solum Command Line Interface =
  
−
== Overview ==
+
== Installing ==
−
As of 2014-01-13 Solum does not yet have a CLI. It is required for our initial release, and efforts to code one are underway. A number of options for developing the tool are under discussion. This wiki page identifies and detail the options under consideration, and describes our intended approach.
+
To install the solum CLI on any host that has Python and pip:
 +
pip install python-solumclient
 +
solum -h
  
−
== Goals ==
+
== Identity Credentials ==
−
# Produce a prototype to satisfy the [https://blueprints.launchpad.net/solum/+spec/solum-minimal-cli solum-minimal-cli] blueprint
+
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:
−
# Produce a complete CLI for Solum that allows simple interaction with the Solum API service, satisfying the [https://blueprints.launchpad.net/solum/+spec/solum-cli solum-cli] blueprint
 
−
# Adjust the CLI (if needed) to conform to the prevailing OpenStack CLI tools, and underlying resources, such as any prevailing SDK resources and client libraries.
 
  
−
== Blueprints ==
+
source devstack/openrc
−
* https://blueprints.launchpad.net/solum/+spec/solum-cli
 
−
* https://blueprints.launchpad.net/solum/+spec/solum-minimal-cli
 
  
−
See the [https://www.dropbox.com/s/ejnu2iginqr6lau/Screenshot%202014-01-13%2014.29.47.png diagram showing how the CLI relates to the rest of the ecosystem]
+
== Using ==
 +
To build and run an application with Solum, you can register your app using a YAML file called a <code>app file</code>. Example:
  
−
== Mailing List Threads ==
+
  version: 1
−
* http://lists.openstack.org/pipermail/openstack-dev/2013-November/018505.html
+
  name: cherrypy
 +
  description: python web app
 +
  languagepack: python
 +
  source:
 +
    repository: https://github.com/rackspace-solum-samples/solum-python-sample-app.git
 +
    revision: master
 +
  workflow_config:
 +
    test_cmd: ./unit_tests.sh
 +
    run_cmd: python app.py
 +
  trigger_actions:
 +
    - unittest
 +
    - build
 +
    - deploy
 +
  ports:
 +
    - 80
  
−
== Minimal CLI Options ==
+
For demonstration purposes, I have saved this in a file named ex1.yaml. First register the application:
−
=== Argparse ===
 
−
* WIP pull request - https://review.openstack.org/66065
 
−
====  Pro ====
 
−
* Fast-track to completing an M1 CLI
 
−
* Relatively simple Python standard argparse library-based code
 
−
* No external (potentially changing) code dependencies
 
−
* Modeled after Trove architecture recommendations
 
  
−
==== Con ====
+
$ solum app create --app-file ex1.yaml
−
* May be the largest porting effort to the eventual OpenStack client of any options
 
−
* No authentication handling built in (will depend on [https://github.com/openstack/python-keystoneclient python-keystoneclient] library)
 
  
−
=== OSC ===
+
+-------------+---------------------------------------------------------------------+
−
* WIP pull request/hack - https://review.openstack.org/#/c/64703/
+
| Property    | Value                                                              |
−
* OSC now uses [https://cliff.readthedocs.org/en/latest/ Cliff]. Cliff [https://github.com/dreamhost/cliff/tree/master/demoapp demo app].
+
+-------------+---------------------------------------------------------------------+
−
* Note: dtroyer is the technical lead for OSC
+
| description | python web app                                                  |
 +
| uri        | http://10.0.2.15:9777/v1/apps/6b240789-cfe3-494a-ad60-be2abb56066e |
 +
| uuid        | 6b240789-cfe3-494a-ad60-be2abb56066e                                |
 +
| name        | cherrypy                                                                |
 +
+-------------+---------------------------------------------------------------------+
  
−
==== Pro ====
+
You can see all of your registered apps using the <code>solum app list</code> command:
−
* Considered by many to be the best path for integration into the future OpenStack CLI architecture
+
$ solum app list
−
* Integrates authentication already
 
−
* dtroyer agreed to implement two Solum plugin features to provide an example
 
  
−
==== Con ====
+
+--------------------------------------+------+-----------------+
−
* Not complete - some APIs may change, especially around authentication
+
| uuid                                | name | description    |
−
* The plugin documentation is not complete - https://github.com/dtroyer/python-oscplugin
+
+--------------------------------------+------+-----------------+
−
* No other project has implemented the OSC plugin yet (core OpenStack projects add their features directly into the OSC without plugins)
+
| 6b240789-cfe3-494a-ad60-be2abb56066e | cherrypy  | python web app |
−
* There are discussions about potential OSC architectural changes within OpenStack; want to verify that we will not be chasing large code changes
+
+--------------------------------------+------+-----------------+
  
−
== Proposed Plan ==
+
Now, you can deploy the app as follows:
−
* Develop a prototype based on [https://review.openstack.org/66065 simple argparse pull request] to satisfy the [https://blueprints.launchpad.net/solum/+spec/solum-minimal-cli solum-minimal-cli] blueprint as part of M1 (short term, considered disposable).
+
 
−
* Develop a complete client based on [https://review.openstack.org/#/c/64703/ WIP OSC pull request] that can integrate with OSC to satisfy the [https://blueprints.launchpad.net/solum/+spec/solum-cli solum-cli] blueprint
+
$ solum app deploy cherrypy
−
* The "prototype" client will be completed first, and will only implement the minimum needed to address [https://blueprints.launchpad.net/solum/+spec/solum-minimal-cli solum-minimal-cli].
+
+-----------------+----------------------------------------------------+
−
* OSC client obviates the argparse client, implementing everything in [https://blueprints.launchpad.net/solum/+spec/solum-cli solum-cli] once it is done.
+
| Property        | Value                                              |
 +
+-----------------+----------------------------------------------------+
 +
| status          | None                                              |
 +
| description    | None                                              |
 +
| application_uri | None                                              |
 +
| name            | cherrypy                                        |
 +
| 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 observe the build process traverse through the various states of BUILDING, DEPLOYING, and finally READY. To display the details, you can use <code>solum app show <app_name|uuid></code>
 +
 
 +
$ solum app show cherrypy
 +
 
 +
+-----------------+----------------------------------------------------+
 +
| Property        | Value                                              |
 +
+-----------------+----------------------------------------------------+
 +
| status          | BUILDING                                          |
 +
| description    | None                                              |
 +
| application_uri | None                                              |
 +
| name            | cherrypy                                      |
 +
| trigger_uri    | http://10.0.2.15:9777/v1/public/triggers/7a34065c- |
 +
|                | da6a-4443-a8d4-8e7abd292a21                        |
 +
| uuid            | 1221ea22-7913-4813-8982-48246db36e0f              |
 +
+-----------------+----------------------------------------------------+
 +
 
 +
$ solum app show cherrypy
 +
 
 +
+-----------------+----------------------------------------------------+
 +
| Property        | Value                                              |
 +
+-----------------+----------------------------------------------------+
 +
| status          | DEPLOYING                                          |
 +
| description    | None                                              |
 +
| application_uri | None                                              |
 +
| name            | cherrypy                                        |
 +
| trigger_uri    | http://10.0.2.15:9777/v1/public/triggers/7a34065c- |
 +
|                | da6a-4443-a8d4-8e7abd292a21                        |
 +
| uuid            | 1221ea22-7913-4813-8982-48246db36e0f              |
 +
+-----------------+----------------------------------------------------+
 +
 
 +
$ solum app show cherrypy
 +
 
 +
+-----------------+----------------------------------------------------+
 +
| Property        | Value                                              |
 +
+-----------------+----------------------------------------------------+
 +
| status          | READY                                              |
 +
| description    | None                                              |
 +
| application_uri | http://192.168.78.2:5000                          |
 +
| name            | cherrypy                                      |
 +
| trigger_uri    | http://10.0.2.15:9777/v1/public/triggers/7a34065c- |
 +
|                | da6a-4443-a8d4-8e7abd292a21                        |
 +
| uuid            | 1221ea22-7913-4813-8982-48246db36e0f              |
 +
+-----------------+----------------------------------------------------+
 +
 
 +
You can also un-register an application using the <code>solum app delete <app_name|uuid></code> command:
 +
 
 +
$ solum app delete ex1
 +
 
 +
There's no penalty to have an application registered. There are no running services associated with it if there are no application instances running, so having one registered is just a quick and easy way to create more application instances using that same registered app information.
 +
 
 +
== Troubleshooting ==
 +
When something goes wrong using the CLI, here are some tips for tracking down the problem. If something goes wrong while creating an app, it will display ERROR state. Here is how to find out what happened:
 +
 
 +
$ solum app 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 app instance.

Latest revision as of 16:23, 5 April 2016

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 app file. Example: 

 version: 1
 name: cherrypy
 description: python web app
 languagepack: python
 source:
   repository: https://github.com/rackspace-solum-samples/solum-python-sample-app.git
   revision: master
 workflow_config:
   test_cmd: ./unit_tests.sh
   run_cmd: python app.py
 trigger_actions:
   - unittest
   - build
   - deploy
 ports:
   - 80

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

$ solum app create --app-file ex1.yaml 

+-------------+---------------------------------------------------------------------+
| Property    | Value                                                               |
+-------------+---------------------------------------------------------------------+
| description | python web app                                                   |
| uri         | http://10.0.2.15:9777/v1/apps/6b240789-cfe3-494a-ad60-be2abb56066e |
| uuid        | 6b240789-cfe3-494a-ad60-be2abb56066e                                |
| name        | cherrypy                                                                 |
+-------------+---------------------------------------------------------------------+

You can see all of your registered apps using the solum app list command: 

$ solum app list

+--------------------------------------+------+-----------------+
| uuid                                 | name | description     |
+--------------------------------------+------+-----------------+
| 6b240789-cfe3-494a-ad60-be2abb56066e | cherrypy  | python web app |
+--------------------------------------+------+-----------------+

Now, you can deploy the app as follows: 

$ solum app deploy cherrypy
+-----------------+----------------------------------------------------+
| Property        | Value                                              |
+-----------------+----------------------------------------------------+
| status          | None                                               |
| description     | None                                               |
| application_uri | None                                               |
| name            | cherrypy                                        |
| 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 observe the build process traverse through the various states of BUILDING, DEPLOYING, and finally READY. To display the details, you can use solum app show <app_name|uuid> 

$ solum app show cherrypy

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

$ solum app show cherrypy

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

$ solum app show cherrypy

+-----------------+----------------------------------------------------+
| Property        | Value                                              |
+-----------------+----------------------------------------------------+
| status          | READY                                              |
| description     | None                                               |
| application_uri | http://192.168.78.2:5000                           |
| name            | cherrypy                                       |
| trigger_uri     | http://10.0.2.15:9777/v1/public/triggers/7a34065c- |
|                 | da6a-4443-a8d4-8e7abd292a21                        |
| uuid            | 1221ea22-7913-4813-8982-48246db36e0f               |
+-----------------+----------------------------------------------------+

You can also un-register an application using the solum app delete <app_name|uuid> command: 

$ solum app delete ex1

There's no penalty to have an application registered. There are no running services associated with it if there are no application instances running, so having one registered is just a quick and easy way to create more application instances using that same registered app information.

Troubleshooting

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

$ solum app 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 app instance.

Retrieved from "https://wiki.openstack.org/w/index.php?title=Solum/CLI&oldid=123508"