github.com/muratcelep/terraform@v1.1.0-beta2-not-internal-4/website/docs/language/settings/backends/swift.html.md (about)

     1  ---
     2  layout: "language"
     3  page_title: "Backend Type: swift"
     4  sidebar_current: "docs-backends-types-standard-swift"
     5  description: |-
     6    Terraform can store state remotely in Swift.
     7  ---
     8  
     9  # swift
    10  
    11  **Kind: Standard (with locking)**
    12  
    13  Stores the state as an artifact in [Swift](http://docs.openstack.org/developer/swift/latest/).
    14  
    15  ~> Warning! It is highly recommended that you enable [Object Versioning](https://docs.openstack.org/developer/swift/latest/overview_object_versioning.html) by setting the [`archive_container`](https://www.terraform.io/docs/language/settings/backends/swift.html#archive_container) configuration. This allows for state recovery in the case of accidental deletions and human error.
    16  
    17  ## Example Configuration
    18  
    19  ```hcl
    20  terraform {
    21    backend "swift" {
    22      container         = "terraform-state"
    23      archive_container = "terraform-state-archive"
    24    }
    25  }
    26  ```
    27  This will create a container called `terraform-state` and an object within that container called `tfstate.tf`. It will enable versioning using the `terraform-state-archive` container to contain the older version.
    28  
    29  For the access credentials we recommend using a
    30  [partial configuration](/docs/language/settings/backends/configuration.html#partial-configuration).
    31  
    32  ## Data Source Configuration
    33  
    34  ```hcl
    35  data "terraform_remote_state" "foo" {
    36    backend = "swift"
    37    config = {
    38      container         = "terraform_state"
    39      archive_container = "terraform_state-archive"
    40    }
    41  }
    42  ```
    43  
    44  ## Configuration variables
    45  
    46  The following configuration options are supported:
    47  
    48  * `auth_url` - (Optional) The Identity authentication URL. If omitted, the
    49     `OS_AUTH_URL` environment variable is used.
    50  
    51  * `cloud` - (Optional; required if `auth_url` is not specified) An entry in a
    52    `clouds.yaml` file. See the OpenStack `os-client-config`
    53    [documentation](https://docs.openstack.org/os-client-config/latest/user/configuration.html)
    54    for more information about `clouds.yaml` files. If omitted, the `OS_CLOUD`
    55    environment variable is used.
    56  
    57  * `region_name` - (Optional) - The region in which to store `terraform.tfstate`. If
    58     omitted, the `OS_REGION_NAME` environment variable is used.
    59  
    60  * `container` - (Required) The name of the container to create for storing
    61    the Terraform state file.
    62  
    63  * `state_name` - (Optional) The name of the state file in the container.
    64    Defaults to `tfstate.tf`.
    65  
    66  * `path` - (Optional) DEPRECATED: Use `container` instead.
    67    The name of the container to create in order to store the state file.
    68  
    69  * `user_name` - (Optional) The Username to login with. If omitted, the
    70    `OS_USERNAME` environment variable is used.
    71  
    72  * `user_id` - (Optional) The User ID to login with. If omitted, the
    73    `OS_USER_ID` environment variable is used.
    74  
    75  * `application_credential_id` - (Optional) (Identity v3 only) The ID of an
    76    application credential to authenticate with. An
    77    `application_credential_secret` has to bet set along with this parameter.
    78  
    79  * `application_credential_name` - (Optional) (Identity v3 only) The name of an
    80    application credential to authenticate with. Requires `user_id`, or
    81    `user_name` and `user_domain_name` (or `user_domain_id`) to be set.
    82  
    83  * `application_credential_secret` - (Optional) (Identity v3 only) The secret of an
    84    application credential to authenticate with. Required by
    85    `application_credential_id` or `application_credential_name`.
    86  
    87  * `tenant_id` - (Optional) The ID of the Tenant (Identity v2) or Project
    88    (Identity v3) to login with. If omitted, the `OS_TENANT_ID` or
    89    `OS_PROJECT_ID` environment variables are used.
    90  
    91  * `tenant_name` - (Optional) The Name of the Tenant (Identity v2) or Project
    92    (Identity v3) to login with. If omitted, the `OS_TENANT_NAME` or
    93    `OS_PROJECT_NAME` environment variable are used.
    94  
    95  * `password` - (Optional) The Password to login with. If omitted, the
    96    `OS_PASSWORD` environment variable is used.
    97  
    98  * `token` - (Optional; Required if not using `user_name` and `password`)
    99    A token is an expiring, temporary means of access issued via the Keystone
   100    service. By specifying a token, you do not have to specify a username/password
   101    combination, since the token was already created by a username/password out of
   102    band of Terraform. If omitted, the `OS_TOKEN` or `OS_AUTH_TOKEN` environment
   103    variables are used.
   104  
   105  * `user_domain_name` - (Optional) The domain name where the user is located. If
   106    omitted, the `OS_USER_DOMAIN_NAME` environment variable is checked.
   107  
   108  * `user_domain_id` - (Optional) The domain ID where the user is located. If
   109    omitted, the `OS_USER_DOMAIN_ID` environment variable is checked.
   110  
   111  * `project_domain_name` - (Optional) The domain name where the project is
   112    located. If omitted, the `OS_PROJECT_DOMAIN_NAME` environment variable is
   113    checked.
   114  
   115  * `project_domain_id` - (Optional) The domain ID where the project is located
   116    If omitted, the `OS_PROJECT_DOMAIN_ID` environment variable is checked.
   117  
   118  * `domain_id` - (Optional) The ID of the Domain to scope to (Identity v3). If
   119    omitted, the following environment variables are checked (in this order):
   120    `OS_USER_DOMAIN_ID`, `OS_PROJECT_DOMAIN_ID`, `OS_DOMAIN_ID`.
   121  
   122  * `domain_name` - (Optional) The Name of the Domain to scope to (Identity v3).
   123    If omitted, the following environment variables are checked (in this order):
   124    `OS_USER_DOMAIN_NAME`, `OS_PROJECT_DOMAIN_NAME`, `OS_DOMAIN_NAME`,
   125    `DEFAULT_DOMAIN`.
   126  
   127  * `default_domain` - (Optional) The ID of the Domain to scope to if no other
   128    domain is specified (Identity v3). If omitted, the environment variable
   129    `OS_DEFAULT_DOMAIN` is checked or a default value of "default" will be
   130    used.
   131  
   132  * `insecure` - (Optional) Trust self-signed SSL certificates. If omitted, the
   133    `OS_INSECURE` environment variable is used.
   134  
   135  * `cacert_file` - (Optional) Specify a custom CA certificate when communicating
   136    over SSL. You can specify either a path to the file or the contents of the
   137    certificate. If omitted, the `OS_CACERT` environment variable is used.
   138  
   139  * `cert` - (Optional) Specify client certificate file for SSL client authentication.
   140     If omitted the `OS_CERT` environment variable is used.
   141  
   142  * `key` - (Optional) Specify client private key file for SSL client authentication.
   143     If omitted the `OS_KEY` environment variable is used.
   144  
   145  * `endpoint_type` - (Optional) Specify which type of endpoint to use from the
   146    service catalog. It can be set using the OS_ENDPOINT_TYPE environment
   147    variable. If not set, public endpoints is used.
   148  
   149  * `swauth` - (Optional) Set to `true` to authenticate against Swauth, a
   150    Swift-native authentication system. If omitted, the `OS_SWAUTH` environment
   151    variable is used. You must also set `username` to the Swauth/Swift username
   152    such as `username:project`. Set the `password` to the Swauth/Swift key. This feature supports v1.0 of the Swauth system.
   153    Finally, set `auth_url` as the location of the Swift service.
   154  
   155  * `disable_no_cache_header` - (Optional) If set to `true`, the HTTP
   156    `Cache-Control: no-cache` header will not be added by default to all API requests.
   157    If omitted this header is added to all API requests to force HTTP caches (if any)
   158    to go upstream instead of serving cached responses.
   159  
   160  * `allow_reauth` - (Optional) If set to `true`, OpenStack authorization will be
   161    perfomed automatically, if the initial auth token get expired. This is useful,
   162    when the token TTL is low or the overall Terraform provider execution time
   163    expected to be greater than the initial token TTL.
   164  
   165  * `archive_container` - (Optional) The container to create to store archived copies
   166    of the Terraform state file. If specified, Swift [object versioning](https://docs.openstack.org/developer/swift/latest/overview_object_versioning.html) is enabled on the container created at `container`.
   167  
   168  * `archive_path` - (Optional) DEPRECATED: Use `archive_container` instead.
   169    The path to store archived copied of `terraform.tfstate`. If specified,
   170    Swift [object versioning](https://docs.openstack.org/developer/swift/latest/overview_object_versioning.html) is enabled on the container created at `path`.
   171  
   172  * `expire_after` - (Optional) How long should the `terraform.tfstate` created at `container`
   173    be retained for? If specified, Swift [expiring object support](https://docs.openstack.org/developer/swift/latest/overview_expiring_objects.html) is enabled on the state. Supported durations: `m` - Minutes, `h` - Hours, `d` - Days.
   174    ~> **NOTE:** Since Terraform is inherently stateful - we'd strongly recommend against auto-expiring Statefiles.