Provision Service Point on KVM - BlueCat Edge - Service Point v4.x.x

BlueCat Edge Deployment Guide

ft:locale
en-US
Product name
BlueCat Edge
Version
Service Point v4.x.x

This section gives detailed instructions for provisioning a Service Point instance on KVM.

Prerequisites:

The following prerequisites must be met before you begin:
  • You must have KVM installed on a host machine running CentOS 9, CentOS 10, or Ubuntu 24.04 LTS operating systems.
  • You must have virtinst installed.

Downloading the Service Point qcow2 image

  1. Log in to the Edge Cloud Instance.
  2. In the top navigation bar, click and select Service points.
  3. Click on the Service points page. The Download service point image window appears.

  4. From the Version menu, select the version of service point that you would like to deploy.
    Attention: Before selecting a service point version, ensure that the services that you are deploying to the service point are compatible with that version. For more information on compatibility, refer to Software support matrix.
  5. From the Images table, select Linux KVM to download the Service Point qcow2 image.
    Note: You can use the same qcow2 image to provision multiple Service Point.
  6. Under SHA256 checksum, click to download the Service Point image checksum file or click to copy the image checksum value to your clipboard.
  7. Click Close to close the window.

Configuring Service Point configuration details



  1. To add a new Service Point, click New on the Service points page.
  2. Under Setup, enter the following information:
    • Name: enter the name of the new service point.
    • Description: add a description. This is optional.
  3. Under Platform, select Hardware from the drop-down menu.
  4. Under Network, enter the following information:
    • Enter the hostname of the service point.
    • Enter the IPv4 address of the service point in CIDR notation.
    • Enter the IPv4 address of the default gateway for the service point IP address.
      Attention: You must enter an IPv4 default gateway when configuring a service point.
    • (Optional) Enter the IPv6 address of the service point in CIDR notation.
    • (Optional) Enter the IPv6 address of the default gateway for the service point IP address.
      Note: If you are configuring an IPv6 address for the service point, you must also enter an IPv6 default gateway.
    • (Optional) Enter the IP addresses of any DNS servers that the service point will use. If you do not configure any DNS servers, the 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 Service Point will use. If you do not configure any NTP servers, the 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
      Note: BlueCat recommends testing the connection between the service point and NTP servers for reachability, as some networks do not allow NTP traffic by default.
  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 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 service point. You can use an existing key pair by entering the content of the public key in the field, or generate a new key pair and enter the content of the newly created public key in the field.

      This adds the public key to the .ssh directory of the Service Point and allows you to SSH into the service point. Once you have provisioned the service point, you can access the service point using SSH and the associated private key to log into the operations user account.

    • VM Console Password: Enter the console password for the 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 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 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.
    Note:
    • Currently, HTTP is the only supported proxy type.
    • SOCKS proxy servers are not supported.
    • Basic authentication is supported.
    • The proxy server must be configured to allow HTTP POST traffic.
    • The proxy server must be able to resolve all BlueCat Edge Cloud addresses.
    • For proxy servers and firewalls that do SSL interception:
      • mTLS must exclude/except *.bluec.at.
      • You can't install certificates as a workaround.
    • The only tested and supported authorization is Basic authorization with username and password provided.
  7. Click Save and Download. A window appears where you can download the configuration file.
  8. Click Hardware (.iso) to download the service point configuration file for the appliance.

Provisioning the Service Point in KVM using the command line

  1. Copy the downloaded Service Point qcow2 and Service Point configuration ISO file to the KVM host machine.
  2. Run the following virt-install command to install your VM.
    virt-install \
    --import \
    --name edge_kvm \
    --ram 8192 \
    --vcpus 4 \
    --disk ./<path-to-image>/edge-service-point-v25.2.1.qcow2,format=qcow2 \
    --disk ./<path-to-config>/edge-kvm-cloudinit.iso,device=cdrom \
    --noautoconsole \
    --os-variant debian 12 \
    --network network=network-nat

    Where:

    • --name <name> is the name of the Service Point VM.
    • --ram <value> is the amount of memory to allocate to the Service Point VM, in megabytes. BlueCat recommends configuring a minimum of 8 GB of memory.
    • --vcpus <value> is the number of CPUs to allocate to the Service Point VM. BlueCat recommends configuring a minimum of 4 CPUs.
    • --disk ./<path-to-image>/edge-service-point-v25.2.1.qcow2,format=qcow2 is the path to the qcow2 image on the local host.
    • --disk ./<path-to-config>/edge-kvm-cloudinit.iso,device=cdrom is the path to the Service Point configuration ISO file on the local host. This is mounted as a CD ROM.
    • --network network=<virtual-network> is the virtual network that you would like the Service Point to use.

The command creates the service point virtual machine. Once the service point has powered on, you can verify the status of the service point by checking the details on the Service points (v4) page. The Status field on the service point details page displays Registered when the Service Point VM has successfully connected to the Edge Cloud Instance.

You can deploy now DNS resolver service. For more information, refer to DNS resolver services.

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

For more information on the Service Point telemetry APIs, refer to Service Point telemetry APIs.