This page describes how to install Kubernetes and App Service Monitoring using the Spectro Cloud® Palette UI. Spectro Cloud Palette is an enterprise Kubernetes® management platform that enables organizations to manage the lifecycle of Kubernetes environments across data centers and clouds.

Splunk AppDynamics provides pre-published add-on packs that can be added to a Cluster Profile. Once the Cluster Profile is applied to any new or imported clusters, Kubernetes and App Service Monitoring is automatically installed on the cluster. Unlike the traditional installation process, this alternate installation process does not require manually accessing the Kubernetes cluster or using Helm chart commands.

This document contains references to third-party documentation. Splunk AppDynamics does not own any rights and assumes no responsibility for the accuracy or completeness of such third-party documentation.

Before You Begin

Ensure that you meet the following requirements:

  • Your account is set up on Cisco Cloud Observability. See Account Administration.
  • Your account is set up on Spectro Cloud Palette.
  • You have the Cluster Profile Admin role on Spectro Cloud Palette. This role is required in order to create and modify Cluster Profiles. 
  • Depending on your use case, you also need one of the following roles: 

Hardware Requirements

The default hardware settings are:

ComponentCPUMemorySupported PlatformsPer cluster or node

Cisco AppDynamics Distribution of OpenTelemetry Collector*

200m1024MiB
  • Linux AMD64
  • Linux ARM64
  • Windows 2019
Per node (Kubernetes DaemonSet)

Splunk AppDynamics Operator

200m128MiB
  • Linux AMD64
  • Linux ARM64
Per cluster (Kubernetes Deployment)

Cisco AppDynamics Smart Agent

350m512MiB
  • Linux AMD64
  • Linux ARM64
Per cluster (Kubernetes Deployment)
Cluster Collector1000m1000MiB
  • Linux AMD64
  • Linux ARM64
  • Windows 2019
Per cluster

Cisco AppDynamics Infrastructure Collector

350m
  • 100MiB (Linux)
  • 300MiB (Windows)
  • Linux AMD64
  • Linux ARM64
  • Windows 2019
Per node (Kubernetes DaemonSet)
Log Collector

10m

150MiB
  • Linux AMD64
  • Linux ARM64
  • Windows 2019
Per node (Kubernetes DaemonSet)
Windows Exporter200m200MiB
  • Windows 2019
Per node (Kubernetes DaemonSet)

OpenTelemetry Operator for Kubernetes**

600m256MiB
  • Linux AMD64
  • Linux ARM64
Per cluster (Kubernetes Deployment)

*For throughput-specific details, see Performance and Scaling for the Cisco AppDynamics Distribution of OpenTelemetry Collector.
**OpenTelemetry Operator manager and Kube RBAC Proxy

Software Requirements

Kubernetes and App Service Monitoring is designed to run in hybrid (Linux and Windows) or Linux-only clusters. Kubernetes and App Service Monitoring requires:

Cluster Support

Linux ClusterWindows and Linux Cluster
  • Amazon Elastic Kubernetes Service  <=1.28
  • Azure Kubernetes Service <=1.28
  • Red Hat OpenShift Service on AWS (ROSA) <= 4.13.14
  • Microsoft Azure for OpenShift <= 4.13
  • Self-managed OpenShift Container Platform (OCP) 4.11
  • Rancher Kubernetes Engine (RKE) <= 1.27
  • Rancher Kubernetes Engine Government (RKE2) <= 1.29 
  • Tanzu Kubernetes Grid Integrated Edition (TKGI) <= 1.18
  • Google Kubernetes Engine (GKE) <= 1.28
  • Containerd runtime for Windows nodes
  • Windows 2019 Server for Windows nodes <= 1.23 
  • Amazon Elastic Kubernetes Service  <=1.28
  • Azure Kubernetes Service <=1.28
  • Google Kubernetes Engine (GKE) <= 1.28

Splunk AppDynamics and OpenTelemetry Operators can only run on Linux nodes.

The k8s.cluster.id attribute is required to send MELT data for Kubernetes entities. By default, Splunk AppDynamics add-on packs and Collectors attach the k8s.cluster.id attribute to data from Splunk AppDynamics sources. To send data from third-party collectors, you must enrich your data with the k8s.cluster.id attribute. The k8s.cluster.id attribute must have a value equal to the UUID of the kube-system namespace.

