summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
* Merge "1.0.0 release notes"1.0.0Jenkins2014-12-041-0/+51
|\
| * 1.0.0 release notesSteve Martinelli2014-12-041-0/+51
| | | | | | | | | | | | Release notes for our next cut of osc. Change-Id: Ic3b0d557f2a380c4b5a05903ff7394be7b961b55
* | Merge "Command object docs: catalog, credentials, endpoint, region, token"Jenkins2014-12-046-2/+207
|\ \
| * | Command object docs: catalog, credentials, endpoint, region, tokenDean Troyer2014-12-046-2/+207
| |/ | | | | | | | | | | | | | | | | | | catalog credentials endpoint region token Change-Id: Icd7ec7fd207488b2ceb0280722aa9a684aeeac28
* | Merge "Add documentation of interactive mode"Jenkins2014-12-042-0/+112
|\ \
| * | Add documentation of interactive modeDean Troyer2014-12-042-0/+112
| |/ | | | | | | | | | | This is a light description with some examples. Change-Id: Iff9ad904a150f2bb7673bd4106cf26bcefec08b9
* | Command object docs: server, server imageDean Troyer2014-12-033-1/+573
|/ | | | | | | | | server server image Some cosmetic changes in the command source, sorting classes, help strings, etc. Change-Id: I3f68dae77b9fe02bc6866684e05aeff943dd9cc3
* Merge "Add the ability to list projects based on a user"Jenkins2014-12-021-0/+7
|\
| * Add the ability to list projects based on a userSteve Martinelli2014-12-011-0/+7
| | | | | | | | | | | | | | Essentially performing GET /users/{user_id}/projects Change-Id: Iae6ddfc86a856fa24fbe293ec4af52ea671390f8 Closes-Bug: #1394793
* | Merge "Add support for domains when deleting identity v3 resources"Jenkins2014-12-022-0/+14
|\ \ | |/
| * Add support for domains when deleting identity v3 resourcesSteve Martinelli2014-12-012-0/+14
| | | | | | | | | | | | | | | | | | | | Currently, only deleting via IDs is possible for groups, projects and users. We should have an optional --domain argument that allows for a name to be specified for the resource. (Since these are all namespaced by domains). Change-Id: I18ace3db85a3969f0b97678d432d6f8368baa9cd
* | Merge "Command object docs: project, role, user"Jenkins2014-12-015-3/+568
|\ \ | |/
| * Command object docs: project, role, userDean Troyer2014-12-015-3/+568
| | | | | | | | | | | | | | | | | | project role user user role Change-Id: I445e09a3ffb69114912ae562a9285963a636bfd1
* | Merge "Enhance the theming for modules page"Jenkins2014-12-012-3/+9
|\ \ | |/ |/|
| * Enhance the theming for modules pageSteve Martinelli2014-11-182-3/+9
| | | | | | | | | | | | Also fixes a few small docstring syntax errors Change-Id: I85eb968e32c1191cf5d60d02deff2ab7f3291074
* | Command object docs: aggregate, console *, keypairDean Troyer2014-11-195-4/+283
| | | | | | | | | | | | | | | | | | aggregate console log console url keypair Change-Id: Iec9b8404ed5febd061a5dfd674b76aaa8aba67bc
* | Begin copying wiki command list hereDean Troyer2014-11-197-10/+242
| | | | | | | | | | | | | | | | | | | | * Sort by command objects * Drop the comparison to the project CLIs * Minor updates to command help to match docs Initially include the cross-API commands to establish the structure and format. Change-Id: I77a7b3c89e088b66aa62941e29ce0b65b532285b
* | Merge "Add authentication description doc"Jenkins2014-11-182-0/+87
|\ \ | |/ |/|
| * Add authentication description docDean Troyer2014-11-172-0/+87
| | | | | | | | | | | | | | | | This is represents the current operation Closes-Bug: #1337422 Change-Id: I8092e7723b563647e13b6e2f0b7901a16572b6c7
* | Unscoped federated user-specific commandsMatthieu Huin2014-10-301-0/+3
|/ | | | | | | | | | | | 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>
* Support for keystone auth pluginsMatthieu Huin2014-10-091-0/+34
| | | | | | | | | | | | | | | | | | | | | | | 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>
* Add some code-blocks to the docsSteve Martinelli2014-10-032-6/+8
| | | | | | Add some basic highlighting for the docs Change-Id: Ifa740856f3ef636bdf0f60f3b7d082c68062fe9b
* Acknowlege git.o.o as OpenStack's git serverAnita Kuno2014-09-181-5/+5
| | | | | | | OpenStack's cannonical git server is at git.o.o this patch updates the index.rst to reflect that. Change-Id: I54eeea7fab2e0f64ca9f23f7c328e2ff19721a41
* Stop using intersphinxAndreas Jaeger2014-09-131-5/+0
| | | | | | | | | | | | | | 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
* Update docs and release notes for 0.4.1 releaseDean Troyer2014-09-085-30/+193
| | | | | Closes-Bug: 1365505 Change-Id: I027d263ba9980715454b034a37733c5ff23fd169
* Use oslosphinx to generate documentationSteve Martinelli2014-08-0511-1231/+6
| | | | | | | Rather than host different and possibly out of date versions of static and theme files, use oslosphinx to generate the docs. Change-Id: I7eadc8e40aa10cc26cfd6aece6efa5d13fee70b0
* Replaced some UTF-8 characters with ASCII charactersChristian Berendt2014-07-071-1/+1
| | | | Change-Id: Ic4e53b742f8691dd2dafe1a8d7fa45e4340a3c94
* Merge "Remove keyring support from openstackclient"Jenkins2014-07-041-6/+0
|\
| * Remove keyring support from openstackclientAlex Gaynor2014-07-041-6/+0
| | | | | | | | | | | | | | | | * The encryption it purports to offer is completely insecure. * It also appears to be broken. Closes-Bug: #1319381 Change-Id: Id15ecfbbfd15f142b14c125bfd85afd5032699ac
* | trust authenticationMatthieu Huin2014-07-031-5/+9
|/ | | | | | | | | 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
* Update docs and release notes for 0.4.0Dean Troyer2014-06-205-39/+95
| | | | Change-Id: Iad6cfe5dee63adb9e60a0ea9811217b3175eb99c
* Update docs templateSteve Martinelli2014-06-1811-1/+1228
| | | | | | | | | | | | 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
* Fixed Spelling errors - compatability to compatibilityAlex Holden2014-03-071-1/+1
| | | | Change-Id: I9da380cef8b798e21fd35882763bd05f5cf1e33e
* Fixed spelling errors - occurance to occurenceAlex Holden2014-03-071-2/+2
| | | | Change-Id: Ie0550a1168448d85043d9b4943edd732b1f10307
* Update release notes for 0.3.1Dean Troyer2014-02-273-37/+123
| | | | | | | | * update README * update man page * fix doc errors Change-Id: I5682654bf482289879c8ba9016e348f2b2782971
* Release notes for 0.3.0 release0.3.0Dean Troyer2013-12-171-1/+1
| | | | Change-Id: I6f025b745378613eb674e13dd503e57d049a3e50
* Update docs for plugins and release notesDean Troyer2013-12-055-19/+146
| | | | | | | | * Fill out the existing command and man page * Add a plugins page. * Begin the release notes for 0.3.0 Change-Id: I4527fed28a10a9d79fc8f6c1d925a4bf0d0a7a36
* Update release notes for 0.2.20.2.2Dean Troyer2013-09-201-0/+6
| | | | Change-Id: I59cbee4c147d5f849a7f07224e83ddd751212077
* Add release notes in docs0.2.1Dean Troyer2013-08-062-9/+16
| | | | Change-Id: I49dc936a37848745ce3412e810b98348558d1157
* Prep for 0.2 release (0.2.rc1)Dean Troyer2013-08-014-31/+200
| | | | | | | | * 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
* Update documentation with info about setup.cfgMonty Taylor2013-07-051-6/+5
| | | | Change-Id: If87df1e6415d0b70b6605b1d89eda639fc44a0b6
* Multiple API version supportDean Troyer2013-02-061-0/+60
| | | | | | | | | | | | | | | | * 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
* Fix PEP8 issues.lrqrun2012-08-291-20/+31
| | | | | | Fix some pep8 issues in doc/source/conf.py and tests/test_shell.py make the code looks pretty. Change-Id: I927f03aff4190f1ac30eb56e7c545de555978c31
* Fixed a typo in the rst docs.Lorin Hochstein2012-06-261-1/+1
| | | | Change-Id: Ie3484f8fe0a63ff5a6815f3ec440adf7dc5d9482
* Update Contributing blurb in the docs.Clark Boylan2012-06-221-3/+6
| | | | | | | | 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
* Move docs to doc.Clark Boylan2012-06-112-0/+278
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
View Lorry Controller Status