You administer the Cluster Agent from the Controller where you can enable, disable, configure, and delete the Cluster Agent. You can also change which namespaces to monitor.

Any configuration change you make in the Controller also applies to the Cluster Agent. These changes take a couple of minutes, and the status displays with a progress indicator.

View the Cluster Agent Summary

From the Controller UI panel:

  1. In the upper-right corner, click Settings  > Agent Management > Manage Agents.
  2. Select the Cluster Agents tab to display a list of clusters. By default, all agents are enabled.

  3. Double-click a Cluster Agent. A dialog appears showing a Cluster Agent Summary of your current settings. The summary card shows the Cluster Name, Kubernetes Version, Cluster ID, and currently monitored Namespaces. To the right of the Namespaces table is a Search bar, where you can search by namespace.

  4. Click X to close the Cluster Agent Summary card.

Disable the Cluster Agent

  1. Select a Cluster Agent from the list.
  2. Click Disable. You can also select the Cluster name, right-click, and select Disable. A dialog appears confirming that you disabled the agent successfully. These changes take a couple of minutes, and the status displays with a progress indicator. When you disable the Cluster Agent, it does not report metrics or events, nor monitor pods or containers. You can re-enable a disabled Cluster Agent.  

Enable the Cluster Agent

  1. Select a Cluster Agent from the list.
  2. Click Enable. You can also select the Cluster name, right-click, and select Enable. A dialog appears confirming that you enabled the agent successfully. These changes take a couple of minutes, and the status displays with a progress indicator. When you enable the Cluster Agent, it reports metrics and events, and monitors containers.
    Enable Cluster Agent

Edit Namespaces

You can modify the namespaces by using nsToMonitorRegex field.

The following are common namespace behavior scenarios with nsToMonitorRegex field:

  • After initial registration, at every subsequent minute the agent checks for the nsToMonitorRegex field to match the namespaces. If there is nsToExcludeRegex mentioned, those namespaces are excluded from the monitored namespaces.

  • If a namespace configuration is to be monitored or ignored from the Controller, it takes precedence over the agent configuration (Cluster Agent YAML file). Therefore, if a namespace satisfies the regular expression that is configured for nsToExcludeRegex, but the Controller configuration includes that namespace under monitored namespaces, then the namespace is monitored.
    To exclude this namespace from being monitored, you must delete the namespace in the Controller configuration. In this scenario, where there is a conflict between the agent configuration and the Controller configuration, the addition or removal of the relevant namespace from the Cluster Agent configuration does not have any effect.

  • If the Cluster Agent is restarted, the nsToMonitorRegex and nsToExcludeRegex fields are read from the agent configuration file along with the namespaces configured in the Controller.

  • If the Controller is restarted, the monitored and ignored namespaces included in the Controller configuration are retained and reapplied along with the agent configuration.

  • If both the Cluster Agent and the Controller are restarted at the same time, the nsToMonitorRegex and nsToExcludeRegex fields are read from the agent configuration file. The namespaces to be monitored are determined based on the agent configuration.

  • If a new namespace matching the configured regex is added, the namespace is monitored without any additional configuration. Similarly, when a namespace does not match the configured regex, it is not monitored.

You can modify namespaces in a Cluster by:

  • Updating Namespaces in the Cluster Agent Configuration File -  Modify the nsToMonitorRegex field in the cluster-agent.yaml file before deploying the Cluster Agent. You can update the nsToMonitorRegex field in the cluster-agent.yaml file even after the registration.
    You can specify regular expressions (regex) for the namespaces that you want to monitor by using the nsToMonitorRegex field. If you do not require the Cluster Agent to monitor some of the namespaces that match the regex specified in the nsToMonitorRegex field, then you can specify nsToExcludeRegex along with nsToMonitorRegex. For example, if Cluster Agent must monitor all the namespaces except the namespace that has the name starting with exclude, specify nsToMonitorRegex as .* and nsToExcludeRegex as ^exclude.

  • Editing Namespaces in the User Interface - Edit namespaces after you deploy the Cluster Agent. Once deployed, the cluster is listed under  Agents or Cluster Agents. Open the browser-based configuration user interface and edit namespaces.

Update Namespaces in the Cluster Agent Configuration File

To update namespaces in a cluster, use the nsToMonitorRegex field in the cluster-agent.yaml before deploying the Cluster Agent.

Updating namespaces using the nsToMonitorRegex changes the currently monitored namespaces. The scenarios are mentioned at Edit Namespaces.

If the Cluster Agent pod unexpectedly restarts, the namespaces stored in the Controller take precedence and are preserved. See Troubleshoot the Cluster Agent.

