github.com/hugorut/terraform@v1.1.3/website/docs/language/settings/backends/swift.mdx (about)

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