Skip to content

Create an F5 Distributed Cloud machine

Create an F5 Distributed Cloud machine so Certificate Manager - SaaS can discover the certificate objects in your tenant's namespaces and provision certificates to them. The connector runs in the cloud and connects to your tenant over the F5 Distributed Cloud API.

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.
  • The URL of your F5 Distributed Cloud tenant console, including https://, such as https://<tenant>.console.ves.volterra.io.
  • An F5 Distributed Cloud API token whose user can list namespaces and manage certificate objects in the namespaces you want to use. If you plan to bind certificates to HTTP load balancers, the user also needs to manage load balancers in those namespaces. To create a token, see the F5 Distributed Cloud API documentation.

To create an F5 Distributed Cloud machine

  1. Sign in to Certificate Manager - SaaS.
  2. Click Installations > Machines.
  3. Click New, and then select F5 Distributed Cloud.
  4. On the Properties step, in Name, enter a name for the machine.
  5. 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.
  6. In F5 XC Tenant URL, enter the URL of your tenant console, such as https://<tenant>.console.ves.volterra.io. The URL must start with https://.
  7. In API Token, enter the F5 Distributed Cloud API token.

    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.

  8. Click Test Access. After the connection succeeds, click Continue. The Discovery step opens.

    Note

    A successful test confirms that Certificate Manager - SaaS can reach the tenant and that F5 Distributed Cloud accepts the API token. It doesn't check whether the token can manage certificate objects or load balancers.

  9. (Optional) In Namespace(s) to discover (leave empty for all, or enter one or more comma-separated namespaces), enter the namespaces to search for certificate objects, separated by commas, such as default,shared. Leave it empty to search every namespace the API token can list.

    When you leave it empty, discovery skips any namespace whose certificates the token can't read. When you enter namespaces, discovery fails if it can't read any one of them.

  10. (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).

  11. Click Continue. The Provisioning step opens.
  12. (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.

  13. 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 certificate objects in your namespaces.