REDWOOD

Introduction

When creating an Oracle Analytics Cloud instance, Oracle provides a default URL with the *.analytics.ocp.oraclecloud.com domain name.

You can use the Vanity URL feature for a custom URL that includes your company domain name. This feature lets you define and use your company domain name as a synonym for the default Oracle-provided DNS name. For example, https://oac.mycompany.com/ui.

This blog post provides an automation script and discusses the steps you must follow to create, update, and delete a Vanity URL for Oracle Analytics Cloud (OAC) using the Oracle Cloud Infrastructure (OCI) Console and Command Line Interface (CLI).

Automation Script

The automation script requires OCI CLI installed on an OCI or on-premises computer with access to the OAC instance.

To install OCI CLI, refer to the blog How to Stop and Start an OAC Instance using OCI CLI.

The automation script requires below values:

  • OAC DNS name.
  • The SSL certificate of the OAC DNS name.
  • CA bundle certificates.
  • The private key of the public certificate.
  • The passphrase of the private key, if it exists.
  • The OCID of the OAC instance.

Get the OAC instance OCID value from the OAC instance management page in the OCI Console.

Enter the absolute file path and the file name for the SSL certificate details in the automation script.

OACVanity1

Download Automation Script

Based on the operation you selected, create | update | delete, the script performs the respective operation of the OAC vanity URL and logs the outcome to a log file.

REDWOOD

Create the OAC Vanity URL

For prerequisites and steps to create a vanity URL for OAC, refer to the blog Set Up a Vanity URL for Oracle Analytics Cloud on OCI Gen 2.

Update the OAC Vanity URL

Updating the vanity URL is needed when the SSL certificate is expired or if the private key is compromised. While updating the certificate hostname cannot be changed; you can only update the SSL certificate and its private key. If you need to update the domain name, delete the vanity URL and create it with the new domain name.

Steps to Update the SSL Certificate

  1. Sign in to the OCI Console at https://cloud.oracle.com
  2. In the OCI Console, navigate to Analytics & AI under the Analytics Cloud section.
  3. Select the compartment that contains the OAC instance you want to update.
  4. Click on the name of the OAC instance.
  5. On the Instance Details tab, click on More actions and then select Update Vanity URL Certificate.
    OACVanity2
  6. On the Update Vanity URL Certificate page, update the digital X.509 certificate for your vanity domain. You can do this by uploading a renewed certificate file in PEM format (with the extensions .pem, .cer, or .crt) or pasting the valid X.509 certificate text
    OACVanity3
  7. Next, update the private key for the certificate. You can do this by uploading the private key file (with the extensions .pem or .key) or pasting the private key text. If your private key requires a passphrase, enter the passphrase in the Private Key Passphrase field.
    OACVanity4
  8. If your certificate requires a new certificate authority chain, select Custom Certificate Authority Chain and update the chain by uploading the chain file (with the extensions .pem, .cer, or .crt) or pasting the chain text.
    OACVanity5
  9. Once you have updated the certificate, key, and chain (if needed), click Update.
    OACVanity6
  10. Wait for the update to complete; this may take a few moments.

Verify that you can access the OAC vanity URL and see the updated SSL certificate. This will ensure the vanity URL is updated and the users can access the OAC instance without issues.

Delete the OAC Vanity URL

Deleting the vanity URL is needed when you no longer need it or when the domain name is changed, as you have to delete and create the vanity URL for the new domain name.

  1. Sign in to the OCI Console at https://cloud.oracle.com
  2. In the OCI Console, navigate to Analytics & AI under the Analytics Cloud section.
  3. Select the compartment that contains the OAC instance you’re looking for.
  4. Click the name of the OAC instance for which you want to delete the vanity URL.
  5. Click More actions on the Instance Details tab and select Remove Vanity URL
    OACVanity7
  6. Click Remove to confirm

REDWOOD

Call to Action

In this blog post, we have covered the steps to update, and delete a Vanity URL for Oracle Analytics Cloud. For more information, refer to the OAC and OCI CLI documentation.

REDWOOD