mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Fix revert artifacts, doc update
This commit is contained in:
parent
48b09d85b4
commit
d8bf5033ec
1 changed files with 1 additions and 70 deletions
|
@ -19,55 +19,34 @@
|
||||||
|
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
<<<<<<< HEAD
|
|
||||||
module: rax_files_objects
|
module: rax_files_objects
|
||||||
short_description: Upload, download, and delete objects in Rackspace Cloud Files
|
short_description: Upload, download, and delete objects in Rackspace Cloud Files
|
||||||
=======
|
|
||||||
module:
|
|
||||||
short_description: create, fetch, and delete objects in Rackspace Cloud Files
|
|
||||||
>>>>>>> parent of b11d622... Revert "Merge pull request #5496 from angstwad/cf-module"
|
|
||||||
description:
|
description:
|
||||||
- Upload, download, and delete objects in Rackspace Cloud Files
|
- Upload, download, and delete objects in Rackspace Cloud Files
|
||||||
version_added: "1.5"
|
version_added: "1.5"
|
||||||
options:
|
options:
|
||||||
api_key:
|
api_key:
|
||||||
description:
|
description:
|
||||||
<<<<<<< HEAD
|
|
||||||
- Rackspace API key (overrides I(credentials))
|
- Rackspace API key (overrides I(credentials))
|
||||||
default: null
|
default: null
|
||||||
clear_meta:
|
clear_meta:
|
||||||
description:
|
description:
|
||||||
- Optionally clear existing metadata when applying metadata to existing objects.
|
- Optionally clear existing metadata when applying metadata to existing objects.
|
||||||
Selecting this option is only appropriate when setting type=meta
|
Selecting this option is only appropriate when setting type=meta
|
||||||
=======
|
|
||||||
- Rackspace API key (overrides I(credentials))requirements: [ "pyrax" ]
|
|
||||||
clear_meta:
|
|
||||||
description:
|
|
||||||
- Optionally clear existing metadata when applying metadata to existing objects.
|
|
||||||
- Selecting this option is only appropriate when setting typ=meta
|
|
||||||
>>>>>>> parent of b11d622... Revert "Merge pull request #5496 from angstwad/cf-module"
|
|
||||||
choices: ["yes", "no"]
|
choices: ["yes", "no"]
|
||||||
default: "no"
|
default: "no"
|
||||||
container:
|
container:
|
||||||
description:
|
description:
|
||||||
- The container to use for file object operations.
|
- The container to use for file object operations.
|
||||||
required: true
|
required: true
|
||||||
<<<<<<< HEAD
|
|
||||||
default: null
|
default: null
|
||||||
credentials:
|
credentials:
|
||||||
description:
|
description:
|
||||||
- File to find the Rackspace credentials in (ignored if I(api_key) and I(username) are provided)
|
- File to find the Rackspace credentials in (ignored if I(api_key) and I(username) are provided)
|
||||||
=======
|
|
||||||
credentials:
|
|
||||||
description:
|
|
||||||
- File to find the Rackspace credentials in (ignored if I(api_key) and
|
|
||||||
I(username) are provided)
|
|
||||||
>>>>>>> parent of b11d622... Revert "Merge pull request #5496 from angstwad/cf-module"
|
|
||||||
default: null
|
default: null
|
||||||
aliases: ['creds_file']
|
aliases: ['creds_file']
|
||||||
dest:
|
dest:
|
||||||
description:
|
description:
|
||||||
<<<<<<< HEAD
|
|
||||||
- The destination of a "get" operation; i.e. a local directory, "/home/user/myfolder".
|
- The destination of a "get" operation; i.e. a local directory, "/home/user/myfolder".
|
||||||
Used to specify the destination of an operation on a remote object; i.e. a file name,
|
Used to specify the destination of an operation on a remote object; i.e. a file name,
|
||||||
"file1", or a comma-separated list of remote objects, "file1,file2,file17"
|
"file1", or a comma-separated list of remote objects, "file1,file2,file17"
|
||||||
|
@ -85,29 +64,10 @@ options:
|
||||||
- The method of operation to be performed. For example, put to upload files
|
- The method of operation to be performed. For example, put to upload files
|
||||||
to Cloud Files, get to download files from Cloud Files or delete to delete
|
to Cloud Files, get to download files from Cloud Files or delete to delete
|
||||||
remote objects in Cloud Files
|
remote objects in Cloud Files
|
||||||
=======
|
|
||||||
- The destination of a "get" operation; i.e. a local directory, "/home/user/myfolder"
|
|
||||||
- Used to specify the destination of an operation on a remote object; i.e. a file name,
|
|
||||||
"file1", or a comma-separated list of remote objects, "file1,file2,file17"
|
|
||||||
expires:
|
|
||||||
description:
|
|
||||||
- Used to set an expiration on a file or folder uploaded to Cloud Files
|
|
||||||
- Requires an integer, specifying expiration in seconds
|
|
||||||
meta:
|
|
||||||
description:
|
|
||||||
- A hash of items to set as metadata values on an uploaded file or folder
|
|
||||||
method:
|
|
||||||
description:
|
|
||||||
- The method of operation to be performed: put, get, delete
|
|
||||||
- Put to upload files to Cloud Files
|
|
||||||
- Get to download files from Cloud Files
|
|
||||||
- Delete to delete remote objects in Cloud Files
|
|
||||||
>>>>>>> parent of b11d622... Revert "Merge pull request #5496 from angstwad/cf-module"
|
|
||||||
choices: ["get", "put", "delete"]
|
choices: ["get", "put", "delete"]
|
||||||
default: "get"
|
default: "get"
|
||||||
region:
|
region:
|
||||||
description:
|
description:
|
||||||
<<<<<<< HEAD
|
|
||||||
- Region in which to work. Maps to a Rackspace Cloud region, i.e. DFW, ORD, IAD, SYD, LON
|
- Region in which to work. Maps to a Rackspace Cloud region, i.e. DFW, ORD, IAD, SYD, LON
|
||||||
default: DFW
|
default: DFW
|
||||||
src:
|
src:
|
||||||
|
@ -127,31 +87,11 @@ options:
|
||||||
description:
|
description:
|
||||||
- Type of object to do work on
|
- Type of object to do work on
|
||||||
- Metadata object or a file object
|
- Metadata object or a file object
|
||||||
=======
|
|
||||||
- Region to create an instance in
|
|
||||||
default: DFW
|
|
||||||
src:
|
|
||||||
description:
|
|
||||||
- Source from which to upload files
|
|
||||||
- Used to specify a remote object as a source for an operation, i.e. a file name,
|
|
||||||
"file1", or a comma-separated list of remote objects, "file1,file2,file17"
|
|
||||||
- src and dest are mutually exclusive on remote-only object operations
|
|
||||||
structure:
|
|
||||||
description:
|
|
||||||
- Used to specify whether to maintain nested directory structure when downloading objects from Cloud Files
|
|
||||||
- Setting to false downloads the contents of a container to a single, flat directory
|
|
||||||
choices: ["yes", "no"]
|
|
||||||
default: "yes"
|
|
||||||
typ:
|
|
||||||
description:
|
|
||||||
- Type of object to do work on: metadata object or a file object
|
|
||||||
>>>>>>> parent of b11d622... Revert "Merge pull request #5496 from angstwad/cf-module"
|
|
||||||
choices: ["file", "meta"]
|
choices: ["file", "meta"]
|
||||||
default: "file"
|
default: "file"
|
||||||
username:
|
username:
|
||||||
description:
|
description:
|
||||||
- Rackspace username (overrides I(credentials))
|
- Rackspace username (overrides I(credentials))
|
||||||
<<<<<<< HEAD
|
|
||||||
default: null
|
default: null
|
||||||
requirements: [ "pyrax" ]
|
requirements: [ "pyrax" ]
|
||||||
author: Paul Durivage
|
author: Paul Durivage
|
||||||
|
@ -160,21 +100,11 @@ notes:
|
||||||
C(RAX_CREDS_FILE), C(RAX_CREDENTIALS), C(RAX_REGION).
|
C(RAX_CREDS_FILE), C(RAX_CREDENTIALS), C(RAX_REGION).
|
||||||
- C(RAX_CREDENTIALS) and C(RAX_CREDS_FILE) points to a credentials file appropriate
|
- C(RAX_CREDENTIALS) and C(RAX_CREDS_FILE) points to a credentials file appropriate
|
||||||
for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating)
|
for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating)
|
||||||
=======
|
|
||||||
requirements: [ "pyrax" ]
|
|
||||||
author: Paul Durivage
|
|
||||||
notes:
|
|
||||||
- The following environment variables can be used, C(RAX_USERNAME),
|
|
||||||
C(RAX_API_KEY), C(RAX_CREDS_FILE), C(RAX_CREDENTIALS), C(RAX_REGION).
|
|
||||||
- C(RAX_CREDENTIALS) and C(RAX_CREDS_FILE) points to a credentials file
|
|
||||||
appropriate for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating)
|
|
||||||
>>>>>>> parent of b11d622... Revert "Merge pull request #5496 from angstwad/cf-module"
|
|
||||||
- C(RAX_USERNAME) and C(RAX_API_KEY) obviate the use of a credentials file
|
- C(RAX_USERNAME) and C(RAX_API_KEY) obviate the use of a credentials file
|
||||||
- C(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)
|
- C(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
---
|
|
||||||
- name: "Test Cloud Files Objects"
|
- name: "Test Cloud Files Objects"
|
||||||
hosts: local
|
hosts: local
|
||||||
gather_facts: False
|
gather_facts: False
|
||||||
|
@ -238,6 +168,7 @@ EXAMPLES = '''
|
||||||
container: testcont
|
container: testcont
|
||||||
type: meta
|
type: meta
|
||||||
dest: file17
|
dest: file17
|
||||||
|
method: put
|
||||||
meta:
|
meta:
|
||||||
key1: value1
|
key1: value1
|
||||||
key2: value2
|
key2: value2
|
||||||
|
|
Loading…
Reference in a new issue