Provision Fleet Service Points using vCenter Server and ESXi - BlueCat DNS Edge

DNS Edge User Guide (Fleet Service Point)

Locale
English
Product name
BlueCat DNS Edge

This section gives detailed instructions for provisioning a Fleet Service Point using vCenter Server and ESXi.

Prerequisites:

The following prerequisites must be met before you begin:
  • You must be running VMware ESXi v6.7
  • You have an operational vCenter Server
  • vCenter Server already has a datacenter
  • You have an operational ESXi deployment
  • vCenter Server and ESXi are able to contact each other

System requirements:

When provisioning the Fleet Service Point, you must configure the following system requirements:
  • 3 CPUs
  • 5 GB of RAM
  • 200 GB of disk space
Downloading the Fleet Service Point OVA image:
  1. Log in to the Edge Cloud Instance.
  2. In the top navigation bar, click and select Fleet Service Points.
  3. Click on the Fleet Service Points page. The Download Fleet Service Point Image window appears.

  4. From the drop-down menu, select VMware
  5. Click next to Image to download the Fleet Service Point OVA image.
    Note: You can use the same OVA image to provision multiple Fleet Service Points.
  6. Click next to Checksum to download the Fleet Service Point OVA image checksum file.

Configuring Fleet Service Point configuration details:

  1. To add a new Fleet Service Point, click on the Fleet Service Points page.
  2. Under Setup, enter the following information:
    • Name: enter the name of the new Fleet Service Point.
    • Description: add a description. This is optional.
  3. Under Type, select VMware from the drop-down menu.
  4. Under Network, enter the following information:
    • Enter the hostname of the Fleet Service Point.
    • Enter the IPv4 address of the Fleet Service Point in CIDR notation.
    • Enter the IPv4 address of the default gateway for the Fleet Service Point IP address.
      Attention: You must enter an IPv4 default gateway when configuring a Fleet Service Point.
    • (Optional) Enter the IPv6 address of the Fleet Service Point in CIDR notation.
    • (Optional) Enter the IPv6 address of the default gateway for the Fleet Service Point IP address.
      Note: If you are configuring an IPv6 address for the Fleet Service Point, you must also enter an IPv6 default gateway.
    • (Optional) Enter the IP addresses of any DNS servers that the Fleet Service Point will use. If you do not configure any DNS servers, the Fleet Service Point will use 8.8.8.8 as the default DNS server.
    • (Optional) Enter the IP address or FQDN of any NTP servers that the Fleet Service Point will use. If you do not configure any NTP servers, the Fleet Service Point will use the following default Debian NTP servers:
      • 0.debian.pool.ntp.org
      • 1.debian.pool.ntp.org
      • 2.debian.pool.ntp.org
      • 3.debian.pool.ntp.org
  5. Under Access, enter the following information:
    Note:
    • The SSH Public Key and VM Console Password fields are mandatory and must be filled out to provision the Fleet Service Point.
    • The SSH Public Key and VM Console Password are applied to the operations user account.
    • SSH Public Key: Enter the SSH public key of the Fleet Service Point. This adds the public key to the .ssh directory of the Fleet Service Point and allows you to SSH into the Fleet Service Point.
    • VM Console Password: Enter the console password for the Fleet Service Point. The password must meet the following requirements:
      • It must contain lowercase characters.
      • It must contain uppercase characters.
      • It must contain numbers.
      • It must contain symbols.
      • It must not contain spaces.
      • It must contain at least 12 characters.
    • Confirm Password: Confirm the console password for the Fleet Service Point entered in the VM Console Password field.
  6. (Optional) Under HTTP Proxy, enter the following information:
    • Enter the hostname of the proxy that the Fleet Service Point will use.
    • (Optional) Add the port number used to connect to the proxy server. By default, the value is 443.
    • (Optional) Enter the username and password that will be used to authenticate against the proxy server.
  7. Click Save and Download. A window appears where you can download the configuration file.
  8. Click Download Configuration to download the configuration file.
    Attention: The configuration file of the Fleet Service Point can only be downloaded once and cannot be recovered later. The configuration file is a JSON file that contains content that is compressed and base64 encoded, and can contain sensitive information such as HTTP proxy credentials.

    BlueCat strongly recommends storing the configuration file in a secure location and only storing the configuration file for as long as required. The configuration file should be securely destroyed when it is no longer in use.

Provisioning a Fleet Service Point in vCenter:
  1. Log in to your vCenter UI instance.
  2. Navigate to the folder in which you would like to install the Fleet Service Point.
  3. Right click on the folder and select provision OVF Template.
  4. Complete the installation Wizard and create your virtual machine.
    Note:
    • It can take up to 10 minutes for the Fleet Service Point OVA image to upload and for the VM to successfully provision.
    • Once the VM is provisioned, ensure that it is Powered Off before proceeding to modify the settings.
  5. Once the VM is provisioned, right click the VM instance name and select Edit Setting > VM Options > Advanced > Edit Configuration.
  6. Click Add Configuration Params.
  7. Add the following parameters:
    Name Value
    guestinfo.metadata <value of metadata field from the JSON configuration file>
    Note: The value of this field in the configuration file is already base64 encoded. Copy the value within the double quotes of the metadata field and paste it within the parameter value as is. The value must not include the double quotes (" ").
    guestinfo.userdata <value of userdata field from the JSON configuration file>
    Note: The value of this field in the configuration file is already base64 encoded. Copy the value within the double quotes of the userdata field and paste it within the parameter value as is. The value must not include the double quotes (" ").
    guestinfo.metadata.encoding gzip+base64
    guestinfo.userdata.encoding gzip+base64
  8. Press OK to save the settings.
  9. Power on the Fleet Service Point VM.

Once the Fleet Service Point has powered on, you can verify the status of the Fleet Service Point by checking the details on the Fleet Service Points page. The Status field on the Fleet Service Point details page displays Registered when the Fleet Service Point has successfully connected to the Edge Cloud Instance.

Once you have provisioned the Fleet Service Point VM, you can deploy DNS resolver service. For more information, refer to DNS Resolver Services.

Attention: You can use the Fleet Service Point diagnostics API to verify that the Fleet Service Point has successfully registered. The registrationStatus field within the Fleet Service Point diagnostics API response returns a value of REGISTERED when the Fleet Service Point has successfully registered with the DNS Edge Cloud. If the value is not REGISTERED, this may indicate that there is an issue with the Fleet Service Point provisioning and the service point may not operate as intended.

For more information on the Fleet Service Point diagnostics APIs, refer to Fleet Service Point status and diagnostics APIs.