Client for OpenStack Congress
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
akhiljain23 595b317701 Switch python3 versions of test jobs to match Train PTI 2 months ago
congressclient Update hacking version 6 months ago
doc Cap sphinx for py2 to match global requirements 2 months ago
releasenotes add releasenotes tox env and commands 4 months ago
.coveragerc no longer use oslo-incubator code 2 years ago
.gitignore Switch to stestr 9 months ago
.gitreview OpenDev Migration Patch 2 months ago
.mailmap create python-congressclient project with cookiecutter 5 years ago
.stestr.conf Switch to stestr 9 months ago
.zuul.yaml Switch python3 versions of test jobs to match Train PTI 1 month ago
CONTRIBUTING.rst Update the documentation link for doc migration 2 years ago
HACKING.rst Update the documentation link for doc migration 2 years ago
LICENSE create python-congressclient project with cookiecutter 5 years ago
Makefile Add missing makefile so HTML docs can be generated 3 years ago
NEWS Add api bindings for datasource request-request trigger 4 years ago
README.rst Changes for url transition to OpenDev 2 months ago
babel.cfg create python-congressclient project with cookiecutter 5 years ago
lower-constraints.txt Switch to stestr 9 months ago
requirements.txt Updated from global requirements 1 year ago
setup.cfg Switch python3 versions of test jobs to match Train PTI 1 month ago
setup.py Updated from global requirements 2 years ago
tenant-list.log Initial congressclient 4 years ago
test-requirements.txt Update hacking version 6 months ago
tox.ini Switch python3 versions of test jobs to match Train PTI 1 month ago

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