Create an Oracle Cloud Load Balancer machine¶
Preview feature
This feature is available in Preview and isn't yet generally available (GA). Functionality and behavior can change before GA.
Create an Oracle Cloud Load Balancer machine so Certificate Manager - SaaS can discover the certificate bundles on your Oracle Cloud Infrastructure (OCI) load balancers and renew them. Certificate Manager - SaaS connects to OCI directly with an API signing key, so you don't need a VSatellite. One machine covers one region.
Before you begin¶
- The System Administrator, PKI Administrator, or Resource Owner role. If you have the Resource Owner role, you must own or belong to at least one team.
- An OCI user for Certificate Manager - SaaS to connect as, with an API signing key uploaded to the user. Use a dedicated user that only Certificate Manager - SaaS uses, not a person's account or an administrator. You need the key's RSA private key in PEM format and, if the key is encrypted, its passphrase.
-
An OCI policy for a group that contains the user, with one statement for each compartment that holds load balancers you want to manage:
-
For discovery and provisioning:
Allow group <group> to use load-balancers in compartment <compartment> -
For discovery only:
Allow group <group> to read load-balancers in compartment <compartment>
Certificate Manager - SaaS never creates or deletes load balancers, so don't grant
manage load-balancers. Grant access to the whole tenancy (in tenancy) only if discovery must cover the root compartment. -
-
The Oracle Cloud identifier (OCID) of your tenancy, the OCID of the user, and the OCI region that holds the load balancers, such as
us-ashburn-1.
For more information about API signing keys and where to find OCIDs, see Required Keys and OCIDs in the OCI documentation.
To create an Oracle Cloud Load Balancer machine¶
- Sign in to Certificate Manager - SaaS.
- Click Installations > Machines.
- Click New, and then select Oracle Cloud Load Balancer (Preview).
- On the Properties step, in Name, enter a name for the machine.
- For Owning Team, choose the team that owns the machine. System Administrators and PKI Administrators can choose any team. Resource Owners can choose only a team they own or belong to.
- In Tenancy OCID, enter the OCID of your Oracle Cloud tenancy. It's shown under Tenancy Information in the OCI Console, and it starts with
ocid1.tenancy.. - In User OCID, enter the OCID of the OCI user that owns the API signing key. It starts with
ocid1.user.. -
In API Signing Key, paste the PEM-encoded RSA private key of the API signing key, including the
BEGINandENDlines.You don't need to enter the key's fingerprint. Certificate Manager - SaaS calculates it from the private key.
Note
Certificate Manager - SaaS encrypts the credentials you enter and doesn't display them again. On the machine's Properties tab, they appear masked. To keep a stored credential when you edit the machine, leave its masked value unchanged. Keep your own secure record of the credentials in case you need them again.
-
(Optional) If the API signing key is encrypted, in Private Key Passphrase, enter its passphrase. Otherwise, leave it empty.
- For Region, choose the region of the load balancers, such as
us-ashburn-1. To manage load balancers in another region, create another machine. -
Click Test Access. After the connection succeeds, click Continue. The Discovery step opens.
Note
The test checks only the credentials. It can't check load balancer permissions, because they depend on the compartment you choose for discovery. If the policy is missing, discovery or provisioning fails.
-
(Optional) In Compartment OCID, enter the OCID of the compartment whose load balancers you want to discover. Child compartments aren't included. The machine's OCI user needs a policy that grants at least
read load-balancersin the compartment.If you leave it empty, discovery uses the tenancy's root compartment. That requires a policy that grants access
in tenancy. A compartment-level policy doesn't cover the root compartment, and discovery fails. -
(Optional) In Load Balancer Name Filter, enter text to discover only the load balancers whose display name contains it. The match isn't case-sensitive. Leave it empty to include all load balancers.
-
(Optional) To skip certificates that have already expired, enable Exclude expired certificates.
Discovery covers the active load balancers in the machine's region. Each certificate bundle on a load balancer is discovered as one certificate, with one installation for each listener that uses it. A bundle that no listener uses gets one installation, with the listener name
<unbound>. Listeners that use a certificate from the OCI Certificates service aren't discovered. Renaming a load balancer in OCI doesn't create new installations. The next discovery updates the load balancer name on its existing installations. -
(Optional) To discover certificates on a schedule, enable Schedule. For Repeat every, choose Day, Week, or Month, and then in At, enter the time. For Week, select the days of the week. For Month, enter the days in Day of month. Times are in Coordinated Universal Time (UTC).
- Click Continue. The Provisioning step opens.
-
(Optional) To provision certificates on a schedule, enable Schedule. For Repeat every, choose Day, Week, or Month, and then in At, enter the time. For Week, select the days of the week. For Month, enter the days in Day of month. Times are in Coordinated Universal Time (UTC).
Scheduled provisioning pushes only certificates that are queued for deployment, such as renewed certificates, so renewals install during the window you choose.
-
Click Finish.
What's next?¶
After you create the machine, provision a certificate to it. You can also run discovery on the machine at any time to track the certificates on your load balancers.