Configure a Custom Domain

Overview

Follow the steps below to configure your Org with a custom domain name. Domains are scoped to an Org and available to be used by all GVCs within the Org.

Workloads created within a GVC will automatically use the configured domain name for their endpoint URLs.

This quick start will demonstrate how to:

Prerequisites

Step One - Create a Domain Resource

  1. Create a new Domain resource by using one of the following methods:

    • Clicking Domains in the left menu and click New, or
    • Click the Create dropdown in the upper right corner and select Domain.
  2. The console will prompt for the desired subdomain (e.g., sub.example.com). Click Next.

  3. The required DNS entries will be displayed. These entries will need to be added by the person who is responsible for maintaining the DNS for the domain. Once the DNS entries are added and the changes have propagated across the Internet, click on the acceptance checkbox and click Create.

  4. The platform will verify the DNS entries and, if successful, add the Domain to your Org.

Step Two - Associate Domain with a GVC

  1. Click GVC in the left menu. If you have multiple GVCs, verify that you are on the desired GVC.
  2. Click on the arrow within the Domain control. The list of available Domains will be shown. Select the desired Domain and click Save. All Workloads associated with this GVC will now be deployed using this domain.

Step Three - Review and Test Workloads

  1. Click Workloads in the left menu and choose the Workload that was configured with the new Domain.
  2. Displayed is the Workload Info page. Notice that the Global Endpoint URL is now using your domain and the Workload name is the subdomain. This URL is automatically secured using TLS, load balanced, and DNS geo-routed to the nearest healthy location. Clicking the Open link will load the Workload in a new tab.
TIP
  • The Canonical Endpoint uses the default Control Plane domain cpln.app and behaves the same as the Global Endpoint. This URL can be used for troubleshooting.

  • A workload can be configured to resolve directly to the subdomain by explicitly naming the workload index. Refer to the Domain reference page for details.

  1. Click Deployments. This page shows the locations this Workload is deployed to. Next to each location is the location specific URL for your Workload. Clicking the Open link will load the Workload only in that location. This can be used for troubleshooting.

Summary

Configuring your custom Domain name allows your Workload to be called using your branding in only a few steps. Once configured and associated with a GVC, the domain is used by all the Workloads within the GVC.

Copyright © 2022 Control Plane Corporation. All rights reserved. Revision 68a8865b
Contents