Hypervisor Onboarding Guide

This guide offers step-by-step instructions for onboarding, managing, and offboarding the Brokkr Hypervisor, enabling users to sell bare metal server resources on the Brokkr Marketplace. It covers dependencies, hypervisor setup, server and network requirements, and organizational configuration, with key notes on offboarding.

The purpose of this guide is to provide step-by-step instructions for onboarding and managing the Brokkr platform hypervisor offering.

  • The Brokkr Hypervisor offering allows users to utilize their bare metal servers and quickly sell resources on the Brokkr Marketplace.
  • The Brokkr platform handles all configurations of the bare metal machine, provided the following steps are completed.
 

Architecture

Hypervisor Architecture Components

Notion image

Hypervisor Networking Architecture

Notion image

Onboarding

Step 1: Ensure these dependencies are met:

  1. Server Requirements
    1. Ubuntu 22.04
      1. Ubuntu 22.04 ARM64
      2. Ubuntu 22.04 AMD64
    2. Minimum specifications required for the hypervisor components to operate.
      1. RAM - 4GB
      2. CPU Cores - 4
      3. Disk Storage - 100GB
    3. The VM specifications calculator below can be used to determine the specs a VM will receive once provisioned.
      1. MAX RAM - Min RAM = Total RAM
      2. Max CPU Cores - Min CPU Cores = Total Cores
      3. Max Disk Storage - Min Disk Storage = Total Disk Storage
    4. Virtualization enabled in BIOS
  1. Network Requirements
    1. NAT Network Type (default)
      1. Hypervisor
        1. Static Private IP Address
        2. Network Gateway Address
        3. Public IP Address → NAT configured to Private IP Address above
          1. Note - Public IP Address MUST be different from VM public IP.
        4. Interface Name
          1. The interface connected to this hypervisor also has access to the VM private network.
        5. Firewall - Open Firewall
        6. DNS Servers (Optional)
      2. Virtual Machine
        1. Static Private IP Address
        2. Public IP Address → NAT configured to Private IP Address above
          1. Note - Public IP Address MUST be different from the hypervisor public IP.
        3. Network Gateway Address
  1. Organization Setup
    1. Brokkr platform requires that your organization, under which you want to create a hypervisor device, is approved as a supply organization.
      1. Verify Organization Status
        1. Log into Brokkr platform user interface
        2. Select Settings dropdown
        3. Select Organizations
        4. Next to your organization name, it will show a “Demand” or “Supply” label.
      2. Submit Organization request to be a “Supply” type organization.
        1. Log into Brokkr platform user interface
        2. Select Settings dropdown
        3. Select Organizations
        4. Within the “Become a Supplier” section, select “Submit Application”
        5. The Brokkr platform team will review your application, and once approved, your organization status will change to “Supply”.
    2. Create Site / Zone
      1. Brokkr platform helps you track your infrastructure by allowing you to link your devices to a specific site / location.
        1. Site - This could be the data center name where the infrastructure resides.
        2. Location - This is the specific location name within your data center.
      2. You will be prompted to create your Site / Zone either during the organization creation process or when creating your hypervisor server.

Step 2: Create Hypervisor

  1. Log into the Brokkr platform via https://brokkr.hydrahost.com.
  1. Expand the DCIM section and select Hypervisors.
  1. Click the “Create Hypervisor” button.
  1. Select the organization under which you want to create your hypervisor device.
  1. Fill out the following fields:
    1. Hypervisor Device Information:
      1. Device Name
      2. Data Center Site
      3. Data Center Zone
      4. Private IP Address
      5. Gateway Address
      6. Interface Name
      7. Public IP Address
      8. Nameserver
    2. Virtual Machine Information:
      1. Private IP Address
      2. Gateway Address
      3. Public IP Address (different from hypervisor public IP address)
  1. Click “Submit Information.”
  1. Ensure the above dependencies are met and configured before proceeding.
  1. Copy the “Public SSH Key” command generated for your hypervisor device.
    1. This command will ensure SSH dependencies are configured to allow the Brokkr platform to connect to your device.
  1. On the bare metal hypervisor machine:
    1. Log in as the user Brokkr platform will authenticate as.
    2. Run the command copied above.

Step 3: Onboard Hypervisor

  1. Navigate back to the Brokkr platform hypervisor page.
    1. Add the “Username” of the user Brokkr platform will authenticate as.
    2. Click “Onboard Device.”
  1. The configuration process can take up to 30 minutes to complete, depending on hypervisor and network performance.
  1. Once the device is configured, its status will change to “Inventory.”

Management

Edit Hypervisor

  1. Log into the Brokkr platform via https://brokkr.hydrahost.com.
  1. Expand the DCIM section and select Hypervisors.
  1. Select “Overview” next to the hypervisor you want to view.
  1. Select “Edit Hypervisor” button.

Off boarding

IMPORTANT - offboarding hypervisor will result in deletion of VM currently running within this hypervisor.

  1. Log into the Brokkr platform via https://brokkr.hydrahost.com.
  1. Expand the DCIM section and select Hypervisors.
  1. Select “Overview” next to the hypervisor you want to view.
  1. Select “Settings” from hypervisor device page.
    1. Notion image
  1. Select “Offboard Hypervisor”
    1. Notion image
  1. Confirm offboarding
Did this answer your question?
😞
😐
🤩

Last updated on August 4, 2021