terraform-provider-oci

README

NOTICE

OCI Terraform Provider v2.2.0 and above is not compatible with Terraform binaries below v0.10.1. To use the latest OCI Provider, upgrade your version of Terraform to v0.10.1 or higher.

#     ___  ____     _    ____ _     _____
#    / _ \|  _ \   / \  / ___| |   | ____|
#   | | | | |_) | / _ \| |   | |   |  _|
#   | |_| |  _ < / ___ | |___| |___| |___
#    \___/|_| \_/_/   \_\____|_____|_____|

---

Terraform Provider for Oracle Cloud Infrastructure

OCI Terraform Provider gives Oracle customers access to an enterprise class, developer friendly orchestration tool they can use to manage Oracle Cloud Infrastructure. This Terraform provider is open-source software, available to all OCI customers at no charge.

Compatibility

The OCI Terraform Provider is compatible with Terraform v0.10.1 or greater.

Coverage

The OCI Terraform Provider supports the entire OCI API, with a few minor exceptions.

Getting started

To see supported OCI resources and view documentation go to the OCI resource and datasource documentation Table of Contents.

Be sure to read the FAQ and Writing Terraform configurations for OCI document in the docs section.

Installation

On Oracle Linux 7.x

$ sudo yum install -y terraform terraform-provider-oci

Other platforms

Download Terraform

Download the appropriate v0.11.x binary for your platform.
https://www.terraform.io/downloads.html

Install Terraform

https://www.terraform.io/intro/getting-started/install.html

Get the Oracle Cloud Infrastructure Terraform provider

https://github.com/oracle/terraform-provider-oci/releases

For MacOS download the correct darwin_*.tar.gz build for your processor architecture. For Windows this will be a zip windows_*.zip. For other supported linux version find the corresponding file.

On Mac or other Linux flavors

Copy the provider to the following location:

~/.terraform.d/plugins/

On Windows

Copy the provider to the following location:

%APPDATA%/terraform.d/plugins/

Note: %APPDATA% is a system path specific to your Windows version.

Setup credentials for using OCI

Calls to OCI using API key authentication requires that you provide credentials. The following list shows required credentials, as well as common configuration values:

• tenancy_ocid - The global identifier for your account, always shown on the bottom of the web console.
• user_ocid - The identifier of the user account you will be using for Terraform. For information on setting the correct policies for your user see Managing Users.
• private_key_path - The path to the private key stored on your computer. The public key portion must be added to the user account above in the API Keys section of the web console. For details on how to create and configure keys see Required Keys and OCIDs.
• fingerprint - The fingerprint of the public key added in the above user's API Keys section of the web console.
• region - The region to target with this provider configuration.

Environment variables

It is common to export the above values as environment variables, or source them in different bash profiles when executing Terraform commands. Below are OS specific examples for configuring these environment values.

If you primarily work in a single compartment, consider exporting the compartment OCID as well. Remember that the tenancy OCID is also the OCID of the root compartment, and can be used where any compartment id is required.

*nix

If your Terraform configurations are limited to a single compartment or user, then using this bash_profile option be sufficient. For more complex environments, you may want to maintain multiple sets of environment variables. See the compute single instance example for more info.

In your ~/.bash_profile set these variables

export TF_VAR_tenancy_ocid=<value>
export TF_VAR_compartment_ocid=<value>
export TF_VAR_user_ocid=<value>
export TF_VAR_fingerprint=<value>
export TF_VAR_private_key_path=<value>

Once you've set these values, open a new terminal or source your profile changes:

$ source ~/.bash_profile

Windows

Configuring for Windows usage is largely the same, with one notable exception: you can use PuttyGen to create the public and private key as shown above, however, you will need to convert them from PPK format to PEM format.

setx TF_VAR_tenancy_ocid <value>
setx TF_VAR_compartment_ocid <value>
setx TF_VAR_user_ocid <value>
setx TF_VAR_fingerprint <value>
setx TF_VAR_private_key_path <value>

The variables won't be set for the current session, exit the terminal and reopen.

Deploy an example configuration

Download the virtual cloud network example.

# Change to the directory of an example like: 
$ cd docs/examples/networking/vcn

# Initialize the plugin for this template directory
$ terraform init

# Run the plan command to see what will happen
$ terraform plan
  
# If the plan looks right, apply it
$ terraform apply

# If you are done with this infrastructure, take it down
$ terraform destroy

Getting help

If you are having trouble getting the OCI Provider working, check the troubleshooting doc.

To see known issues or report unexpected behavior go to the Github issues page.

For questions or information visit the OCI forums.