rax_files – Manipulate Rackspace Cloud Files Containers¶
Requirements¶
The below requirements are needed on the host that executes this module.
- pyrax
- python >= 2.6
Parameters¶
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| api_key 
                    string
                                                                 | Rackspace API key, overrides credentials. aliases: password | |
| auth_endpoint 
                    -
                                                                 | Default: "https://identity.api.rackspacecloud.com/v2.0/" | The URI of the authentication service. | 
| clear_meta 
                    boolean
                                                                 | 
 | Optionally clear existing metadata when applying metadata to existing containers. Selecting this option is only appropriate when setting type=meta | 
| container 
                    -
                                             / required                     | The container to use for container or metadata operations. | |
| credentials 
                    path
                                                                 | File to find the Rackspace credentials in. Ignored if api_key and username are provided. aliases: creds_file | |
| env 
                    string
                                                                 | Environment as configured in ~/.pyrax.cfg, see https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration. | |
| identity_type 
                    -
                                                                 | Default: "rackspace" | Authentication mechanism to use, such as rackspace or keystone. | 
| meta 
                    -
                                                                 | A hash of items to set as metadata values on a container | |
| private 
                    boolean
                                                                 | 
 | Used to set a container as private, removing it from the CDN.  Warning! Private containers, if previously made public, can have live objects available until the TTL on cached objects expires | 
| public 
                    boolean
                                                                 | 
 | Used to set a container as public, available via the Cloud Files CDN | 
| region 
                    string
                                                                 | Default: "DFW" | Region to create an instance in | 
| state 
                    -
                                                                 | 
 | Indicate desired state of the resource | 
| tenant_id 
                    -
                                                                 | The tenant ID used for authentication. | |
| tenant_name 
                    -
                                                                 | The tenant name used for authentication. | |
| ttl 
                    -
                                                                 | In seconds, set a container-wide TTL for all objects cached on CDN edge nodes. Setting a TTL is only appropriate for containers that are public | |
| type 
                    -
                                                                 | 
 | Type of object to do work on, i.e. metadata object or a container object | 
| username 
                    string
                                                                 | Rackspace username, overrides credentials. | |
| validate_certs 
                    boolean
                                                                 | 
 | Whether or not to require SSL validation of API endpoints. aliases: verify_ssl | 
| web_error 
                    -
                                                                 | Sets an object to be presented as the HTTP error page when accessed by the CDN URL | |
| web_index 
                    -
                                                                 | Sets an object to be presented as the HTTP index page when accessed by the CDN URL | 
Notes¶
Note
- The following environment variables can be used, RAX_USERNAME,RAX_API_KEY,RAX_CREDS_FILE,RAX_CREDENTIALS,RAX_REGION.
- RAX_CREDENTIALSand- RAX_CREDS_FILEpoints to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating
- RAX_USERNAMEand- RAX_API_KEYobviate the use of a credentials file
- RAX_REGIONdefines a Rackspace Public Cloud region (DFW, ORD, LON, ...)
- The following environment variables can be used, RAX_USERNAME,RAX_API_KEY,RAX_CREDS_FILE,RAX_CREDENTIALS,RAX_REGION.
- RAX_CREDENTIALSand- RAX_CREDS_FILEpoints to a credentials file appropriate for pyrax. See https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating
- RAX_USERNAMEand- RAX_API_KEYobviate the use of a credentials file
- RAX_REGIONdefines a Rackspace Public Cloud region (DFW, ORD, LON, ...)
Examples¶
- name: "Test Cloud Files Containers"
  hosts: local
  gather_facts: no
  tasks:
    - name: "List all containers"
      rax_files:
        state: list
    - name: "Create container called 'mycontainer'"
      rax_files:
        container: mycontainer
    - name: "Create container 'mycontainer2' with metadata"
      rax_files:
        container: mycontainer2
        meta:
          key: value
          file_for: someuser@example.com
    - name: "Set a container's web index page"
      rax_files:
        container: mycontainer
        web_index: index.html
    - name: "Set a container's web error page"
      rax_files:
        container: mycontainer
        web_error: error.html
    - name: "Make container public"
      rax_files:
        container: mycontainer
        public: yes
    - name: "Make container public with a 24 hour TTL"
      rax_files:
        container: mycontainer
        public: yes
        ttl: 86400
    - name: "Make container private"
      rax_files:
        container: mycontainer
        private: yes
- name: "Test Cloud Files Containers Metadata Storage"
  hosts: local
  gather_facts: no
  tasks:
    - name: "Get mycontainer2 metadata"
      rax_files:
        container: mycontainer2
        type: meta
    - name: "Set mycontainer2 metadata"
      rax_files:
        container: mycontainer2
        type: meta
        meta:
          uploaded_by: someuser@example.com
    - name: "Remove mycontainer2 metadata"
      rax_files:
        container: "mycontainer2"
        type: meta
        state: absent
        meta:
          key: ""
          file_for: ""
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Paul Durivage (@angstwad)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
