27 Commits

Author SHA1 Message Date
Matthieu Huin
631ed3c802 Unscoped federated user-specific commands
A federated user can authenticate with the v3unscopedsaml plugin and
list the domains and projects she is allowed to scope to.
This patch introduces the new commands 'federation domain list' and
'federation project list'.
Note that for these commands -and plugin- to be available, the lxml
library must be installed.

Change-Id: I2707b624befcfb0a01b40a094e12fd68a3ee7773
Co-Authored-By: Florent Flament <florent.flament-ext@cloudwatt.com>
2014-10-30 17:27:28 +01:00
Matthieu Huin
0c77a9fe8b Support for keystone auth plugins
This patch allows the user to choose which authentication plugin
to use with the CLI. The arguments needed by the auth plugins are
automatically added to the argument parser. Some examples with
the currently available authentication plugins::

  OS_USERNAME=admin OS_PROJECT_NAME=admin OS_AUTH_URL=http://keystone:5000/v2.0 \
  OS_PASSWORD=admin openstack user list

  OS_USERNAME=admin OS_PROJECT_DOMAIN_NAME=default OS_USER_DOMAIN_NAME=default \
  OS_PROJECT_NAME=admin OS_AUTH_URL=http://keystone:5000/v3 OS_PASSWORD=admin \
  OS_IDENTITY_API_VERSION=3 OS_AUTH_PLUGIN=v3password openstack project list

  OS_TOKEN=1234 OS_URL=http://service_url:35357/v2.0 \
  OS_IDENTITY_API_VERSION=2.0 openstack user list

The --os-auth-plugin option can be omitted; if so the CLI will attempt to
guess which plugin to use from the other options.

Change-Id: I330c20ddb8d96b3a4287c68b57c36c4a0f869669
Co-Authored-By: Florent Flament <florent.flament-ext@cloudwatt.com>
2014-10-09 12:34:47 +02:00
Steve Martinelli
89bb5b0b85 Add some code-blocks to the docs
Add some basic highlighting for the docs

Change-Id: Ifa740856f3ef636bdf0f60f3b7d082c68062fe9b
2014-10-03 00:25:56 -04:00
Anita Kuno
92add18e31 Acknowlege git.o.o as OpenStack's git server
OpenStack's cannonical git server is at git.o.o this patch
updates the index.rst to reflect that.

Change-Id: I54eeea7fab2e0f64ca9f23f7c328e2ff19721a41
2014-09-18 17:06:29 -04:00
Andreas Jaeger
c5df1826a6 Stop using intersphinx
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)

This also removes the requirement for internet access during docs build.

This can cause docs jobs to fail if the project errors out on
warnings.

Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
2014-09-13 09:46:09 +02:00
Dean Troyer
f7357b7fe7 Update docs and release notes for 0.4.1 release
Closes-Bug: 1365505
Change-Id: I027d263ba9980715454b034a37733c5ff23fd169
2014-09-08 11:36:33 -05:00
Steve Martinelli
b5001e4b21 Use oslosphinx to generate documentation
Rather than host different and possibly out of date versions of
static and theme files, use oslosphinx to generate the docs.

Change-Id: I7eadc8e40aa10cc26cfd6aece6efa5d13fee70b0
2014-08-05 01:31:20 -04:00
Christian Berendt
dad5b10510 Replaced some UTF-8 characters with ASCII characters
Change-Id: Ic4e53b742f8691dd2dafe1a8d7fa45e4340a3c94
2014-07-07 19:52:48 +02:00
Jenkins
b3736fd9df Merge "Remove keyring support from openstackclient" 2014-07-04 19:45:30 +00:00
Alex Gaynor
b8f534df01 Remove keyring support from openstackclient
* The encryption it purports to offer is completely insecure.
* It also appears to be broken.

Closes-Bug: #1319381
Change-Id: Id15ecfbbfd15f142b14c125bfd85afd5032699ac
2014-07-04 01:56:18 +00:00
Matthieu Huin
5672c688d1 trust authentication
This patch enables authenticating by using a trust. The trust ID
must be set with the parameter --os-trust-id or the env variable
OS_TRUST_ID. Trusts are available for the identity v3 API.

Co-Authored-By: Florent Flament <florent.flament@cloudwatt.com>
Change-Id: Iacc389b203bbadda53ca31a7f5a9b8b6e1a1f522
2014-07-03 10:12:02 +02:00
Dean Troyer
3fa5fa5ba7 Update docs and release notes for 0.4.0
Change-Id: Iad6cfe5dee63adb9e60a0ea9811217b3175eb99c
2014-06-20 12:15:52 -05:00
Steve Martinelli
deaff7274e Update docs template
To make things more consistent across all openstack projects, the
developer docs should be upgraded to the newer template used by
keystone and keystoneclient (and other projects).

