Working with a Cluster

Viewing Cluster Details

The Cluster Inventory lists all clusters that have been successfully onboarded. Cluster details are available for viewing within the Cluster Inventory.

To view cluster details:

  1. Go to menu > KUBE+ > Inventory > Cluster Inventory.
  2. Click the cluster name link in the Cluster Name column.
    The following cluster details are displayed:
    Table 1. Cluster Details - Field and Description
    Field Description
    Cluster Name Unique name of the cluster.
    Cluster Status Status of the cluster.
    Available Namespaces Namespaces available within the cluster.
    No. of Pods Count of pods.
    Connectivity URL URL used for a connection between the cert-orchestrator and AppViewX.
    Auth Secret Name Authentication secret name that contains the authentication information.
    Secret Namespace Secret associated with a namespace.
    Current Nodes Current node of the cluster,
    Table 2. Discovery Exclusion Settings - Field and Description
    Field Description
    Namespace Exclusion Namespaces that are excluded from certificate discovery.
    Namespaces Excluded Count Number of namespaces that are not included when certificates are discovered.
    Manage Namespace Exclusions Status of Namespaces (Included or Excluded) and List of Namespaces

Managing a Cluster

The cluster's information will be automatically added to the Cluster Inventory in a Pending Approval state after the cert-orchestrator is successfully installed on the desired cluster. CLM operations on the Kubernetes cluster where the cert-orchestrator is deployed will only be permitted when the cluster is in Managed State.

To change the cluster status to Managed:

  1. Go to menu > KUBE+ > Inventory > Cluster Inventory.
  2. Select a preferred cluster(s), and then click Manage.
    Note: To enable the automatic transition of clusters into a managed state, administrators can set the 'Cluster Auto Approval Policy' to True by navigating to menu > KUBE+ > System Administration > Cluster Settings.
    The cluster's status will take some time to update to Managed.

Unmanaging a Cluster

A cluster that is already managed in the Cluster Inventory can be removed from management to apply CLM restrictions.

To unmanage a cluster:

  1. Go to menu > KUBE+ > Inventory > Cluster Inventory.
  2. Select a managed cluster.
  3. Click Unmanage on the menu bar.
    The cluster's status may take some time to change to Unmanaged.

Modifying Cluster

The cluster details and feature gates can be adjusted after the cert-orchestrator has been successfully deployed to the cluster.

To modify cluster details:

  1. Go to menu > KUBE+ > Inventory > Cluster Inventory.
  2. Click the (edit) icon in the Actions column of the cluster row.
  3. On the Cluster Upgrade page, update the following details as needed:
    • In the Update Cert Orchestrator section:

      • Modify Feature Gates : Cluster administrators can modify feature gates to enable or disable specific services within the cluster.

      • Manage AppViewX Connection Settings : Modify the service account linked to the cluster, enable or disable private key discovery, and change the AppViewX URL.
        Note:

        If the AppViewX URL or service account credentials are updated, the cluster administrator can download the new credentials as a YAML file and apply them to the cluster.

      • Click Generate Update Command to get the updated deployment configuration.

      • Copy and execute the install command in the desired cluster.
    • In the Discovery Exclusion Settings section:
      • Namespace Exclusion - View the namespaces selected for exclusion from certificate discovery.
      • Namespaces Excluded Count - View the number of namespaces excluded from certificate discovery.
      • Manage Namespace Exclusions - A list of namespaces is displayed along with their status (Excluded or Included). Select a namespace and click to update its status.
  4. Click Update or Reset to restore the previous configuration changes associated to the cluster.

Deleting a Cluster

If a user decides to limit or remove CLM actions on a specific cluster, they have the option to delete it from the inventory.

To delete a cluster:

  1. Go to menu > KUBE+ > Inventory > Cluster Inventory.
  2. Select the designated cluster, regardless of whether it is in a Managed or Unmanaged state.
  3. Click Delete on the menu bar.
    Note:

    • Deleting clusters from the inventory will not remove the in-cluster KUBE+ components. Users are required to follow the Uninstall and Clean Up steps within the cluster to complete the removal process.

    • If off-boarding policy is enabled, the cluster and its associated components will be removed from the AppViewX inventory as configured. To configure the off-boarding policy, follow the Configuring Policy Settings steps.
  4. On the Delete Cluster pop-up window, enter the comment and click Yes.

    Once you confirm that you want to delete the cluster, its status will change to "Delete in progress." Deleting a cluster from the inventory takes some time. If you attempt to delete the cluster again while the deletion is in progress, you'll receive the following error message: "Selected Clusters are recently offboard triggered."