Skip to main content
Version: latest

Create Local Cluster

You can create and manage a single-node cluster locally from the local UI. This page guides you through how to create a cluster using Local UI.

tech preview
This is a Tech Preview feature and is subject to change. Do not use this feature in production workloads.

Limitations

  • You can only create single-node clusters consisting solely of the Edge host you create the cluster from. You cannot include other Edge hosts in the same local or remote network.

Prerequisites

  • Network access to the Edge device’s IP and port where the local UI is exposed. The default port is 5080.

  • Credentials to log into the local UI. Any OS user can be used to log in to the local UI.

  • You have uploaded the necessary software artifacts to the Edge host or included the artifacts in the Edge Installer ISO during EdgeForge. For more information, refer to Upload Content Bundle and Build Content Bundle.

  • You must ensure that the Edge host has a stable IP address. You have the following options to achieve a stable IP address:

    • Use a static IP address. Contact your network administrator to assign the Edge host a static IP address.
    • Use Dynamic Host Configuration Protocol (DHCP) reservations to reserve an IP address in a DHCP network. Contact your network administrator to reserve IP addresses for your Edge hosts in a DHCP network.
    • Enable network overlay on your Edge cluster. Network overlay can only be enabled during cluster creation. For more information about network overlay, refer to Enable Overlay Network.

Create Local Cluster

  1. Log into the local UI by visiting the 5080 port of your Edge device's IP address or domain name. For more information, refer to Access Local UI.

  2. From the left Main Menu, click Cluster.

  3. Click Create cluster.

  4. Fill out Basic Information such as cluster name and tag. Click Next.

    ParameterDescription
    Cluster nameName of the cluster.
    TagsKey-value pairs to provide metadata about your cluster.
  5. If you built a cluster definition into your Edge installer ISO, you can either choose to use the embedded config or import a cluster definition file. The embedded config uses a cluster definition you included during the creation of the ISO image you used to install Palette Edge on your Edge host. Ensure that the final profile for your deployed cluster contains the pack Harbor Edge-Native Config. This pack is required for all disconnected Edge clusters.

    To learn more about how to export a cluster configuration and import it during this step, refer to Export Cluster Definition.

    After you finish configuring the cluster profile, click Next.

  6. If your selected cluster profile has profile variables, you will now be prompted to enter the values for those profile variables. The variables with default values will be auto-populated unless the variable value is masked when you defined the variable. For more information on cluster profile variables, refer to Define and Manage Profile Variables.

    Enter the values for the profile variables and click Next.

  7. In the Cluster Config step, enter a virtual IP address to be used by your cluster. Optionally, you can also specify a Network Time Protocol server and an SSH public key.

    ParameterDescription
    Network Time Protocol (NTP)Specify the IP address for any Network Time Protocol (NTP) servers the cluster can reference.
    SSH keysProvide the public key of an SSH key pair that you will use to connect to the Edge host.
    Virtual IP addressProvide the virtual IP address to be used by the cluster.

    Optionally, you can also enable network overlay, especially if your cluster will operate in an DHCP environment. For more information, refer to Enable Overlay Network. If you enable the overlay network, you need to specify a CIDR range to be used by the overlay network.

  8. In the Node Config step, you can specify configurations for the control plane pool of your single-node cluster. For more information about node pool configurations, refer to Node pools. After you finish configuration, click Next.

  9. Review your configurations and deploy the cluster.

Validate

  1. Log in to the local UI.

  2. Click Cluster. Verify that your cluster has entered the running status.