Install Kubernetes and App Service Monitoring Using Spectro Cloud Palette

These are the high-level steps:

  1. Obtain the Configuration Values
  2. Add the Cisco AppDynamics Add-On Packs to a Cluster Profile
    You can either create a new cluster profile or add the add-on packs to an existing cluster profile.
  3. Apply the Cluster Profile to a New or Imported Cluster

1. Obtain the Configuration Values

  1. Log into the Cisco Cloud Observability UI.
  2. Use the left-hand navigation panel to navigate to Configure > Kubernetes and APM.
  3. Under CONFIGURE DATA COLLECTORS, enter your credential set name and Kubernetes cluster name.
  4. Under ENABLE ADDITIONAL CONFIGURATIONS, check the boxes for Cluster Collector and Infrastructure Collector. Specify your operating system for each collector.
    1. (Optional) If you would like to enable Log Ingestion, check the box for Log Collector Agent and specify your operating system.
  5. Click Generate configuration file. This step generates the operators-values.yaml and collectors-values.yaml files.
  6. In the operators-values.yaml file, obtain the values for clusterName, endpoint, clientId, clientSecret, tokenUrl, and tenantId.
    You can leave this UI page open, or download the file. You'll need to provide these values later in the Spectro Cloud Palette UI.
  7. In the collectors-values.yaml file, obtain the values for clusterName, clientId, clientSecret, endpoint, and tokenUrl.
    You can leave this UI page open, or download the file. You'll need to provide these values later in the Spectro Cloud Palette UI.

2. Add the Splunk AppDynamics Add-On Packs to a Cluster Profile

Refer to the respective page for the type of Cluster Profile that you want to create in Create a Cluster Profile.

When the instructions prompt you to add a pack:

  1. Add the Cisco AppDynamics Operator pack:
    1. Click Add New Pack.
    2. Set the Registry to Palette Community Registry. In the search bar, enter Cisco AppDynamics Operator. 
    3. Under Monitoring, click Cisco AppDynamics Operator. The Configure Pack page is now displayed.
    4. Under Pack Version, use the drop-down menu to select the latest version of the pack.
    5. The values file is displayed on the right side of the page.

    6. Add the value for clusterName.

      By default, every cluster created with this Cluster Profile will have the specified name. You can also modify the clusterName field when you create the cluster.  If you are using a single Cluster Profile for multiple clusters, we recommend using a unique cluster name whenever you create a new cluster.

    7. Under appdynamics-smartagent, add the values for endpoint, clientId, clientSecret, tokenUrl, and tenantId that you obtained from the operators-values.yaml file.
    8. Click Confirm & Create.
  2. Add the Cisco AppDynamics Collector pack:
    1. Click Add New Pack.
    2. Set the Registry to Palette Community Registry. In the search bar, enter Cisco AppDynamics Collector. 
    3. Under Monitoring, click Cisco AppDynamics Collector. The Configure Pack page is now displayed.
    4. Under Pack Version, use the drop-down menu to select the latest version of the pack.
    5. The values file is displayed on the right side of the page.
    6. Add the value for clusterName. This should be the same clusterName that you entered in the Cisco AppDynamics Operator values file during step 1f. 

    7. Under appdynamics-otel-collector, add the values for clientId, clientSecret, endpoint, and tokenUrl that you obtained from the collectors-values.yaml file.

      Ensure that the oauth parameter is added under the global section. The configuration will be similar to the following:

      global:
  clusterName: <cluster-name>
  oauth:
    clientId: <client-ID>
    clientSecret: <client-secret>
    endpoint: <endpoint-URL>
    tokenUrl: <token-URL>
      CODE
    8. Click Confirm & Create.
  3. Click Save Changes.
  1. Log into the Spectro Cloud Palette console.
  2. In the left-hand navigation panel, click Profiles. Select an existing Cluster Profile.
  3. Add the Cisco AppDynamics Operator pack:
    1. Click Add New Pack.
    2. Set the Registry to Palette Community Registry. In the search bar, enter Cisco AppDynamics Operator. 
    3. Under Monitoring, click Cisco AppDynamics Operator. The Configure Pack page is now displayed.
    4. Under Pack Version, use the drop-down menu to select the latest version of the pack.
    5. The values file is displayed on the right side of the page.

    6. Add the value for clusterName.

      By default, every cluster created with this Cluster Profile will have the specified name. You can also modify the clusterName field when you create the cluster.  If you are using a single Cluster Profile for multiple clusters, we recommend using a unique cluster name whenever you create a new cluster.

    7. Under appdynamics-smartagent, add the values for endpoint, clientId, clientSecret, tokenUrl, and tenantId that you obtained from the operators-values.yaml file.
    8. Click Confirm & Create.
  4. Add the Cisco AppDynamics Collector pack:
    1. Click Add New Pack.
    2. Set the Registry to Palette Community Registry. In the search bar, enter Cisco AppDynamics Collector. 
    3. Under Monitoring, click Cisco AppDynamics Collector. The Configure Pack page is now displayed.
    4. Under Pack Version, use the drop-down menu to select the latest version of the pack.
    5. The values file is displayed on the right side of the page.
    6. Add the value for clusterName. This should be the same clusterName that you entered in the Cisco AppDynamics Operator values file during step 3f. 

    7. Under appdynamics-otel-collector, add the values for clientId, clientSecret, endpoint, and tokenUrl that you obtained from the collectors-values.yaml file.

      Ensure that the oauth parameter is added under the global section. The configuration will be similar to the following:

      global:
  clusterName: <cluster-name>
  oauth:
    clientId: <client-ID>
    clientSecret: <client-secret>
    endpoint: <endpoint-URL>
    tokenUrl: <token-URL>
      CODE
    8. Click Confirm & Create.
  5. Click Save Changes.

