Skip to main content

Configure the Agent

As outlined in the 'What are Clusters' section, during the initial setup, vCluster Platform tries to install a vCluster Platform Agent on the connected cluster to handle further communication with the cluster. vCluster Platform allows certain level of control over the installation and upgradation of the vCluster Platform Agent release.

Disable vCluster Platform Agent​

There might be cases where you don't want vCluster Platform to automatically handle vCluster Platform agent updates for you and you want to manually install or upgrade the vCluster Platform agent. This can be achieved either by setting the environment variable DISABLE_AGENT to true in the vCluster Platform container or by setting the annotation loft.sh/cluster-ignore-agent: 'true' on a connected cluster. This can be achieved in the vCluster Platform UI as below

  1. Go to the Clusters view using the menu on the left.

  2. Click the drop down arrow next to the cluster name you wish to modify. In the drop down menu click the Edit button.

  3. In the drawer that appears from the right, click on the Agent configuration pane and select the 'Ignore Agent' checkbox.

  4. Click on the button.

warning

If you do not install vCluster Platform agent into a connected cluster at all, certain functionality, such as Spaces, Sleep Mode, Apps, Accounts, Account Quotas & Security Templates will not be available in the cluster

Agent Values​

The vCluster Platform Agent is installed on the connected cluster as a Helm Release. You can provide additional values for the release by setting the loft.sh/agent-values annotation on the Cluster object. These values would be merged with the default configuration values of the Agent's chart and subsequently applied to the Agent release. This can be achieved in the vCluster Platform UI as below.

  1. Go to the Clusters view using the menu on the left.

  2. Click the drop down arrow next to the cluster name you wish to modify. In the drop down menu click the Edit button.

  3. In the drawer that appears from the right, click on the Agent configuration pane. Provide the values in the textarea under Extra Agent Values in the YAML format.

  4. Click on the button.

Troubleshooting​

If you encounter issues while configuring agent values or deploying it manually, you might want to take a look at the Cluster troubleshooting guide.