I dropped in the necessary static files and themes, and updated
the config file to make the changes at build time.

Change-Id: I5a268cff3cd5af29ad712705d540b9d1d6667d56
Partial-Bug: #1331304
2014-06-18 03:47:37 +00:00
Alex Holden
97667079dc Fixed Spelling errors - compatability to compatibility
Change-Id: I9da380cef8b798e21fd35882763bd05f5cf1e33e
2014-03-07 09:39:02 -08:00
Alex Holden
14548aa69a Fixed spelling errors - occurance to occurence
Change-Id: Ie0550a1168448d85043d9b4943edd732b1f10307
2014-03-07 09:38:05 -08:00
Dean Troyer
038269cf7f Update release notes for 0.3.1
* update README
* update man page
* fix doc errors

Change-Id: I5682654bf482289879c8ba9016e348f2b2782971
2014-02-27 17:36:28 -06:00
Dean Troyer
de27c1b455 Release notes for 0.3.0 release
Change-Id: I6f025b745378613eb674e13dd503e57d049a3e50
2013-12-17 09:22:17 -06:00
Dean Troyer
4f1ebe8069 Update docs for plugins and release notes
* Fill out the existing command and man page
* Add a plugins page.
* Begin the release notes for 0.3.0

Change-Id: I4527fed28a10a9d79fc8f6c1d925a4bf0d0a7a36
2013-12-05 17:29:35 -06:00
Dean Troyer
74f4e31389 Update release notes for 0.2.2
Change-Id: I59cbee4c147d5f849a7f07224e83ddd751212077
2013-09-20 10:57:31 -05:00
Dean Troyer
0507e9cf6f Add release notes in docs
Change-Id: I49dc936a37848745ce3412e810b98348558d1157
2013-08-06 12:43:22 -05:00
Dean Troyer
6f9dcc13f6 Prep for 0.2 release (0.2.rc1)
* rename HACKING to HACKING.rst and refer to the common OpenStack HACKING file
* add the barest of pointers to the wiki, etc. to the source docs
* add a bare-bones man page

Change-Id: I80e5b972af645f14ef17ae87f182ab09cb08dabe
2013-08-01 16:21:22 -05:00
Monty Taylor
d7501c352d Update documentation with info about setup.cfg
Change-Id: If87df1e6415d0b70b6605b1d89eda639fc44a0b6
2013-07-05 22:30:54 -04:00
Dean Troyer
fbc412e533 Multiple API version support
* Use multiple entry point groups to represent each API+version
  combination supported
* Add some tests

Try it out:
* Right now only '* user' commands have multiple overlapping versions;
  you can see the selection between v2.0 and v3 by looking at the
  command help output for 'tenant' vs 'project':

  os --os-identity-api-version=2.0 help set user
  os --os-identity-api-version=3 help set user

Change-Id: I7114fd246843df0243d354a7cce697810bb7de62
2013-02-06 11:36:28 -06:00
lrqrun
2372142eaa Fix PEP8 issues.
Fix some pep8 issues in doc/source/conf.py and tests/test_shell.py  make the code looks pretty.

Change-Id: I927f03aff4190f1ac30eb56e7c545de555978c31
2012-08-29 14:17:08 +08:00
Lorin Hochstein
1a5aabf6fc Fixed a typo in the rst docs.
Change-Id: Ie3484f8fe0a63ff5a6815f3ec440adf7dc5d9482
2012-06-26 16:57:33 -04:00
Clark Boylan
3dceacf6cd Update Contributing blurb in the docs.
Contributing blurb previously mentioned social coding and Github.
The OpenStack contribution workflow is slightly different. Provide
details on Github, LP, and Gerrit.

Change-Id: Ie5ecd25e5828de611561f37b3acbccc5cf3f0d04
2012-06-22 10:24:44 -07:00
Clark Boylan
77e5ce57fd Move docs to doc.
To better facilitate the building and publishing of sphinx
documentation by Jenkins we are moving all openstack projects with
sphinx documentation to a common doc tree structure. Documentation
goes in project/doc/source and build results go in project/doc/build.

Change-Id: I925e687254bac9e06c2c520f4fc35a083e21c4ca
2012-06-11 14:37:48 -07:00