pulumi / pulumi-oci

An Oracle Cloud (OCI) Pulumi resource package, providing multi-language access to OCI
Other
28 stars 2 forks source link

Docs: update OCI environment variables #638

Open semiautomatix opened 2 years ago

semiautomatix commented 2 years ago

What happened?

Documentation for the The Oracle Cloud Infrastructure Configuring Credentials is incorrect.

TF_VAR_private_key_file should be updated to TF_VAR_privatekeypath

Under environment variables it should read:

export TF_VAR_tenancy_ocid="ocid1.tenancy.oc1..<unique_ID>"
export TF_VAR_user_ocid="ocid1.user.oc1..<unique_ID>"
export TF_VAR_fingerprint="<key_fingerprint>"
export TF_VAR_region="us-ashburn-1"
export TF_VAR_private_key_path="/path/to/oci_api_key.pem"

Steps to reproduce

https://github.com/pulumi/registry/blob/283f5195c90de50e524266cc1de8b39d93a0a2a8/themes/default/content/registry/packages/oci/installation-configuration.md#configuring-credentials

Expected Behavior

pulumi up should work if using the above instructions

Actual Behavior

pulumi up reports the following error, if using the above instructions

    error: 1 error occurred:
        * can not create client, bad configuration: did not find a proper configuration for private key

Versions used

No response

Additional context

No response

Contributing

Vote on this issue by adding a 👍 reaction. To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).

susanev commented 2 years ago

thx for the report @semiautomatix! we sould gladly accept your pr to fix this if ya have the time.

semiautomatix commented 2 years ago

thx for the report @semiautomatix! we sould gladly accept your pr to fix this if ya have the time.

Sure thing, I wasn't sure if you were keen on community submissions.