Use OCI_ prefixed environment variables (like OCI_CLI_, not TF_VAR_)

[MPV]

I'm referring to this implementation:

oci-go-sdk/common/client.go

Line 283 in 977324a

environmentProvider := environmentConfigurationProvider{EnvironmentVariablePrefix: "TF_VAR"}

And comparing with the naming convention of the environment variables of oci-cli:
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/clienvironmentvariables.htm#CLI_Environment_Variables

...and how other Terraform providers are able to pick up "usual" CLI environment variables:
https://registry.terraform.io/providers/hashicorp/aws/latest/docs#environment-variables
https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/provider_reference#full-reference

[MPV]

Somewhat unsure as to whether if it would be preferred to have this issue/change in this SDK repo, or in the TF provider, but it seems like the implementation originated from this repo, hence why I created it here.

[pelliu]

@MPV, thank you for letting us know your question, it seems like the terraform provider related questions, even environmentProvider := environmentConfigurationProvider{EnvironmentVariablePrefix: "TF_VAR"} was contributed by TF team. I'd asked TF team to take a look, they will reply here, or you can also ask https://github.com/terraform-providers/terraform-provider-oci.

[pelliu]

@varmax2511, @rashik-bhasin, and @govindrao55, could you please take a look?

[tkellen]

💯 this is bizarre unexpected behavior that makes interaction with terraform highly confusing.

[ddevadat]

is there any workaround for this. I am not able to use environment variables

[tkellen]

Out of pure curiosity, how is that possible? Environment variables are 50+ year old technology.

[ddevadat]

even if we are using TF_VAR prefix, what should be the environment name variables that needs to be set. I tried with the below it didnt work

export TF_VAR_tenancy_ocid="..."
export TF_VAR_compartment_ocid="..."
export TF_VAR_user_ocid="..."
export TF_VAR_fingerprint="..."
export TF_VAR_private_key="..."

i am fairly new to using go sdk for oci

[ddevadat]

i am doing like this for setting the provider. This way i dont need TF_VAR prefix

p1 := common.NewRawConfigurationProvider(
	os.Getenv("OCI_TENANCY"),
	os.Getenv("OCI_USER"),
	os.Getenv("OCI_REGION"),
	os.Getenv("OCI_FINGERPRINT"),
	os.Getenv("OCI_KEY_FILE"),
    common.String((os.Getenv("OCI_KEY_PASSPHRASE"))))

[b-dean]

I've created a package with a provider that can read the OCI_CLI environment variables: https://github.com/ontariosystems/oci-cli-env-provider

import "github.com/ontariosystems/oci-cli-env-provider"

func Example() {
	p := ocep.DefaultConfigProvider()
	// ...
}

the default provider includes the default providers from the sdk. This might help until there's some sort of standard environment variables for all the OCI SDKs.

I also like to include an auth.InstancePrincipalConfigurationProvider so I can run on compute instances without having to set up the ~/.oci/config. Something like this:

import "github.com/ontariosystems/oci-cli-env-provider"

func configurationProvider() (common.ConfigurationProvider, error) {
	var providers []common.ConfigurationProvider

	providers = append(providers, ocep.DefaultConfigProvider())
	ip, err := auth.InstancePrincipalConfigurationProvider()
	if err != nil {
		return nil, err
	}
	providers = append(providers, ip)

	return common.ComposingConfigurationProvider(providers)
}

Since the common.ComposingConfigurationProvider only uses the first provider for AuthType(), it's important to make sure the environment variable one is first. Otherwise you can't do things like set OCI_CLI_AUTH to api_key or security_token and the sdk will keep demanding you have to configure ~/.oci/config (which you don't).