61 Commits

Author SHA1 Message Date
Rui Yuan Dou
8e862b6018 Remove deprecated ssl options
Old deprecated ssl options block the new keystoneauth parser get the
correct value, should be removed.

Change-Id: Ie080f9a8fa7f4407b1fcbb7fb7c763152c5ec295
Closes-Bug: 1697163
2018-01-17 08:50:57 +08:00
Zuul
11ac1e2eb3 Merge "Update Image service property keys doc" 2018-01-02 21:52:01 +00:00
Brian Rosmaita
726c50db81 Update Image service property keys doc
Doc update for change Ie8227fececa40e502aaa39d77de2a1cd0cd72682

Change-Id: I4b35d0ae768b331945cd014c004cef16ed2155b3
Closes-bug: #1694441
2017-12-22 20:31:40 +00:00
Brian Rosmaita
8eea3c7ef0 Update Image service property keys docs
Doc update for change I7c77fb13f20b59ad764070d14dc98a46f8b7c823

Change-Id: I8a636019c88526f6d65a96e9184aad10010eded2
Closes-bug: #1651907
2017-12-22 20:31:24 +00:00
Jenkins
ddf45e52d1 Merge "Add documentation for image import commands" 2017-07-27 19:57:34 +00:00
Jenkins
c9e10aef03 Merge "Update glanceclient version ref" 2017-07-27 16:08:46 +00:00
Brian Rosmaita
9a4f91c39e Add documentation for image import commands
Add documentation for the image import commands, particularly
pointing out that the image-create-via-import command is an
EXPERIMENTAL command that my be renamed or removed in a future
release.

Change-Id: I20ebc0145db6acc794039ed25e7754ec8d479bc8
2017-07-27 12:07:48 -04:00
Jenkins
ca9ae01841 Merge "Make --profile load from environment variables" 2017-07-26 04:33:49 +00:00
Brian Rosmaita
51fea1b00a Update glanceclient version ref
Update a docs reference to the client version in preparation
for the next release.

Change-Id: I5f9542a543507290bdd8579adf773fe1b6bba5f6
2017-07-25 13:44:13 +00:00
PranaliD
28c003dc11 Removed the --no-ssl-compression parameter which is deprecated
--no-ssl-compression is deprecated and no longer used. So, it is
removed from the help message.

Change-Id: I2b886671a568ed191ee380cf16335ccd9ae85062
Closes-Bug: #1583919
2017-07-25 18:51:38 +05:30
Tovin Seven
c0f88d5fc0 Make --profile load from environment variables
--profile argument can be loaded from OS_PROFILE environment variables
to avoid repeating --profile in client commands.

Correct/update help text.

Co-Authored-By: Hieu LE <hieulq@vn.fujitsu.com>
Change-Id: I67c1e4b859b972e380eb658c98ceae4fbef5c254
2017-07-24 13:30:29 +07:00
Hangdong Zhang
c753ad8796 Update and optimize documentation links
1. Update URLs according to document migration
2. Update the dead and outdated links
3. Optimize (e.g. http -> https)

Change-Id: Iad743ad223b8c40ae914beccd936f71a81622d76
2017-07-19 12:38:19 +08:00
Javier Pena
8435b47f80 Fix man page build
https://review.openstack.org/474775 moved glance.rst from the
doc/source/man directory into doc/source/cli, so we need to adjust
the path in conf.py to avoid issues when running:

python setup.py build_sphinx -b man

Change-Id: I2c37755553d1265fb9fb069067c4468853f395b7
2017-07-04 16:48:28 +02:00
Doug Hellmann
c859380718 turn on warning-is-error in sphinx build
Fix a formatting error in one docstring and turn on the flag to ensure
that future warnings in the doc build trigger a build failure.

Change-Id: I7159b985d1690a8ae61ff885408da4623c105952
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-28 12:25:32 -04:00
Doug Hellmann
4565e2bf45 use openstackdocstheme html context
Set some of the new config values and enable openstackdocstheme as an
extension so it will inject values into the page context as it writes
each documentation page. This ensures the pages link to the right bug
tracker, etc.

Change-Id: I316bd585f91064af4d1d1e7b834986619fc3a2d3
Depends-On: Icf3a40ed104cfd828f532f6f2b112ed02f996ff5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-28 12:25:32 -04:00
Doug Hellmann
b7a0cd0e66 switch to openstackdocstheme
Change-Id: Id687e3405d8afe0db201eb648941cc51bb9f741e
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-28 12:25:30 -04:00
Doug Hellmann
ca7faf6bb5 import content from cli-reference in openstack-manuals
Change-Id: Ibea5fe3e4711af997841992dead7171c99c69bfa
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-28 12:24:48 -04:00
Doug Hellmann
e8acf5e736 move existing content into the new standard structure
This patch rearranges and reformats existing content.

