RETIRED, Client for OpenStack Congress
Go to file
Nguyen Hai 5c64747b15 import zuul job settings from project-config
This is a mechanically generated patch to complete step 1 of moving
the zuul job settings out of project-config and into each project
repository.

Because there will be a separate patch on each branch, the branch
specifiers for branch-specific jobs have been removed.

Because this patch is generated by a script, there may be some
cosmetic changes to the layout of the YAML file(s) as the contents are
normalized.

See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: Ibbeb30becdacea8bfa8409417fcc9f8be6aa8a21
Story: #2002586
Task: #24290
2018-08-20 13:41:22 +09:00
congressclient Set default max-width to 80 everywhere 2017-07-25 21:04:27 -07:00
doc/source doc migration 2017-07-19 15:46:08 -07:00
releasenotes/notes Add release notes 2016-09-01 09:13:48 -07:00
.coveragerc no longer use oslo-incubator code 2016-11-11 00:47:23 -05:00
.gitignore Update .gitignore 2017-01-16 21:20:12 +08:00
.gitreview Update .gitreview for stable/pike 2017-07-28 21:06: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
.zuul.yaml import zuul job settings from project-config 2018-08-20 13:41:22 +09:00
CONTRIBUTING.rst Update the documentation link for doc migration 2017-07-24 10:23:01 +08:00
HACKING.rst Update the documentation link for doc migration 2017-07-24 10:23:01 +08: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 Update the documentation link for doc migration 2017-07-24 10:23:01 +08:00
babel.cfg create python-congressclient project with cookiecutter 2014-07-02 13:24:29 -07:00
requirements.txt Updated from global requirements 2017-09-27 17:33:43 +00:00
setup.cfg Merge "Add command to create policy from file" 2017-07-20 06:35:08 +00:00
setup.py Updated from global requirements 2017-03-10 03:38:00 +00:00
tenant-list.log Initial congressclient 2014-09-10 15:11:09 -07:00
test-requirements.txt Updated from global requirements 2017-09-27 17:33:43 +00:00
tox.ini import zuul job settings from project-config 2018-08-20 13:41:22 +09: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