opentf/website/source/docs/providers/openstack/index.html.markdown

layout, page_title, sidebar_current, description

layout	page_title	sidebar_current	description
openstack	Provider: OpenStack	docs-openstack-index	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.

OpenStack Provider

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.

Use the navigation to the left to read about the available resources.

Example Usage

# Configure the OpenStack Provider
provider "openstack" {
    user_name  = "admin"
    tenant_name = "admin"
    password  = "pwd"
    auth_url  = "http://myauthurl:5000/v2.0"
}

# Create a web server
resource "openstack_compute_instance_v2" "test-server" {
    ...
}

Configuration Reference

The following arguments are supported:

• auth_url - (Required) If omitted, the OS_AUTH_URL environment variable is used.

• user_name - (Optional; Required for Identity V2) If omitted, the OS_USERNAME environment variable is used.

• user_id - (Optional)

• password - (Optional; Required if not using api_key) If omitted, the OS_PASSWORD environment variable is used.

• api_key - (Optional; Required if not using password)

• domain_id - (Optional)

• domain_name - (Optional)

• tenant_id - (Optional)

• tenant_name - (Optional) If omitted, the OS_TENANT_NAME environment variable is used.

• insecure - (Optional) Explicitly allow the provider to perform "insecure" SSL requests. If omitted, default value is false

• endpoint_type - (Optional) Specify which type of endpoint to use from the service catalog. It can be set using the OS_ENDPOINT_TYPE environment variable. If not set, public endpoints is used.

Testing and Development

In order to run the Acceptance Tests for development, the following environment variables must also be set:

• OS_REGION_NAME - The region in which to create the server instance.

• OS_IMAGE_ID or OS_IMAGE_NAME - a UUID or name of an existing image in Glance.

• OS_FLAVOR_ID or OS_FLAVOR_NAME - an ID or name of an existing flavor.

• OS_POOL_NAME - The name of a Floating IP pool.

• OS_NETWORK_ID - The UUID of a network in your test environment.

To make development easier, the builtin/providers/openstack/devstack/deploy.sh script will assist in installing and configuring a standardized DevStack environment along with Golang, Terraform, and all development dependencies. It will also set the required environment variables in the devstack/openrc file.

Do not run the deploy.sh script on your workstation or any type of production server. Instead, run the script within a disposable virtual machine. Here's an example of a Terraform configuration that will create an OpenStack instance and then install and configure DevStack inside.