It replaces the home-grown autodoc feature with the one built into pbr,
for consistency with other OpenStack projects.

It depends on the doc-migration spec and a pbr feature to allow us to
specify where the autodoc content should go in the source tree during
the build.

Change-Id: I8d2bb11b5ef3e46fcd22c8bed8f84060d8ab6f03
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Depends-On: I2bd5652bb59cbd9c939931ba2e7db1b37d2b30bb
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-28 12:24:48 -04:00
Doug Hellmann
c9100ed742 move old release notes into the releasenotes doc tree
Change-Id: I00797d38d6ad9b1a7b198767a0cbbb2f619c3b43
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-20 13:08:40 -04:00
Stephen Finucane
50eaad2249 doc: Remove cruft from conf.py
Change-Id: I1bbb2d490f0415e4062da520e6fb09e6db477aa0
2017-04-20 09:40:19 +01:00
Stephen Finucane
0e2e3f4372 Use Sphinx 1.5 warning-is-error
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Enable this.

Change-Id: I39ffb22c37a05f00cade2fbd14449eaf77dc3d39
2017-04-20 09:40:15 +01:00
Tom Cocozzello
c6904d0332 Docs are generated incorrectly
When docs are generated with pbr command 'warnerrors = True'
there are many doc problems that are shown. This patch fixes
these problems.

Change-Id: Idb804ab924782b6d7d379494987bdba2acbce568
Closes-Bug: #1557235
2016-03-22 13:28:14 +00:00
Jenkins
56311d6e24 Merge "Change man page examples to correlate default v2" 2015-12-01 15:59:26 +00:00
Erno Kuvaja
e2384d0012 Change man page examples to correlate default v2
Changing examples to correlate default behavior (v2 API) rather than
old v1 options.

Change-Id: I13a0d6040bfcd246189e0c1aeadf104ff5eff131
2015-11-17 16:33:33 +00:00
Erno Kuvaja
d91210c806 Release Notes for version 1.2.0
1f1934e Add versions list function
bff356e Added reactivate/deactivate image using CLI
dfcb468 Fix the missing help descripiton of "image-create"
8a4cd79 Add documentation for running the functional tests
c7c0754 Updated from global requirements
d6a10f2 Remove unused sphinx Makefile
5a24705 Update docs to recommend KSA instead of KSC
84538d8 Use clouds.yaml from devstack for functional tests
4fb3092 Add translation to v2 shell
6b9133c Import i18n functions directly
8cf2bfc Updated from global requirements
b51634a improve readme contents
ca050ed Add support for setting Accept-Language header
3bd28bf Updated from global requirements
36937bb Use the subcomand parsed args instead of the base
afd1810 Stop trying to send image_size to the server
bf02b04 Support image deletion in batches in v2
a8a7c68 print usage when no argument is specified for python3
77012ee Updated from global requirements
603697a Updated from global requirements
df0f664 Do not use openstack.common.i18n in glance client
abf0381 Added unit tests for 'Unicode support shell client'
1f2fefb Use common identity parameters fro keystone client
c31c136 No auth when token and endpoint are passed
557acb1 Use dictionary literal for dictionary creation
c6addc7 Replace exception_to_str with oslo.utils function
586d401 Change ignore-errors to ignore_errors
05cd0c7 Add period in help message
b8a881f Don't get the image before deleting it
3d3d829 Fix human readable when size is None
19480df Add parsing the endpoint URL
22ce845 Fix Typos in comments
b9eee5e Add check Identity validate when get schemas

Change-Id: If2964135d73b45a11faf03b7dfa6b6f756a1abe0
2015-11-16 15:57:13 +00:00
Monty Taylor
5a247055ae Update docs to recommend KSA instead of KSC
For the session workflow (which is really the only workflow a dev should
use), session objects should now come from keystoneauth1 instead of
python-keystoneclient.

Change-Id: Icb5f20ce3dc09ff7790b27d07f7f0cb3b83e1e7e
2015-10-21 17:38:54 +09:00
Erno Kuvaja
86635868c1 Change next version in docs
As stated by Doug we need to release 1.1.0 instead of 1.0.1
https://review.openstack.org/#/c/222716/

