ranger/orm/orm_client/ormcli
stewie925 d1869706a2 Provide Error Message to Failed CLI Requests
Include error messages to failed CLI requests for clarity.

Change-Id: Iccc6c2f85c1c282e13b140f0c76043f5fac1fc45
2019-02-20 17:19:17 -08:00
..
README Added orm_client codebase 2017-08-28 14:17:28 +00:00
__init__.py Flavor series hiding 2019-02-20 16:20:34 +00:00
cli_common.py Added orm_client codebase 2017-08-28 14:17:28 +00:00
cmscli.py Provide Error Message to Failed CLI Requests 2019-02-20 17:19:17 -08:00
config.py Build Ranger CLI image and fix bandit error 2018-12-12 15:42:50 -08:00
fmscli.py Flavor series hiding 2019-02-20 16:20:34 +00:00
imscli.py Build Ranger CLI image and fix bandit error 2018-12-12 15:42:50 -08:00
orm Fix config file and apache setup 2017-09-26 10:03:40 -05:00
ormcli.py Merge diverged code 2018-05-08 11:50:06 -05:00
requirements.txt Added orm_client codebase 2017-08-28 14:17:28 +00:00
rmscli.py Build Ranger CLI image and fix bandit error 2018-12-12 15:42:50 -08:00

README

How to install orm cli
======================

Ensure you have python and pip installed

> tar xvzf ormcli.tgz
> cd ormcli
> pip install -r requirements.txt


How to run orm cli
==================

cms, fms, and rms are all services that should be installed somewhere.
To access these services, you'll need their IP addresses and port numbers,
which should be supplied with the --host and --port arguments

For general help
================

> orm -h
usage: orm [-h] <service> ...

ORM REST CLI

positional arguments:
  <service>
    rms       Endpoint Discovery Service
    cms       Customer Management Service
    fms       Flavor Management Service

optional arguments:
  -h, --help  show this help message and exit

To get help on the cms subsystem
================================

> orm cms -h
usage: orm cms [-h] [--version] [--requester REQUESTER]
               [--tracking_id TRACKING_ID] [--host HOST] [--port PORT]
               [--timeout TIMEOUT]
               auth_token auth_region client <subcommand> [-h] <args> ...

positional arguments:
  auth_token            keystone user authorization token
  auth_region           keystone region authorization id
  client                client (application_id)
  <subcommand> [-h] <args>
    create_customer     datafile
    update_customer     custid datafile
    add_region          custid datafile
    delete_region       custid regionid
    add_user            custid regionid datafile
    delete_default_user
                        custid userid
    delete_user_from_region
                        custid regionid userid
    get_customer        custid

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --requester REQUESTER
                        requester (user_id)
  --tracking_id TRACKING_ID
                        tracking id
  --host HOST           hostname or ip of CMS server
  --port PORT           port number of CMS server
  --timeout TIMEOUT     request timeout in ms (default: 10000)