Running the on-prem cluster install wizard
On-premises clusters
From the Setup section, the “On-Prem Clusters” tab contains a view of all existing on-premises clusters that are connected to Apporto.
If no clusters have been set up yet, a message will instruct you to start a new installation.
Installations of new clusters may be started at any time by clicking the Install Apporto button to trigger the installer wizard. You may also resume an incomplete installation by clicking Resume from the cluster list.
On-premises installer
To set up a new on-premises cluster, follow the steps below. Some tasks need to be completed outside of the Apporto NextGen control plane.
Before you begin, complete all items in the Cluster Node Pre‑Install Checklist (Wizard Prereqs) to ensure your browser, network egress, and admin credentials are ready.
Step 1
The initial step of the installer explains how to install the Apporto VM into your hypervisor.
Download the Apporto VM file that is appropriate to your hyperstream provider’s file format, and then follow the onscreen instructions for node registration. Packaged with the VM is a node discovery tool that will pass information back to the cluster installer.
Use the instructions in the related articles to add the Apporto VM to your hypervisor environment.
Once the Apporto VM is installed, set up your gateway or load balancer. https://apportoteam.atlassian.net/wiki/spaces/NP/pages/1349353501
Step 2
Once you are transferred back to the installer, Step 2 will display the nodes you selected.
You must have at least one manager and two worker nodes in your cluster. Select a role for each node. The available node types are:
Manager - This node will connect to the control plane.
Mixed - If the same node will perform both functions, select this role.
Worker
Once you have selected a role for each node, click Register for the installer to push a registration key to each node. This process may take several minutes, but you will see a confirmation message when registration begins and the Next button will be unlocked. You may proceed to Step 3 while registration is running.
Step 3
To connect Apporto to the servers that will be running virtual desktops and applications, the cluster must be linked to a resource hub. If you have already created one or more on-premises resource hubs, you may select the appropriate one from the resource hub dropdown. Existing values will populate in the Step 3 form, and any missing mandatory values can be filled in.
You may also select the “Create new” option from the dropdown to create a resource hub on the fly. Please note that the hub values in this form are the minimum needed for cluster installation. Additional resource hub values can be configured by going to the Resource Hubs section of the control plane. You can learn more about resource hub values in the Apporto Help Center.
The table below shows the resource hub values that relate to cluster installation.
Field | Datatype | Required? | Notes |
|---|---|---|---|
Name | String | Yes |
|
Hub ID | String | System-generated | This value will be generated by the system and used in back-end processes. |
Description | String | No |
|
Hyperstream name | String | Yes |
|
Hyperstream secret FQDN | String | Conditional | At least one of the FQDN values must be entered; both can be filled if appropriate. |
Secure gateway FQDN | String | Conditional | |
RDP management gateway hostname | String | Yes |
|
Route traffic here by default | Boolean | Yes | If both FQDN values are entered, one of them must be selected for traffic routing. If only one FQDN is entered, the system will auto-select the matching radio button. |
Hyperstream secret | String | System-generated |
|
API key | String | System-generated |
|
The hyperstream and RDP management gateway hostnames must be all lowercase.
Once the form is filled in, click Next to advance to Step 4.
Step 4
Your node role assignments from Step 2 and resource hub values from Step 3 are displayed for confirmation. Review the settings, and go back to the earlier steps if anything needs to be altered.
If all settings are correct, click Finish Installation.
Step 5
The final step of installation pushes Apporto software and services down to the cluster. You will see a progress bar while the installation is running.
Once installation has successfully completed, you will see a confirmation message. Click Done to return to the cluster list.
If there are any issues with the installation process, you will see an error message. Contact Apporto Support for assistance.