summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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
|\
| * Update api docs title to make ToC betterJohn Dickinson2016-02-221-3/+3
| | | | | | | | Change-Id: Ie8eeb3dd8eddf1868f0fa99911c459ae9f7b0091
* | New python swiftclient docAlexandra2016-02-103-0/+79
|/ | | | | | Updating with new ToC to be worked on at hackathon Change-Id: I55ee83626dd88fcc3e6352b3854b758dd7090590
* Use bulk-delete middleware when availableTim Burke2016-01-121-0/+1
| | | | | | | | | | | | | | | | | | | | | | When issuing `delete` commands that would require three or more individual deletes, check whether the cluster supports bulk deletes and use that if it's available. Additionally, a new option is added to the `delete` command: * --prefix <prefix> Delete all objects that start with <prefix>. This is similar to the --prefix option for the `list` command. Example: $ swift delete c --prefix obj_prefix/ ...will delete from container "c" all objects whose name begins with "obj_prefix/", such as "obj_prefix/foo" and "obj_prefix/bar". Change-Id: I6b9504848d6ef562cf4f570bbcd17db4e3da8264
* Merge "New API documentation for python-swiftclient"Jenkins2015-12-102-14/+744
|\
| * New API documentation for python-swiftclientJoel Wright2015-11-252-14/+744
| | | | | | | | | | | | | | | | New documentation for python-swiftclient that introduces the APIs available and gives some opinionated advice about when to use the shell, the client API and the service API. Change-Id: I19020f041fab2e72469979f712ffe3951c431d24
* | Unification of manpages and docstringsPeter Lisák2015-11-131-15/+27
|/ | | | | | | * adding missing options * unification of help Change-Id: I2365e66433b63de8fd4da205611d9c1bf3bb6730
* enable autodocumentation for utils module; docstring fixesZack M. Davis2015-09-101-0/+5
| | | | | | | | | | | | | | This commit adds the utils module to those for which Sphinx automatically generates documentation from docstrings. (Many of the functions here may be of little interest to users, but `generate_temp_url`, at least, definitely deserves to be in the documentation; in this way, this commit can be seen as a spiritual companion to ca70dd9e.) Also, a few markup errors and perceived infelicities in existing docstrings are amended. Change-Id: I8c66a23cb359d7dd9302a16459fad9825fedb690
* absolute expiry option for tempURL generationZack M. Davis2015-09-041-5/+7
| | | | | | | | | | | | | | | | | | | | The `tempurl` subcommand's second positional argument is called `seconds` and has heretofore interpreted as the number of seconds for which the tempURL should be valid, counting from the moment of running the command. This is indeed a common, if not the most common, use-case. But some users, occasionally, might want to generate a tempURL that expires at some particular ("absolute") time, rather than a particular amount of time relative to the moment of happening to run the command. (One might make an analogy to the way in which Swift's expiring object support supports an `X-Delete-At` header in addition to `X-Delete-After`—and it's the former that must be regarded as ontologically prior.) Thus, this commit adds an `--absolute` optional argument to the `tempurl` subcommand; if present, the `seconds` argument will be interpreted as a Unix timestamp of when the tempURL should be expire, rather than a duration for which the tempURL should be valid starting from "now". Change-Id: If9ded96f2799800958d5063127f3de812f50ef06
* add tempurl command to swift.1 man pageZack M. Davis2015-07-131-0/+8
| | | | | Change-Id: Ifccc7f6dc049ca0ac2c53c00b1704cff4d1a770f Closes-Bug: #1450606
View Lorry Controller Status