Agents
GitOps Agents helps to access the private repositories and workload artifacts in a Helm/GitRepo, run infra-provisioning stages using Terraform and perform system sync stage process. The created agents can be installed on the clusters manually, to receive alerts for any triggers
Organization Admin and Project Admin roles have the privilege to create, read, update, upgrade and delete agents.
Pre-Conditions¶
An healthy and ready state Cluster is mandatory
New Agent Creation¶
Perform the below steps to create one (or) more agents
- Click GitOps and select GitOps Agents in the Controller
- Click New Agent
- Provide a name and select a Deployment Type from the drop-down, Docker (or) Kubernetes
- Select a cluster from the drop-down to which the agent must be installed
Note: Cluster selection is not applicable for Docker Type
- Click Create
The initial status of the agent creation is Unknown and based on the criteria, the status changes to Healthy or Unhealthy in one (1) minute duration
Upgrade Agent¶
Users are allowed to upgrade the agent(s) if the latest agent version is available
Kubernetes Type¶
To upgrade a Kubernetes type Agent, perform the below steps:
- Click Upgrade available blue banner notification and the Progress Tracker pane appears
- Read the Note section available in the Progress Tracker to know more about upgrade process
- Click Upgrade to proceed
The progress changes to Upgrade in Progress and you can view the progress as shown in the below example
Once the upgrade is initiated, the notification banner disappears showing the status as Healthy
Docker Type¶
To upgrade a Docker type Agent, perform the below steps:
-
Click Upgrade available blue banner and the Progress Tracker pane appears. A Readme is available for the users
-
Click Upgrade to proceed
On initiating the agent upgrade, the progress changes to Upgrade in Progress as shown in the below example
- Click the upgrade in progress notification. You will see the Instructions to deploy cd-agent agent-docker in the Progress Tracker pane
- Once the Agent Draining is complete, the Progress Tracker pane provides a different set of instructions as shown below. Perform these steps to complete the agent upgrade process
Once the upgrade in initiated, the notification banner disappears showing the status as Healthy
Note: The status changes to Deactivated once the agent upgrade is initiated and again changes to Activated on a successful upgrade
Agent Options¶
- The existing GitOps Agent(s) can be shared with All/Specific/None projects. This helps to use the configured agent specs to infuse to the new pipeline if required or change the required resources
Make the required selection to share the agent and click Save
Note: Users cannot share/delete the agents inherited from other projects
- Users can Activate/Deactivate or Delete the existing agents using the respective icons. An information icon is available for Docker agents, providing the instructions to deploy the agents and upgrade to the latest version
Note: Activation of Agent is not allowed during the upgradation process
Failed Scenarios¶
Kubernetes Agent upgrade can fail based on the below scenarios
- Cluster is unhealthy or not reachable
- Agent is not reachable
- Cluster's Nodegroup not having enough CPU limit to accommodate new agent
Docker Agent upgrade can fail based on the below scenarios
- Agent is not reachable
- Not following the given upgrade instructions provided in the process tracker pane within 8-10 mins once the agent draining is complete
Below is an example where the agent is not reachable and the draining process is incomplete, hence the upgrade failed
