From 8585ef343e6481bf1d92ec2175682332a846a388 Mon Sep 17 00:00:00 2001 From: Avi Miller Date: Sun, 20 Jun 2021 09:04:41 +1000 Subject: [PATCH] Updated Using Oracle Cloud Infrastructure DNS (markdown) --- ...-to-use-Oracle-Cloud-Infrastructure-DNS.md | 25 ++++++++++++++++--- 1 file changed, 21 insertions(+), 4 deletions(-) rename Using-Oracle-Cloud-Infrastructure-DNS.md => How-to-use-Oracle-Cloud-Infrastructure-DNS.md (80%) diff --git a/Using-Oracle-Cloud-Infrastructure-DNS.md b/How-to-use-Oracle-Cloud-Infrastructure-DNS.md similarity index 80% rename from Using-Oracle-Cloud-Infrastructure-DNS.md rename to How-to-use-Oracle-Cloud-Infrastructure-DNS.md index b58c5dd..cda8d1b 100644 --- a/Using-Oracle-Cloud-Infrastructure-DNS.md +++ b/How-to-use-Oracle-Cloud-Infrastructure-DNS.md @@ -9,15 +9,29 @@ Before you can use OCI DNS with `acme.sh`, you'll need the following: * The [tenancy and service account OCIDs][OCIDS] We recommend [installing the OCI CLI][CLI] and using the [interactive setup process][CSTP] -to create an API signing keypair. +to create an API signing keypair. If the OCI CLI is configured, the plugin will automatically +detect and use the configuration file for authentication. Alternatively, the [OCI Developer Guide][DG] provides the manual steps required to generate the API signing keys and determine the required OCIDs. -## Configuring the `dns_oci` plugin +## Configuration -To use the `dns_oci` plugin, the following environment variables must be -configured: +### Automatic configuration + +**No configuration is required** if the [OCI CLI][CLI] is installed with its configuraton file +located at `$HOME/.oci/config` and uses the `DEFAULT` profile. + +If necessary, you can overrride either the default configuration file path or profile +using the following two environment variables: + +* `OCI_CLI_CONFIG_FILE`: set to the full path including filename of the OCI SDK and CLI + configuration file. +* `OCI_CLI_PROFILE`: provide an existing profile from the configuration file. Case-sensitive! + +### Manual configuration + +If the OCI CLI is not installed, the following environment variables must be set: * `OCI_CLI_USER`: OCID of the user calling the API. Example: `ocid1.user.oc1..` * `OCI_CLI_TENANCY`: OCID of your tenancy. Example: `ocid1.tenancy.oc1..` @@ -30,6 +44,9 @@ following two variables: in PEM format; or * `OCI_CLI_KEY`: the private API signing key in PEM format +> **Tip:** The variables above can also be used to override the values stored in the +> OCI SDK and CLI configuration file. + ### Issuing a certificate To issue a certificate, ensure either the OCI CLI is working correctly or all