github.com/ves/terraform@v0.8.0-beta2/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) The Identity authentication URL. If omitted, the
    39    `OS_AUTH_URL` environment variable is used.
    40  
    41  * `user_name` - (Optional) The Username to login with. If omitted, the
    42    `OS_USERNAME` environment variable is used.
    43  
    44  * `user_id` - (Optional) The User ID to login with. If omitted, the
    45    `OS_USER_ID` environment variable is used.
    46  
    47  * `tenant_id` - (Optional) The ID of the Tenant (Identity v2) or Project
    48    (Identity v3) to login with. If omitted, the `OS_TENANT_ID` or
    49    `OS_PROJECT_ID` environment variables are used.
    50  
    51  * `tenant_name` - (Optional) The Name of the Tenant (Identity v2) or Project
    52    (Identity v3) to login with. If omitted, the `OS_TENANT_NAME` or
    53    `OS_PROJECT_NAME` environment variable are used.
    54  
    55  * `password` - (Optional) The Password to login with. If omitted, the
    56    `OS_PASSWORD` environment variable is used.
    57  
    58  * `token` - (Optional; Required if not using `user_name` and `password`)
    59    A token is an expiring, temporary means of access issued via the Keystone
    60    service. By specifying a token, you do not have to specify a username/password
    61    combination, since the token was already created by a username/password out of
    62    band of Terraform. If omitted, the `OS_AUTH_TOKEN` environment variable is used.
    63  
    64  * `domain_id` - (Optional) The ID of the Domain to scope to (Identity v3). If
    65    If omitted, the following environment variables are checked (in this order):
    66    `OS_USER_DOMAIN_ID`, `OS_PROJECT_DOMAIN_ID`, `OS_DOMAIN_ID`.
    67  
    68  * `domain_name` - (Optional) The Name of the Domain to scope to (Identity v3).
    69    If omitted, the following environment variables are checked (in this order):
    70    `OS_USER_DOMAIN_NAME`, `OS_PROJECT_DOMAIN_NAME`, `OS_DOMAIN_NAME`,
    71    `DEFAULT_DOMAIN`.
    72  
    73  * `insecure` - (Optional) Trust self-signed SSL certificates. If omitted, the
    74    `OS_INSECURE` environment variable is used.
    75  
    76  * `cacert_file` - (Optional) Specify a custom CA certificate when communicating
    77    over SSL. If omitted, the `OS_CACERT` environment variable is used.
    78  
    79  * `cert` - (Optional) Specify client certificate file for SSL client
    80    authentication. If omitted the `OS_CERT` environment variable is used.
    81  
    82  * `key` - (Optional) Specify client private key file for SSL client
    83    authentication. If omitted the `OS_KEY` environment variable is used.
    84  
    85  * `endpoint_type` - (Optional) Specify which type of endpoint to use from the
    86    service catalog. It can be set using the OS_ENDPOINT_TYPE environment
    87    variable. If not set, public endpoints is used.
    88  
    89  ## Rackspace Compatibility
    90  
    91  Using this OpenStack provider with Rackspace is not supported and not
    92  guaranteed to work; however, users have reported success with the
    93  following notes in mind:
    94  
    95  * Interacting with instances has been seen to work. Interacting with
    96  all other resources is either untested or known to not work.
    97  
    98  * Use your _password_ instead of your Rackspace API KEY.
    99  
   100  * Explicitly define the public and private networks in your
   101  instances as shown below:
   102  
   103  ```
   104  resource "openstack_compute_instance_v2" "my_instance" {
   105    name = "my_instance"
   106    region = "DFW"
   107    image_id = "fabe045f-43f8-4991-9e6c-5cabd617538c"
   108    flavor_id = "general1-4"
   109    key_pair = "provisioning_key"
   110  
   111    network {
   112      uuid = "00000000-0000-0000-0000-000000000000"
   113      name = "public"
   114    }
   115  
   116    network {
   117      uuid = "11111111-1111-1111-1111-111111111111"
   118      name = "private"
   119    }
   120  }
   121  ```
   122  
   123  If you try using this provider with Rackspace and run into bugs, you
   124  are welcomed to open a bug report / issue on Github, but please keep
   125  in mind that this is unsupported and the reported bug may not be
   126  able to be fixed.
   127  
   128  If you have successfully used this provider with Rackspace and can
   129  add any additional comments, please let us know.
   130  
   131  ## Testing and Development
   132  
   133  In order to run the Acceptance Tests for development, the following environment
   134  variables must also be set:
   135  
   136  * `OS_REGION_NAME` - The region in which to create the server instance.
   137  
   138  * `OS_IMAGE_ID` or `OS_IMAGE_NAME` - a UUID or name of an existing image in
   139      Glance.
   140  
   141  * `OS_FLAVOR_ID` or `OS_FLAVOR_NAME` - an ID or name of an existing flavor.
   142  
   143  * `OS_POOL_NAME` - The name of a Floating IP pool.
   144  
   145  * `OS_NETWORK_ID` - The UUID of a network in your test environment.
   146  
   147  * `OS_EXTGW_ID` - The UUID of the external gateway.
   148  
   149  To make development easier, the `builtin/providers/openstack/devstack/deploy.sh`
   150  script will assist in installing and configuring a standardized
   151  [DevStack](http://docs.openstack.org/developer/devstack/) environment along with
   152  Golang, Terraform, and all development dependencies. It will also set the required
   153  environment variables in the `devstack/openrc` file.
   154  
   155  Do not run the `deploy.sh` script on your workstation or any type of production
   156  server. Instead, run the script within a disposable virtual machine.
   157  [Here's](https://github.com/berendt/terraform-configurations) an example of a
   158  Terraform configuration that will create an OpenStack instance and then install and
   159  configure DevStack inside.