RETIRED, Client for OpenStack Congress
Go to file
Aimee Ukasick d90617c6f4 Added how to install from a branch
Change-Id: Ifa74355484a2d315b71d7da75086cd6ad45bff40
Partial-Bug: 1681928
2017-01-24 10:38:32 -06:00
congressclient Fall back to UUID when delete by name fails 2017-01-23 16:11:33 -08:00
doc/source create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
releasenotes/notes Add release notes 2016-09-01 09:13:48 -07:00
tools Add Constraints support 2016-12-21 12:49:56 +11:00
.coveragerc no longer use oslo-incubator code 2016-11-11 00:47:23 -05:00
.gitignore Fixup gitignore 2014-09-03 08:19:14 -07:00
.gitreview Update .gitreview file to reflect repo rename 2015-04-18 00:37:36 +00:00
.mailmap create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
.testr.conf create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
CONTRIBUTING.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:46 +00:00
HACKING.rst create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
LICENSE create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
Makefile Add missing makefile so HTML docs can be generated 2016-07-22 11:59:15 -05:00
NEWS Add api bindings for datasource request-request trigger 2015-03-31 15:33:53 -07:00
README.rst Added how to install from a branch 2017-01-24 10:38:32 -06:00
babel.cfg create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
requirements.txt Updated from global requirements 2017-01-21 15:56:07 +00:00
setup.cfg Change home-page and documentation link 2016-12-08 08:43:49 +00:00
setup.py Updated from global requirements 2015-12-15 18:16:44 +00:00
tenant-list.log Initial congressclient 2014-09-10 15:11:09 -07:00
test-requirements.txt Updated from global requirements 2016-10-22 01:26:39 +00:00
tox.ini Add Constraints support 2016-12-21 12:49:56 +11:00

README.rst

Team and repository tags

image

python-congressclient

Client for Congress

Client for Standalone Congress

Install the Congress CLI by cloning the repository and running the setup file. The master repository always contains the latest source code, so if you are installing and testing a specific branch of Congress, clone the matching branch of the python-congressclient.

To execute CLI commands to standalone Congress installed with noauth:

  • Install python-openstackclient:

    $ pip install python-openstackclient
  • Clone master repository & install python-congressclient:

    $ git clone https://github.com/openstack/python-congressclient.git
    $ cd python-congressclient
    $ python setup.py install
  • (Optional) Clone a branch; for example, if you are using the Ocata version of OpenStack and Congress:

    $ git clone -b stable/ocata https://github.com/openstack/python-congressclient.git
    $ cd python-congressclient
    $ python setup.py install
  • Read the HTML documentation. Install python-sphinx and the oslosphinx extension if missing:

    $ sudo pip install sphinx
    $ sudo pip install oslosphinx

    Build the docs $ make docs

    Open doc/html/index.html in a browser

  • To execute CLI commands:

    $ cd python-congressclient
    
    For example:
    $ export CONGRESS_URL="http://127.0.0.1:1789"
    $ openstack --os-token foo --os-url $CONGRESS_URL
    (openstack) congress policy create test_policy
    +--------------+--------------------------------------+
    | Field        | Value                                |
    +--------------+--------------------------------------+
    | abbreviation | test_                                |
    | description  |                                      |
    | id           | 8595f24a-7d74-45ee-8168-0b3e937b8419 |
    | kind         | nonrecursive                         |
    | name         | test_policy                          |
    | owner_id     | user                                 |
    +--------------+--------------------------------------+
    
    (openstack) congress policy rule create test_policy "p(5)"
    +---------+--------------------------------------+
    | Field   | Value                                |
    +---------+--------------------------------------+
    | comment | None                                 |
    | id      | 5ce7fb18-a227-447e-bec8-93e99c0052a5 |
    | name    | None                                 |
    | rule    | p(5)                                 |
    +---------+--------------------------------------+
    
    (openstack) congress policy rule list test_policy
    // ID: 5ce7fb18-a227-447e-bec8-93e99c0052a5
    // Name: None
    p(5)
    
    (openstack) exit
    $

Features

  • TODO