3. Apply the Cluster Profile to a New or Imported Cluster

Once you have added the Splunk AppDynamics add-on packs to a Cluster Profile, you can apply the Cluster Profile to a new cluster or a cluster that was imported to Spectro Cloud. Kubernetes and App Service Monitoring is installed on every cluster that is deployed with this Cluster Profile.

You are required to add a Cluster Profile when you create a new cluster. Depending on the type of public cloud cluster you have, the process to create a new cluster and apply a Cluster Profile may vary. See Public Cloud Clusters for the specific documentation for your cluster.

By default, every cluster created with this Cluster Profile will have the clusterName that you specified in the values files of the Splunk AppDynamics add-on packs. You can also modify the clusterName field when you create the cluster. If you are using a single Cluster Profile for multiple clusters, we recommend using a unique cluster name whenever you create a new cluster.

Next Steps

After you install Kubernetes and App Service Monitoring, you can monitor your Kubernetes infrastructure or configure additional monitoring tools. 

Monitor Your Kubernetes Infrastructure

  1. Log into the Cisco Cloud Observability UI.
  2. On the Observe page, navigate to the Kubernetes domain.
    This domain contains links to entity-centric pages, which are UI pages that display everything of relevance (e.g., metrics, metadata, health status, events, logs, relationships) for a given entity.
  3. Click an entity name to monitor your applications. For more information on the entities that can be monitored, see Kubernetes Entities.

Application Performance Monitoring

To monitor the applications running in your Kubernetes environment, follow the appropriate workflow from Set Up Application Performance Monitoring with Spectro Cloud Palette according to your service instrumentation status.

Log Collection

Log Collection is inactive by default. To collect logs, see Set Up Log Ingestion with Spectro Cloud Palette.

Events Collection

Kubernetes Kubernetes Events Collection is enabled by default. To disable events collection or make changes to existing events, see Configure Events Collection with Spectro Cloud Palette.

Advanced Installation and Configuration

For advanced settings, see:

All settings specified in these docs must be configured in the values files of the Splunk AppDynamics Operator and Collector add-on packs.

Uninstall Kubernetes and App Service Monitoring

Uninstall Kubernetes and App Service Monitoring with Spectro Cloud Palette.

Spectro Cloud® is a registered trademark of Spectro Cloud, Inc. Mention of Spectro Cloud products or services is for informational purposes only and constitutes neither an endorsement nor a recommendation of such products or services.

Kubernetes® is a trademark of The Linux Foundation®.