Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Platform9 HostAgent

The Platform9 HostAgent is used to securely connect your infrastructure to your Platform9 SaaS Management Plane. The HostAgent can be installed using the Platform9 CLI or by manually downloading the HostAgent from the SaaS Management Plane and installing it on each node. The HostAgent is specific to each SaaS Managment Plane and cannot be used across different SaaS Managment Planes.

Important

The Platform9 CLI is the recommended way of installing the host agent and related PMK components and should be sufficient for most supported linux environments.

Only follow the manual mechanism to download and install the hostagent if specifically directed by Platform9 support or if the Platform9 CLI is running into issues on your linux environment.

Install HostAgent

To install the HostAgent follow the steps below:

  1. Navigate to the Infrastructure dashboard Nodes tab

  2. Click the + Onboard a Node button

  3. On the add Node page click the Advanced tab

  4. From here select the target OS and download the HostAgent Binary

  5. Copy the HostAgent to the target node and install the HostAgent

  6. Run./platform9-install-debian.shto install the HostAgent

Example: HostAgent Installation

./platform9-install-debian.sh --controller=<<saas_management_plane_fqdn>> --username=<<user_email>> --password=<<account_password>>  --project-name=<<tenant_to_attach>>

Once the installer starts you will need to answer two configuration questions.

Extracting Platform9 installer

Do you want to configure proxy settings (yes/no)? no
Platform9 recommends using NTPD to keep the time in sync.
Do you want to install and configure this now (yes/no)? yes

Warning

All OS prerequisites must be completed manually to successfully install the HostAgent and create a cluster.

To automate prerequisites and installation of the HostAgent use the Platform9 CLI

Uninstall HostAgent

In certain scenarios the Platform9 Host Agent will need to be uninstalled for a node to be successfully reused. This includes:

  • Cloning a VM that has Host Agent installed

  • Deauthorizing a node and re-running prep-node

  • Host Agent installation was interrupted causing the installation to fail

  • Node authorization fails due to network connectivity

To remove the Host Agent follow the steps below.

Step 1 Detach Node From Cluster

To completely reuse a node the node must be first detached from a cluster by using the Scale Workers or Scale Master command on the Infrastructure ‘Clusters’ dashboard or using the CLI. Once the node has been removed from the cluster it needs to be deauthorized form the Platform9 SaaS Management Plane. This can be done on the Infrastructure ‘Nodes’ dashboard by selecting the node and clicking the ‘Deauthorize Node’ table action. Once this command has been completed the node is detached and no longer under management.

The alternate approach is to delete the cluster and deauthorize all nodes.

Step 2 Make Sure HostAgent Is Not Running

Ensure the Host Agent process is not running by running the command:

If the Host Agent is running stop the Host Agent process on the Node by running:

Stopping HostAgent should stop all other services. Run the commands below to ensure all services are stopped.

Example Host Agent Removal

Clean up logs

Remove the existing logs

PreviousDeauthorize Node
NextDelete A Node And Uninstall PMK Packages

Was this helpful?