Commit Graph

41 Commits (30d5f14a700dd53d80e0fbedefd9b1ad337390f9)

Author SHA1 Message Date
pedro d688cb58a3 Add documentation about login with federation
The documentation presents the parameters necessary
to authenticate via federation (using password) and do
a brief description of each parameter used in the process.

Change-Id: Iae3b6d0b56ebd2bbbb94f9f3637b5086e75559a7
3 years ago
Eric Fried d0bfef807d Doc: launchpad => storyboard
A few docs still referred to launchpad, which osc hasn't used in a
couple of years. Cut over to storyboard.

Change-Id: Ic9abf0fe1e52c255976bd7a019e999a8e610455e
4 years ago
Dean Troyer cb0c20b23c Update release table for Train and 4.0.0
Also clean up some docs and release notes.

Change-Id: I73feec747ca1bd12be5e5700c9ca608ed3a8b2c2
Signed-off-by: Dean Troyer <>
4 years ago
Dean Troyer 0f56b7d074 Followup opendev cleanup and test jobs
* upper-constraints references need s/plain/raw/

Change-Id: I04368dc42f1a62a048ac9d11497747ef6f600515
Signed-off-by: Dean Troyer <>
4 years ago
wu.chunyang ddcc25e7f3 Add release note link in README
Change-Id: I53896535dc369a499a6850b71d23feff9350e557
5 years ago
Chen f904efb037 Fix urls in README.rst
1. bug tracking has been moved to storyboard
2. syntax issues
3. remove PyPI downloads since it is no longer maintained

Change-Id: Ic57c7032af0296d666841021c19e6e56f0b3e89a
5 years ago
Tovin Seven 5a9fc91830 Trivial: Update pypi url to new url
Pypi url changed from [1] to [2]


Change-Id: I61f3d53737616dbbd6df725823b5335a57045dba
5 years ago
melissaml 5a5281e755 Update links in README
Change the outdated links to the latest links in README

Change-Id: I94c781866c8b65e84708dd9f951f023a5e2913b1
5 years ago
Jenkins d010c00a15 Merge "Update the documentation link for doc migration" 6 years ago
Jenkins 08ffd854e8 Merge "Use identity auth v3 the README examples" 6 years ago
Hangdong Zhang 37998ad1c2 Update the documentation link for doc migration
Change-Id: I7833e40d66abe233af5a211bcefadc141fe8e54b
6 years ago
Samuel de Medeiros Queiroz 6eb1551573 Use identity auth v3 the README examples
Identity auth v3 is the default in devstack. The keystone team
advertises all deployments to migrate over to v3.

If we get our examples to use v3, that would be a great help.

Change-Id: I8bd4cbf16cd42fa1654776f19bf113e3c94e25cf
6 years ago
Doug Hellmann 0ddda620dc update the docs URLs in the readme
Change-Id: Id1168e1003f62e08d2da338cb1b81bc2b7547bfc
Signed-off-by: Doug Hellmann <>
6 years ago
Flavio Percoco 1f8485b94f Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

To see an example of how this would look like check:

Change-Id: I2d906fa0675463e21f2786d93f464c465f2bc3b1
7 years ago
Ryan Selden cde07464b5 Added a note on how to test changes
It's confusing for new contributors to test the client.
Added a quick note to the README explaining how to do so.

Change-Id: I2a185f04bbec7ab01fdd2ab436a5f413f33819e7
7 years ago
Ankur Gupta 61a60ef926 Add Testing Ref in README.rst
Add a reference in the README directed to docs page for testing
within python-openstackclient. Avoid creating TESTING.rst due to
unneeded duplication. Updated Developer URL to correct one.

Change-Id: I40b4c949d155aea6e0e25ecd4a88797481a4d8ac
7 years ago
Xi Yang 54b0ef3358 Use Block Storage instead of Volume
Volume is better to be replaced by Block Storage in the

Change-Id: I736669ee01c7385b6e701cb20f4334eff1c49286
8 years ago
Steve Martinelli e52dfce7bd Add version/downloads links/badges into README.rst
it's handy to have appear in the pypi page