Change-Id: Ifb24361a1d5a5270c6b3173ba28409addfec19b0
2015-09-14 15:09:55 +00:00
Erno Kuvaja
04a54fed14 1.0.1 Release notes
f6712f5 Print the reverting back to v1 to stderr
2c7da7c Invalid output running the command 'glance image-show <image_id>'
5026774 Don't make `help` require auth parameters
75ec903 check for None value in utils.safe_header
f0b30f4 Updated from global requirements
1322fbc Consider `--os-token` when using v2
47423eb Check if v2 is available and fallback
90b7dc4 Update path to subunit2html in post_test_hook
1e2274a Password should be prompted once

Change-Id: I70329b9596421a4d8c0c953c19759a96f29c8b0d
2015-09-11 14:58:18 +00:00
Erno Kuvaja
54ae632f1b 1.0.0 release notes
Change-Id: I2cc3ba8d0064d6f424f16be94deaecdf1c5c8332
2015-08-27 20:02:30 +00:00
Nikhil Komawar
db6420b447 Add release notes for 0.19.0
Changes included in this release:

    $ git log 0.18.0..HEAD --no-merges --oneline
    dfa98ab Updated from global requirements
    6cb26fc Include owner and status option in v2 image list
    5d933b0 Fix Metadef Object update issue with python-glanceclient
    9f5c581 Fix functional tests in gate
    1686d6a Do not crash on homedir mkdir
    1f89beb Improve import related error handling
    583adc3 Check image-download for redirection
    9c172fb Add some basic CLI functional tests
    bf413a6 Use assertIn instead of assertTrue in tests
    6431fae Unorder compare in tests
    5fa71aa Add release notes for 0.18.0
    6d31116 Update README to work with release tools
    71d9783 Create functional test base
    f2a8a52 Move unit tests to standard directory
    f931a20 Fixed doc example

Co-Authored-By: Louis Taylor <louis@kragniz.eu>

Change-Id: Ied7f5b4f298e2bbf4a5486eb6b7dbcea2d0e74d3
2015-06-10 10:04:23 +01:00
Jenkins
7ab3490978 Merge "Fixed doc example" 2015-05-26 17:16:57 +00:00
Louis Taylor
5fa71aa560 Add release notes for 0.18.0
Changes included in this release:

    $ git log 0.17.0..0.18.0 --no-merges --oneline
    8b4456a Uncap library requirements for liberty
    76c9f68 Add unit tests for log_curl_request
    bd0aa06 Fix https stack trace on python 3.4 client
    c698b4e Fix client when using no ssl compression
    64a1a0f Add SSL cert verification regression tests
    c730266 Omit 'locations' as image-create parameter
    a6234d1 Creating task with invalid property crashes in py3
    fd2f989 Don't accept *args for client
    e386e44 Stub authentication requests rather than plugins
    27f70bb Remove keystoneclient mocks
    02b1a05 Replace mox in tests with requests-mock
    90407d9 Expose 'is_base' schema property attribute
    2c08b40 Validate tag name when filtering for images
    13b5a5a Remove redundant FakeSchemaAPI __init__ method
    c149a94 glance image-show now have --human-readable option
    42d7548 Test unit for checking update active images
    6d864ef Correct help messages for image-update command
    f272ab3 Generate API documentation
    a1bb3eb Use any instead of False in generator

Change-Id: I687bef82afd7bb9a379297d7128a009cc051ca75
2015-04-23 13:31:11 +01:00
Jenkins
15c2e40449 Merge "Generate API documentation" 2015-03-25 05:17:08 +00:00
Nikhil Komawar
26280ed58b Add release notes for 0.17.0
$ git log 0.16.1..HEAD --no-merges --oneline

db5d729 Updated help for v2 member-update api
3f3066b Extend images CLI v2 with new sorting syntax
bbd27d5 Add the ability to specify the sort dir for each key
976fe17 Import sys module
fc79467 Adds the ability to sort images with multiple keys
f00f769 add examples for properties and doc build script
f6f5733 Apply expected patch format when updating tags in v2.images
a9a692b v2: read limit for list from --limit in shell
0ab5a78 Fix leaking sockets after v2 list operation
f98ab68 Fix leaking sockets after v1 list operation
6e0b1f4 removed excessive call to os.path.exists
b47925e Unit tests covering missing username or password
b64dba8 Remove duplicate 'a' in the help string of --os-image-url
6d21959 v2: Allow upload from stdin on image-create
4c7c7ad Fix v2 image create --file documentation
eeef763 Fix minor typo in version error message

