Skip to main content

Overview

Last updated on

Feature Availability

This feature is currently behind the PL_SHOW_DELEGATE_STATUS_CARDS feature flag. To enable it, please contact Harness Support.

Delegates are only backward compatible up to a certain version and may not support new features. Running outdated delegates can lead to task failures, caching issues, and inconsistent behavior.

To prevent such issues, proactively manage and upgrade delegates. Options to manage delegates include:

Managing delegates

You can manage your delegate instances in your Harness account via the Delegate overview page. To access the Delegate overview page, navigate to your desired scope—Account, Organization, or Project—in your Harness account, and choose Settings > Delegates.

This page contains delegate-related information, including delegate installation, the latest version details, a search box, filters, delegate health overview cards, and a list of delegates with their details as shown in the image below

Delegate health overview cards

There are four delegate health cards that display the status of delegate instances.

  1. Expired: Delegates running beyond their EOS/EOL are no longer supported and might have limited functionality. These delegates should be upgraded immediately to prevent service disruption.

    Use the steps below to view delegates that are in an expired state:

  2. Near expiry: Delegates that are about to expire. Ensure these delegates are upgraded before they reach EOS/EOL.

    Use the steps below to view delegates that are in near expiry state:

  3. Unsupported: Delegates running prior to latest released version. These delegate may cause task failures or incompatibility issues.

    Use the steps below to view delegates that are unsupported:

  4. Auto-upgrade OFF: Delegates with auto-upgrade OFF need manual updates. Enable auto-upgrade to keep them on the latest version.

    Use the steps below to view delegates with Auto Upgrade OFF:

Delegate listing overview

The delegate within the scope are listed here with their details. Use the arrow to view each delegate's instances, shown as below

  • Delegate - It is a delegate type featuring a logo such as Helm, Kubernetes, or Docker, a delegate name, and a unique identifier within the scope.
  • Connectivity Status - Shows the current connection status for the delegate instance as “Connected” or “Not connected”.
  • Tags - The delegate tag is automatically added to your delegate during configuration. You can assign one or more tags to your delegate instance.
  • Version - Displays the running delegate version. Shows “N/A” if the delegate is not connected.
  • Instance Status - Displays when the delegate expires. It is used to determine when a delegate needs to be updated or replaced.
  • Last Heartbeat - It indicates when the delegate was last connected.
  • Auto Upgrade - Displays whether Auto Upgrades are enabled(ON) or disabled(OFF) for the delegate.

The vertical three dots on the right provide options based on the delegate type: Details leading to the group overview page, a Delete option to remove the delegate from the listing (Note: this does not uninstall the delegate from your infrastructure), and an Open Troubleshooter option appears for Delegate Type Kubernetes.

To view details of a delegate, click any delegate in the list. This opens a group overview page showing delegate instances running for that group.

The delegate group overview page is similar to the delegate overview page, including delegate health overview cards and listing details, but has an additional "Group Name" field under overview tab which is similar to "Delegate Name" as shown below