To update namespaces:

  1. Open the cluster-agent.yaml file in a text editor.

  2. To specify namespaces based on regular expressions, include the nsToMonitorRegex field:

    nsToMonitorRegex: <regular expression>
    nsToExcludeRegex: <regular expression> #This is an optional field

  3. Verify the list of namespaces. If it is not correct, add or remove namespaces in the cluster-agent.yaml file.

  4. Open a command prompt. To apply the namespaces changes, enter: 

    kubectl apply -f cluster-agent.yaml

  5. To verify that the Operator registered the monitored namespace value, enter:

    kubectl-app describe cm cluster-agent-mon

Edit Namespaces in the User Interface

Once you have deployed the Cluster Agent, the Selected namespaces column displays the currently monitored namespaces.

To edit a namespace from the cluster, you must have administrator permissions: 

To edit a namespace:

  1. Double-click a cluster from the list.
  2. Click Configure. An Edit Cluster Agent dialog appears.
    Edit Cluster Agent
  3. To modify namespaces, select a namespace by checking the corresponding box. 
  4. Once the desired namespace box is checked, click the arrow to move it to either the Selected namespace table or the Available namespace table. 
  5. Click OK to close the dialog box. These changes take a couple of minutes and the status displays in a banner notification.

Updating namespaces in the cluster-agent.yaml file does not change your currently monitored namespaces. It assures that if the Cluster Agent pod unexpectedly restarts, that your namespaces are preserved. See Troubleshoot the Cluster Agent.

Add or Remove Namespaces

To add or remove a namespace from the cluster, you must have administrator permissions: 

To add or remove a namespace from the cluster:

  1. Double-click a cluster from the list.
  2. Click Configure.
  3. To modify namespaces, select a namespace by checking the corresponding box. Once the desired namespace box is checked, click the arrow to move it to either the Selected namespace table, or the Available namespace table.
  4. Click OK to close the dialog box. These changes take a couple of minutes and the status displays with a progress indicator..

Delete a Monitored Namespace

To delete a Cluster Agent monitored namespace:

  1. Double-click a cluster from the list.
  2. Click Configure. The Edit Cluster Agent dialog appears.
  3. Select a namespace by checking the corresponding box.
  4. Click the arrow to move to either the Available namespace, or to the Selected namespace table.
  5. Delete the namespace from your Kubernetes cluster.

Delete the Cluster Agent

To delete a Cluster Agent:

  1. Select the Cluster Agent name that you want to delete.
  2. Click Delete. A dialog asks you to confirm that you want to delete the Cluster Agent.
  3. Click Delete. If you delete a Cluster Agent, you will lose all historical data.

Delete Cluster Agent

<!--BEGIN QUALTRICS WEBSITE FEEDBACK SNIPPET-->
<script type='text/javascript'>
(function(){var g=function(e,h,f,g){
this.get=function(a){for(var a=a+"=",c=document.cookie.split(";"),b=0,e=c.length;b<e;b++){for(var d=c[b];" "==d.charAt(0);)d=d.substring(1,d.length);if(0==d.indexOf(a))return d.substring(a.length,d.length)}return null};
this.set=function(a,c){var b="",b=new Date;b.setTime(b.getTime()+6048E5);b="; expires="+b.toGMTString();document.cookie=a+"="+c+b+"; path=/; "};
this.check=function(){var a=this.get(f);if(a)a=a.split(":");else if(100!=e)"v"==h&&(e=Math.random()>=e/100?0:100),a=[h,e,0],this.set(f,a.join(":"));else return!0;var c=a[1];if(100==c)return!0;switch(a[0]){case "v":return!1;case "r":return c=a[2]%Math.floor(100/c),a[2]++,this.set(f,a.join(":")),!c}return!0};
this.go=function(){if(this.check()){var a=document.createElement("script");a.type="text/javascript";a.src=g;document.body&&document.body.appendChild(a)}};
this.start=function(){var t=this;"complete"!==document.readyState?window.addEventListener?window.addEventListener("load",function(){t.go()},!1):window.attachEvent&&window.attachEvent("onload",function(){t.go()}):t.go()};};
try{(new g(100,"r","QSI_S_ZN_6rMRcRv3UIIFx4i","https://zn6rmrcrv3uiifx4i-appdynamicsux.siteintercept.qualtrics.com/SIE/?Q_ZID=ZN_6rMRcRv3UIIFx4i")).start()}catch(i){}})();
</script><div id='ZN_6rMRcRv3UIIFx4i'><!--DO NOT REMOVE-CONTENTS PLACED HERE--></div>
<!--END WEBSITE FEEDBACK SNIPPET-->