Support and document OCI_REGION parameter for config-based providers #209
Conversation
oracle-contributor-agreement
bot
added
the
OCA Verified
ojdbc-provider-oci/README.md
Outdated
| <td><code>OCI_REGION</code></td> | ||
| <td> | ||
| Specifies the OCI Region Identifier to be used for requests and interactive authentication. | ||
| This is especially important in government or non-OC1 regions to ensure authentication is routed correctly.<br> |
There was a problem hiding this comment.
This is important to allow using a region that's different than the one of the user's region. Right? If that's true, I think we can remove the 'government' comment.
There was a problem hiding this comment.
Thanks! Updated the description to cover all regions, not just gov.
| @@ -92,6 +93,7 @@ private OciConfigurationParameters(){} | |||
| .addParameter("OCI_FINGERPRINT", FINGERPRINT) | |||
| .addParameter("OCI_KEY_FILE", PRIVATE_KEY) | |||
| .addParameter("OCI_PASS_PHRASE", PASS_PHRASE) | |||
| .addParameter("OCI_REGION", REGION, null, Region::fromRegionCodeOrId) | |||
There was a problem hiding this comment.
Is this change only for the configuration provider? How about the other providers? For example: the token provider.
There was a problem hiding this comment.
Yes, this change is only for the configuration providers. For resource providers, the region parameter is already supported and documented in their section of the README.
There was a problem hiding this comment.
Thank you for this fix! The changes all appear correct to me.
Please wait for @ting-lan-wang to weigh in on this, b/c they know a lot more config providers and region settings than I do :)
|
For config-based providers, we previously configured OCI_REGION via environment variables, using the OCI_DEFAULT authentication method, or by setting in $HOME/.oci/config. The changes address the issue and look good on my end. Thanks! |
For config-based providers (e.g., config-ociobject, config-ocivault), the OCI_REGION parameter was not previously supported or documented. This caused issues with interactive authentication in government or non-OC1 regions, where requests were incorrectly routed to
https://login.oci.oraclecloud.cominstead of the correct region-specific login endpoint.This PR adds support for the OCI_REGION parameter in centralized config providers and updates the README to document it as a common optional parameter. The documentation now clarifies that
OCI_REGIONshould be explicitly set when usingOCI_INTERACTIVEin non-default realms.