summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* PDF Documentation Build tox targetMatthew Oliver2019-09-041-1/+3
| | | | | | | | | | | This patch adds a `pdf-docs` tox target that will build PDF versions of our docs. As per the Train community goal: https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html Story: 2006122 Task: 35514 Change-Id: I7e0ee410ac603774e4b03f859ac3aa20e5afc9b8
* Merge "Add missing <sync-to> value in command line docs"Zuul2019-07-091-1/+1
|\
| * Add missing <sync-to> value in command line docsKota Tsuyuzaki2018-02-231-1/+1
| | | | | | | | | | | | Because it should take a value of either realm or full url. Change-Id: I1fe30825ef1620e256c9fd3057da6808b03d7200
* | Bump the openstackdocstheme extension to 1.20pengyuesheng2019-07-032-10/+1
| | | | | | | | | | | | | | | | | | | | | | | | Some options are now automatically configured by the version 1.20: - project - html_last_updated_fmt - latex_engine - latex_elements - version - release. Change-Id: I0573c7feaea991e6b33bdee6dc358c9206a9bfd8
* | Isolate docs requirementsTim Burke2019-06-272-0/+5
| | | | | | | | | | | | | | | | | | | | | | ...since modern sphinx won't install on py27. While we're at it, clean up some warnings and treat warnings as errors. Also, fix up how we parse test configs so we can run func tests. Related-Change: Id3c2ed87230c5918c18e2c01d086df8157f036b1 Change-Id: I3718f69610545b0dbcb0a2ab45b400da3a45682c
* | docs: Clean up formattingTim Burke2019-03-254-105/+99
| | | | | | | | Change-Id: I0bcaf15c54dd3b3c590a543569699fe8ec5b0c7c
* | Add option for user to enter passwordAlistair Coles2018-06-111-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | Add the --prompt option for the CLI which will cause the user to be prompted to enter a password. Any password otherwise specified by --key, --os-password or an environment variable will be ignored. The swift client will exit with a warning if the password cannot be entered without its value being echoed. Closes-Bug: #1357562 Change-Id: I513647eed460007617f129691069c6fb1bfe62d7
* | Switch from oslosphinx to openstackdocsthemeNguyen Hai2018-05-231-3/+6
|/ | | | | | | | openstackdocstheme is a theme and extension support for Sphinx documentation that is published to docs.openstack.org and developer.openstack.org. Change-Id: I37d1d50fb88b35e72b017d5dfbf148c35ac7e323
* Update the old http doc linksshangxiaobj2018-01-301-2/+2
| | | | | | | Update the old http doc links to the https ones according to the official OpenStack website. Change-Id: Ibf9ecbccb743d2b9a678a1ca69f0b3adc9106a12
* Allow for uploads from standard input.Timur Alperovich2017-07-262-6/+9
| | | | | | | | | | | | | If "-" is passed in for the source, python-swiftclient will upload the object by reading the contents of the standard input. The object name option must be set, as well, and this cannot be used in conjunction with other files. This approach stores the entire contents as one object. A follow on patch will change this behavior to upload from standard input as SLO, unless the segment size is larger than the content size. Change-Id: I1a8be6377de06f702e0f336a5a593408ed49be02
* moved cli doc to the right place for new links processJohn Dickinson2017-07-262-1/+1
| | | | Change-Id: I5d2f681ba5ce1f95d006eb7208cdb388a64811c9
* Update the documentation link for doc migrationHangdong Zhang2017-07-242-4/+4
| | | | Change-Id: I1a5a354675b3ca6a7dbb5ab2dc78bf60209fa2b5
* merged openstack-manuals content with existing contentJohn Dickinson2017-07-211-116/+632
| | | | Change-Id: I05bc8f80daefbb32f32727550a9cbe43e9754e2f
* Option to ignore mtime metadata entry.Christopher Bartz2017-07-062-1/+6
| | | | | | | | | | | | | | | Currently, the swiftclient upload command passes a custom metadata header for each object (called object-meta-mtime), whose value is the current UNIX timestamp. When downloading such an object with the swiftclient, the mtime header is parsed and passed as the atime and mtime for the newly created file. There are use-cases where this is not desired, for example when using tmp or scratch directories in which files older than a specific date are deleted. This commit provides a boolean option for ignoring the mtime header. Change-Id: If60b389aa910c6f1969b999b5d3b6d0940375686
* ISO 8601 timestamps for tempurlChristopher Bartz2017-03-292-12/+52
| | | | | | | | | Client-side implementation for ISO 8601 timestamp support of tempurl middleware. Please see https://review.openstack.org/#/c/422679/ Change-Id: I76da28b48948475ec1bae5258e0b39a316553fb7
* Removing duplicated doc from client-apiNelson Marcos2017-03-271-20/+0
| | | | Change-Id: I1a9ef0c33c68a32808686194c74c27d66d2617e0
* Merge "[trivial] Be consistent in using example.com"Jenkins2017-03-221-2/+2
|\
| * [trivial] Be consistent in using example.comPetr Kovar2017-03-131-2/+2
| | | | | | | | | | | | * Use distro-agnostic example.com in all examples. Change-Id: If0a7217b7312875bb4ca8258f4ef86c52cd2e577
* | Merge "Don't recommend to overwrite imported `session` variable"Jenkins2017-03-171-2/+2
|\ \ | |/ |/|
| * Don't recommend to overwrite imported `session` variableKota Tsuyuzaki2017-03-161-2/+2
| | | | | | | | Change-Id: I34e25e674aac3a85a4702779053d95962b292281
* | Change swift.o.o URLAndreas Jaeger2017-03-081-1/+1
| | | | | | | | | | | | | | This is an obsolete URL that redirects, use docs.o.o - and use https for it. Change-Id: I7ba2c49db2c620071f8eeb96d0b63af8381ed899
* | prefix-based tempurls supportChristopher Bartz2017-01-192-3/+8
| | | | | | | | | | | | | | | | | | Implements client-side functionality for prefix-based tempurls. Please see: https://review.openstack.org/#/c/274048/ Change-Id: I8d7701daee888ed1120271a96c0660b01543ca2d
* | Typo fixwangxiyuan2016-12-151-2/+2
| | | | | | | | | | | | Change "novaclient" to "swiftclient" Change-Id: I685b476cb05c223959c977b135a8217fb961afb1
* | Merge "Add commands examples for copy and delete"Jenkins2016-12-151-2/+28
|\ \
| * | Add commands examples for copy and deletezheng yin2016-10-201-2/+28
| | | | | | | | | | | | | | | | | | | | | | | | There are no examples for copy and delete command. For beginners, they may not use both commands. Therefore, I add examples, then beginners are able to understand how to use both commands. Change-Id: Id702dc3f9ab903c1c1183c1e229dc6ebedaac0a7
* | | Merge "Fix 'url' to 'URL'"Jenkins2016-12-011-1/+1
|\ \ \ | |_|/ |/| |
| * | Fix 'url' to 'URL'Yushiro FURUKAWA2016-09-291-1/+1
| | | | | | | | | | | | | | | | | | TrivialFix Change-Id: I6f35b0c48eda7d6021c2f6a13c084170ebf552d2
* | | Merge "Add v1password keystoneauth plugin"Jenkins2016-11-082-1/+7
|\ \ \
| * | | Add v1password keystoneauth pluginTim Burke2016-10-242-1/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This lets us use Keystone sessions against endpoints like swauth and tempauth with code like: import keystoneauth1.loading import keystoneauth1.session import swiftclient loader = keystoneauth1.loading.get_plugin_loader('v1password') auth_plugin = loader.load_from_options( auth_url='http://saio:8080/auth/v1.0', username='test:tester', password='testing') keystone_session = keystoneauth1.session.Session(auth_plugin) conn = swiftclient.Connection(session=keystone_session) The plugin includes an optional project_name option, which may be used to override the swift account from the storage url that was returned. Additionally, it includes enough infrastructure to support some commands in python-openstackclient>=3.0: export OS_AUTH_TYPE=v1password export OS_AUTH_URL=http://saio:8080/auth/v1.0 export OS_PROJECT_NAME=AUTH_test2 export OS_USERNAME=test:tester export OS_PASSWORD=testing openstack token issue openstack catalog list openstack catalog show object-store openstack object store account show openstack container list openstack container create <container> openstack container save <container> openstack container show <container> openstack container delete <container> openstack object list <container> openstack object create <container> <file> openstack object save <container> <object> opsentack object show <container> <object> openstack object delete <container> <object> Change-Id: Ia963dc44415f72a6518227e86d9528a987e07491
* | | | Correct the example keystone session code importsMatthew Oliver2016-10-291-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is a follow up to patch Ia3fd947ff619c11ff0ce474897533dcf7b49d9b3. One of the imports for the keystone session example was wrong. It was trying to import v3 like: from keystoneauth1 import v3 Whereas in my testing v3 actually exists deeper under identity: from keystoneauth1.identity import v3 This patch fixes this import in the example documentation. Change-Id: Ie31144fe65116d20a36b83a96079a3804bf55f29
* | | | Merge "Adding keystoneauth sessions support"Jenkins2016-10-261-0/+22
|\ \ \ \ | |/ / / | | / / | |/ / |/| |
| * | Adding keystoneauth sessions supportPaulo Ewerton2016-05-191-0/+22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch allows authentication in swiftclient with a keystonauth session. Co-Authored-By: Tim Burke <tim@swiftstack.com> Change-Id: Ia3fd947ff619c11ff0ce474897533dcf7b49d9b3 Closes-Bug: 1518938
* | | TrivialFix: Removed redundant 'the'Anh Tran2016-09-271-1/+1
| | | | | | | | | | | | Change-Id: I3b3c0e7e4d5c8a1934378e2083a64bb686754f18
* | | Merge "Change Examples from headings to topics"Jenkins2016-09-051-61/+53
|\ \ \ | |_|/ |/| |
| * | Change Examples from headings to topicsTim Burke2016-08-261-61/+53
| | | | | | | | | | | | | | | | | | | | | | | | Previously, they appeared in the table of contents, which seemed unnecessary. Additionally, de-dent the bullet list for stat since it looked weird. Change-Id: Ief5d480beb4a7daa2fd87c27019601332f087602
* | | Merge "Add swift tempurl and swift auth command docstring"Jenkins2016-08-301-0/+43
|\ \ \ | |/ / |/| |
| * | Add swift tempurl and swift auth command docstringzheng yin2016-08-301-0/+43
| | | | | | | | | | | | | | | | | | | | | | | | Swift has commands including 'swift tempurl' and 'swift auth', but it has no 'swift tempurl' and 'swift auth' in doc/source/cli.rst. Therefore, I add them and their examples. Change-Id: I9a935b648556e2718727d25ac553c860ebbadd82
* | | Merge "Fix examples and missing code-block"Jenkins2016-08-251-0/+2
|\ \ \ | |/ / |/| |
| * | Fix examples and missing code-blockJoel Wright2016-08-251-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | This patch fixes a missing code-block section in the capabilities section of service-api.rst, and fixes the import of walk in the upload.py examples to support both python2 and python3. Change-Id: I572769f971f84e0029f2948e42c130e73517f434
* | | Merge "Add copy object method"Jenkins2016-08-243-4/+105
|\ \ \
| * | | Add copy object methodMarek Kaleta2016-08-233-4/+105
| |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Implement copy object method in swiftclient Connection, Service and CLI. Although COPY functionality can be accomplished with 'X-Copy-From' header in PUT request, using copy is more convenient especially when using copy for updating object metadata non-destructively. Closes-Bug: 1474939 Change-Id: I1338ac411f418f4adb3d06753d044a484a7f32a4
* | | reenable sidebar linksJohn Dickinson2016-08-111-0/+2
| | | | | | | | | | | | | | | | | | uses new method from https://review.openstack.org/#/c/340509/ Change-Id: I4d19b71b632546fc2e5d5dac2b0d8d43152dabed
* | | Add --json option to `swift capabilities` / `swift info`Tim Burke2016-08-021-13/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This lets us do things like: $ swift info --json | jq '[.swift.policies[].name]' [ "Standard-Replica", "EC" ] Also, escape more dashes in the man page, so they won't be misinterpreted as hyphens. Change-Id: Ic7690bdbcfc55f55e5dde9bc11bb0644085973ce
* | | fixing nit picks in python-swiftclient docShashirekha Gundur2016-07-073-3/+3
| | | | | | | | | | | | Change-Id: Ifde19be175ea828a3137951a0382492434727b5b
* | | Merge "Add an option: disable etag check on downloads"Jenkins2016-06-063-1/+6
|\ \ \ | |/ / |/| |
| * | Add an option: disable etag check on downloadsCheng Li2016-06-023-1/+6
| |/ | | | | | | | | | | | | | | This patch is to add an option of disable etag check on downloads. Change-Id: I9ad389dd691942dea6db470ca3f0543eb6e9703e Closes-bug: #1581147
* | Fixed a typo in SwiftService API docNandini Tata2016-06-011-1/+1
|/ | | | | | Fixed misspelled word in the Service API description. Change-Id: I0bb6b2aa319ba217dd0d09a2c7a0d8eff9a67aff
* Add new doc structure and contents for swiftclientJoel Wright2016-04-296-329/+976
| | | | | | | | | | | | | | | | | | | | As a result of the Hackathon we have produced a new documentation structure for the python-swiftclient. This patch introduces the new structure and adds the required content. The intention is to document the CLI, the SwiftService and Connection API. Importantly, we also provide guidance on important considerations when using a swift object store, such as which aspect of the python-swiftclient to use for various use cases, common authentication patterns and some useful examples. Co-Authored-By: Alexandra Settle <alexandra.settle@rackspace.com> Co-Authored-By: Mohit Motiani <mohit.motiani@intel.com> Co-Authored-By: Hisashi Osanai <osanai.hisashi@jp.fujitsu.com> Change-Id: I9eb41f8e9137efa66cead67dc264a76a3c03fbda
* Minor edits to the api pageAlexandra2016-02-291-66/+65
| | | | Change-Id: Ie65f73532e53a858ee9ab4b4634dcfcaf8a93c3b
* Merge "Update api docs title to make ToC better"Jenkins2016-02-241-3/+3
|\
View Lorry Controller Status