Change-Id: I90d7e4a5109d82e25a63135e94193f4c4f7d4f34
2015-03-18 16:23:01 -04:00
Alan Meadows
f00f769da5 add examples for properties and doc build script
* add image property examples for v1 and v2
* add standard sphinx doc build helper

Change-Id: I2f8dff884d9f22cc582aabcbbbbaea6d6fe725c0
2015-03-13 07:01:55 -07:00
Louis Taylor
d3814693a8 Add release notes for 0.16.1
Release notes for the following commits:

$ git log --oneline --no-merges 0.16.0..HEAD
96871b9 Fix tests failing if keystone is running locally
2d67dfa Unify using six.moves.range rename everywhere
af29e0a Show error on trying to upload to non-queued image
ef9fd9f https: Prevent leaking sockets for some operations
01caf4e Strip json and html from error messages
7ee96cb Register our own ConnectionPool without globals
1d82396 Remove graduated gettextutils from openstack/common
a755d1f Workflow documentation is now in infra-manual

Change-Id: Ieed106bff9aa95a7d40b0c39717aa16db4ddbf7e
2015-03-04 17:42:12 +00:00
Louis Taylor
519672f5d5 Add release notes for 0.16.0
This adds release notes for the following commits:

$ git log --oneline --no-merges 0.15.0..HEAD
f7cdc3e Glance image delete output
a3eaafe Updated from global requirements
e99e0c8 Change oslo.utils to oslo_utils
96ff6e4 Return 130 for keyboard interrupt
db743e3 Ignore NoneType when encoding headers
869e6ac Use utils.exit rather than print+sys.exit
5ec4a24 Remove uuidutils from openstack-common
93c9bc1 Add a `--limit` parameter to list operations
9daada9 Fixed CLI help for bash-completion
878bdcb Remove openstack.common.importutils
b818826 Remove openstack.common.strutils
35c9b65 Adds basic examples of v2 API usage
363b170 Sync latest apiclient from oslo-inc
f210751 Close streamed requests explicitly
62df6c6 Handle HTTP byte returns in python 3
aebbcff Updated from global requirements
cb046bc Add validation to --property-filter in v1 shell
6eaaad5 Make non-boolean check strict
9054324 Disable progress bar if image is piped into client
df02ee8 Fix Requests breaking download progress bar
e3600ad Fix broken-pipe seen in glance-api
b96f613 Update HTTPS certificate handling for pep-0476
8e8dde2 Output clear error message on invalid api version
bd73a54 Add os_ prefix to project_domain_name/id
465c5ce Curl statements to include globoff for IPv6 URLs
9dcf3f1 Reduce the set of supported client SSL ciphers

Change-Id: Ib97fd745f1f6761b88246351ce2c63d11ad29b01
2015-02-23 23:08:33 +00:00
Ian Wienand
f272ab3ae4 Generate API documentation
As a new user I found navigating the documentation difficult.  The
flow was a bit unclear and searches bring up old versions of API
references that aren't included in the current documentation.