Change-Id: I142da7d194d719f3b8218ad84e32e19bf0071c63
8 years ago
Monty Taylor 4afd308a4f Include links to developer workflow documentation
Newcomers aren't always sure how to get started with our tools or
workflow. Lucky for them, we have documented these things. Unlucky for
them, they have no idea the docs exist.

Give them some links.

Change-Id: I6fce6fbccb8a9fe16b48845790b4cac05317ebac
8 years ago
Dean Troyer 649dbf1ede Update README
Re-orient README toward end-users

Change-Id: I4623832dde72a7ae0eeadf09429402521771dd35
8 years ago
Steve Martinelli 75e8490e54 Cleanup README.rst
There are two harmless typos in the README.rst
'OpenStackclient' => 'OpenStack Client'
'python-*client' => the '*' is being interpreted as a link

Change-Id: Ie813e220c3c150f46edb2c93f94e8bb78bdb0013
Closes-Bug: #1350518
9 years ago
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
9 years ago
Alex Gaynor a8087a6c8b Fixed several typos throughout the codebase
Change-Id: I048ee857fc1215fea7f60978364894e1b5abdf66
9 years ago
Alex Holden 00188f092c Fixed spelling error, compatability to compatibility
Change-Id: I72c1254666a741ffe1070cf8275af889fa323f52
9 years ago
Dean Troyer 038269cf7f Update release notes for 0.3.1
* update README
* update man page
* fix doc errors

Change-Id: I5682654bf482289879c8ba9016e348f2b2782971
9 years ago
Terry Howe 202c3e375b Closes-Bug: #1262322 Make links clickable
Change-Id: I61302ff5274cdaa09801cb9b0dc9bfd353ac687f
10 years ago
Jenkins 0cc5811122 Merge "Prep for 0.2 release (0.2.rc1)" 10 years ago
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
10 years ago
Dean Troyer 0aa3c206a3 Remove tenant round 1 - global options
Change the global auth options to use 'project', leave the original
tenant options in place but silent for compatability with the existing
project CLI auth options.  This is the only compatibility for tenant
usage in this changeover.

Change-Id: I3cce6e552f18822cc9f445ec5f301b0f5d9003f8
10 years ago
Josh Kearney 37b75a10c2 Updated README to reflect latest changes.
Change-Id: I996d5c0ec6e480fcbdc546bad238eee2e20504d6
10 years ago
Josh Kearney c1ea298904 Clean up test environment and remove unused imports.
First round of adding more complete unit test coverage.

Change-Id: Ic1979c499ca6fcb784892a95954a3527539c4e53
11 years ago
Bhuvan Arumugam 8010e773ac Document the use of keyring.
* README.rst
  Document the option --os-use-keyring, and environment variable
  OS_USE_KEYRING, to enable keyring.

Change-Id: I54ceb2d2692fecca328da16f6ed14db8d09a6eb7
11 years ago
Dolph Mathews 540c4883d6 Secure password prompt (docs)
Change-Id: I879a8aba13318f1dd660a487cbd1fd20c7ae659b
11 years ago
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
11 years ago
Matt Joyce 64f685ad63 minor fixes
Change-Id: Ib5601e1a932e0bfaa0341909416415d1e81ee915
11 years ago
Lorin Hochstein 14ffd1c1df Documented python develop
Change-Id: Ic17f17e6c80f54a633676b7e17a899748038f8d6
11 years ago
Lorin Hochstein fad694e428 Added :: to readme.rst to format correctly.
Also zapped a trailing bit of whitespace

Change-Id: I49d0306c0e73f096d091c27ba54705d9dbe9c0ca
11 years ago
Lorin Hochstein e1afa4c7cc Document how to install the client
This documents a workaround for bug 993390.

Change-Id: I6d930aa9ad142096cdc2790df4be31f0b1570199
11 years ago
Matt Joyce 25051a733d Updating Readme Document
Change-Id: I0c0f5c86b0bfa96ab4d7236eb2e7e7efab6fbac0
11 years ago
Dean Troyer 2f2191b9ed Add token auth to shell and README 11 years ago
Dean Troyer f4b5ef39f6 First commit 11 years ago