github.com/leeprovoost/terraform@v0.6.10-0.20160119085442-96f3f76118e7/website/source/docs/providers/openstack/index.html.markdown (about)

     1  ---
     2  layout: "openstack"
     3  page_title: "Provider: OpenStack"
     4  sidebar_current: "docs-openstack-index"
     5  description: |-
     6    The OpenStack provider is used to interact with the many resources supported by OpenStack. The provider needs to be configured with the proper credentials before it can be used.
     7  ---
     8  
     9  # OpenStack Provider
    10  
    11  The OpenStack provider is used to interact with the
    12  many resources supported by OpenStack. The provider needs to be configured
    13  with the proper credentials before it can be used.
    14  
    15  Use the navigation to the left to read about the available resources.
    16  
    17  ## Example Usage
    18  
    19  ```
    20  # Configure the OpenStack Provider
    21  provider "openstack" {
    22      user_name  = "admin"
    23      tenant_name = "admin"
    24      password  = "pwd"
    25      auth_url  = "http://myauthurl:5000/v2.0"
    26  }
    27  
    28  # Create a web server
    29  resource "openstack_compute_instance_v2" "test-server" {
    30      ...
    31  }
    32  ```
    33  
    34  ## Configuration Reference
    35  
    36  The following arguments are supported:
    37  
    38  * `auth_url` - (Required) If omitted, the `OS_AUTH_URL` environment
    39      variable is used.
    40  
    41  * `user_name` - (Optional; Required for Identity V2) If omitted, the
    42      `OS_USERNAME` environment variable is used.
    43  
    44  * `user_id` - (Optional)
    45  
    46  * `password` - (Optional; Required if not using `api_key`) If omitted, the
    47      `OS_PASSWORD` environment variable is used.
    48  
    49  * `api_key` - (Optional; Required if not using `password`)
    50  
    51  * `domain_id` - (Optional)
    52  
    53  * `domain_name` - (Optional)
    54  
    55  * `tenant_id` - (Optional)
    56  
    57  * `tenant_name` - (Optional) If omitted, the `OS_TENANT_NAME` environment
    58      variable is used.
    59  
    60  * `insecure` - (Optional) Explicitly allow the provider to perform
    61      "insecure" SSL requests. If omitted, default value is `false`
    62  
    63  * `endpoint_type` - (Optional) Specify which type of endpoint to use from the
    64      service catalog. It can be set using the OS_ENDPOINT_TYPE environment
    65      variable. If not set, public endpoints is used.
    66  
    67  ## Testing and Development
    68  
    69  In order to run the Acceptance Tests for development, the following environment
    70  variables must also be set:
    71  
    72  * `OS_REGION_NAME` - The region in which to create the server instance.
    73  
    74  * `OS_IMAGE_ID` or `OS_IMAGE_NAME` - a UUID or name of an existing image in
    75      Glance.
    76  
    77  * `OS_FLAVOR_ID` or `OS_FLAVOR_NAME` - an ID or name of an existing flavor.
    78  
    79  * `OS_POOL_NAME` - The name of a Floating IP pool.
    80  
    81  * `OS_NETWORK_ID` - The UUID of a network in your test environment.
    82  
    83  To make development easier, the `builtin/providers/openstack/devstack/deploy.sh`
    84  script will assist in installing and configuring a standardized
    85  [DevStack](http://docs.openstack.org/developer/devstack/) environment along with
    86  Golang, Terraform, and all development dependencies. It will also set the required
    87  environment variables in the `devstack/openrc` file.
    88  
    89  Do not run the `deploy.sh` script on your workstation or any type of production
    90  server. Instead, run the script within a disposable virtual machine.
    91  [Here's](https://github.com/berendt/terraform-configurations) an example of a
    92  Terraform configuration that will create an OpenStack instance and then install and
    93  configure DevStack inside.