# README
Oracle Provider
This provides Oracle Cloud Infrastructure (OCI) signing support for the FN golang SDK
Configuration:
With the provider set to oracle
the following settings apply:
The provider can read most of it's settings from OCI configuration file: (~/.oci/config)
Key | Example | Required | Read from ~/.oci/config | Description |
---|---|---|---|---|
api-url | https://functions.us-ashburn-1.oraclecloud.com/ | Yes | No | The API endpoint to contact for accessing the service API |
oracle.compartment-id | ocid1.compartment.oc1..aaaaaaaajvunnz..... | Yes | No | The compartment OCID for the functions tenancy - this corresponds to where you want functions objects to exist in OCI |
oracle.tenancy-id | ocid1.tenancy.oc1..aaaaaaaai4w6iipzc73k3s2.... | No | Yes | The tenancy of the user accessing the service |
oracle.user-id | ocid1.user.oc1..aaaaaaaay2df7zq4lgv7.... | No | Yes | The OCID of the user accessing the API |
oracle.fingerprint | 30:c1:f8:98:38:be:bb... | No | Yes | The RSA key fingerprint of the key being used |
oracle.key-file | /home/myuser/.oci/private_key.pem | No | Yes (key_file ) | The private key for the registered API key |
oracle.pass-phrase | No | Yes | (pass_phrase ) | |
oracle.profile | No | No | Defaults to DEFAULT - the OCI Configuration profile to use for reading OCI information | |
oracle.disable-certs | true | No | No | Ignore SSL host name checks when contacting the server (should only be used for diagnosis and testing) |
With the provider set to oracle-ip
, and the CLI hosted on an OCI instance, the following settings apply:
Key | Example | Required | Read from ~/.oci/config | Description |
---|---|---|---|---|
api-url | https://functions.us-ashburn-1.oraclecloud.com/ | No | No | The API endpoint to contact for accessing the service API. If unset, it will construct a local endpoint from the instance's region |
oracle.compartment-id | ocid1.compartment.oc1..aaaaaaaajvunnz..... | No | No | The compartment OCID for the functions tenancy - this corresponds to where you want functions objects to exist in OCI. It defaults to the instance compartment |
oracle.disable-certs | true | No | No | Ignore SSL host name checks when contacting the server (should only be used for diagnosis and testing) |
For the Instance Principal provider, the instance must be in a dynamic group that has been granted the rights to use and/or manage functions, as well as their associated resources.
With the provider set to oracle-cs
, and the CLI running on an OCI Cloudshell machine, the following settings apply:
The provider can read most of it's settings from the OCI CLI configuration file: (/etc/oci/config)
Key | Example | Required | Read from OCI CLI Config | Description |
---|---|---|---|---|
api-url | https://functions.us-ashburn-1.oraclecloud.com/ | No | No | The API endpoint to contact for accessing the service API. If unset, it will construct a local endpoint from the region in the default region OCI CLI profile |
oracle.compartment-id | ocid1.compartment.oc1..aaaaaaaajvunnz..... | No | No | The compartment OCID for the functions tenancy - this corresponds to where you want functions objects to exist in OCI. It defaults to the root tenancy compartment |
oracle.disable-certs | true | No | No | Ignore SSL host name checks when contacting the server (should only be used for diagnosis and testing) |
# Packages
No description provided by the author
# Functions
No description provided by the author
Retrieve second-level domain for the current realm from IMDS.
Skip verification of insecure certs.
Creates a new "oracle-cs" provider instance for use when Fn is deployed in an OCI CloudShell environment.
No description provided by the author
No description provided by the author
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
Holds the three required config values in a CS env.
No description provided by the author
No description provided by the author