README.md

NOTICE

The OCI Terraform Provider is now available for automatic download through the Terraform Provider Registry. For more information on how to get started view the documentation and setup guide.

Terraform Provider for Oracle Cloud Infrastructure

• Documentation
• OCI forums
• Github issues
• Troubleshooting

Requirements

• Terraform v0.10.1 or greater
• Go 1.11.4 (recommended)

Note: You may use any version 1.8 or above to build the provider. However, the goimports, go vet, and gofmt code checks will only pass when using version 1.11.

Building the Provider

Clone repository to: $GOPATH/src/github.com/terraform-providers/terraform-provider-oci

$ mkdir -p $GOPATH/src/github.com/terraform-providers; cd $GOPATH/src/github.com/terraform-providers
$ git clone [email protected]:terraform-providers/terraform-provider-oci

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-oci
$ make build

Using the Provider

If you're building the provider, follow the instructions to install it as a plugin. After placing it into your plugins directory, run terraform init to initialize it and begin using Terraform with the Oracle Cloud Infrastructure provider.

Troubleshooting the Provider

To get verbose console output when the provider is running, precede your Terraform command with the TF_LOG and OCI_GO_SDK_DEBUG flags:

TF_LOG=DEBUG OCI_GO_SDK_DEBUG=1 terraform plan

The tf_log level and OCI_GO_SDK_DEBUG flags can also be set as environment variables.

Developing the Provider

To add features to the provider, install Go and configure your your GOPATH

Compile the provider by running make build. The provider binary will output to your $GOPATH/bin directory, make sure this has been added to your $PATH.

$ make build

To test the provider run make testacc.

$ make testacc

Note: The tests run against live OCI service APIs, you will need to configure environment variables with valid credientials as shown in the documentation.