This
 - provides an introduction to the tools similar to other projects
 - generates API references for the v1 and v2 client
 - fixes some minor docstring issues
 - adds doc/* to pep8 tests to check the conf.py

The API generation code is cribbed from python-novaclient

Change-Id: I65772127679d7afd5e7e48ca7872366b01382f21
2015-02-16 11:09:00 +11:00
Jenkins
ffcb324efc Merge "Adds basic examples of v2 API usage" 2015-02-05 22:44:16 +00:00
Markus Zoeller
35c9b65202 Adds basic examples of v2 API usage
Closes-Bug: 1321438

Change-Id: I7c4a5db5bd498c6fb1dd2f4fdbf347b8d4c02c9a
2015-01-26 16:45:36 +01:00
Louis Taylor
385d97ef38 Add release notes for 0.15.0
This adds release notes for the folowing commits:

    $ git log --oneline --no-merges 0.14.2..HEAD
    9a4d858 Support Pagination for namespace list
    3989cd2 Support schema types with non-str value
    9829d7b Don't require version to create Client instance
    8e02b2a Allow --file in image-create with v2 Image API
    d5a0e65 Add useful error on invalid --os-image-api-version
    49f38a4 Add release notes for 0.14.0 - 0.14.2
    5080d10 Send `identity_headers` through the wire
    d0851c3 Remove readonly options from v2 shell commands
    4194a55 Add --property-filter option to v2 image-list
    ef0abdc Fix py34 failure for glance client
    8c159a2 Don't set X-Auth-Token key in http session header if no token provided
    b83a672 Refactor method of constructing dicts in some tests
    751e064 Adds tty password entry for glanceclient
    597da8a '--public' ignored on image create
    cbbfbc9 Fix to ensure endpoint_type is used by _get_endpoint()
    12a3a82 Add bash completion to glance client

Change-Id: I24fbba80831c311b42d1abb08487cc29c8b5b162
2014-12-11 16:45:46 +00:00
Louis Taylor
49f38a4242 Add release notes for 0.14.0 - 0.14.2
These were not written at the time of release, so this catches up with
the latest version.

For reference:

    $ git log --oneline --no-merges 0.13.0..0.14.0
    33dcea8 Support for Metadata Definitions Catalog API
    16077d9 Catch new urllib3 exception: ProtocolError
    6dda6f3 Fix error when logging http response with python 3
    d6498b6 Ensure server's SSL cert is validated
    9a53c1f Enable osprofiler interface in glanceclient shell
    69361a1 Hide stderr noise in test output
    1dfce53 Remove deprecated commands from shell
    867e4ca Normalize glanceclient requested service url
    4494853 Fix glance-client to work with IPv6 controllers
    f15dc6b Add support for Keystone v3
    7736349 Update theme for docs
    e79031b Add a tox job for generating docs
    68c1d1f Don't stream non-binary requests
    f75a810 Use a correctly formatted example location in help
    dbb242b Replace old httpclient with requests
    1db17aa Enable F841
    797d101 Resolving the performance issue for image listing of v2 API
    e305dad Add profiling support to glanceclinet
    9b9f3be Use immutable arg rather mutable arg
    1c46c76 Add CONTRIBUTING.rst

    $ git log --oneline --no-merges 0.14.0..0.14.1                                                                                                                                                                                                                                                                                                                                                                                      f980fc5 Update how tokens are redacted
    ba19a53 Handle UnicodeDecodeError in log_http_response
    4d6b94a Print traceback to stderr if --debug is set
    61e4eba Updated from global requirements
    97b1506 Fix v2 requests to non-bleeding edge servers
    9fbc313 Work toward Python 3.4 support and testing
    d97f03e Import missing gettextutils._ in shell.py
    4631b76 Fix indentation in tox.ini
    cda8c4d Downgrade log message for http request failures
    8770586 CLI image-update gives a wrong help on '--tags' param

    $ git log --oneline --no-merges 0.14.1..0.14.2
    052904b Don't replace the https handler in the poolmanager
    5f4966d Remove network_utils
    2b567cf Skip non-base properties in patch method
    7ef1b7c Adds support for Glance Tasks calls
    1511c86 Fix the ordering of assertEqual arguments
    ab07caf Stop using intersphinx
    929a72e Default to system CA bundle if no CA certificate is provided

Change-Id: Ie4195fa9ad7f5f45c387fda4b1db4fbce7a3f98c
2014-11-25 15:53:29 +00:00
Georges Dubus
f931a20d25 Fixed doc example
Image.data is a method, not an attribute.

DocImpact

Change-Id: I16555e456dcb2c9719de6c44c01ab68e82ad0590
2014-10-22 08:02:46 +00:00
Andreas Jaeger
ab07caf8c0 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:40:28 +02:00
Steve Martinelli
7736349b1e Update theme for docs
The current developer docs theme used is out of sync with the other
openstack projects. This patch will update the docs to provide a more
consistent look and feel when using developer docs

Change-Id: I4a59f194bd0fc8c86c6d3c6b8cadb839a5158935
2014-07-24 20:42:56 -04:00
Flavio Percoco
caa1a54fd9 Added release notes for 0.13.0
Change-Id: I51374661a5ce58cd2a970a75893b1251ab6e176b
2014-06-30 11:33:34 +02:00
Wu Wenxiang
80cf47e229 Remove unused imports
Remove unused imports in doc/source/conf.py

Change-Id: Ie5f914ca21ee4229686deec01acd788acd4946b7
Closes-Bug: #1265265
2014-01-01 11:39:31 +08:00
Mark J. Washenberger
7dfd205eb2 Add release notes for 0.12.0
Change-Id: I7642635ba0326d97ca44f08ca54c1d613f1925f1
2013-11-14 23:33:23 -08:00
Mark J. Washenberger
b15c57c4a2 Add 0.11.0 doc notes
Change-Id: Ic76e872e78ec77b731ad9dced833803da3fa9aca
2013-08-22 23:55:52 -07:00
Mark J. Washenberger
5cdbcdf3fc Add 0.10.0 docs update
Change-Id: Ib2e75abc7d696f89d97918738bfc960cf3d1da5b
2013-08-08 19:20:39 -07:00