Use the Cisco Cloud Observability Amazon EKS Blueprints Add-On

This page describes how to install Kubernetes and App Service Monitoring using Helm charts and the Cisco Cloud Observability Amazon Elastic Container Service (EKS) Blueprints add-on.

The Amazon EKS Blueprints for Terraform project is an open-source framework implemented in Terraform that enables platform administrators to easily configure and manage their Amazon EKS clusters. The EKS Blueprints add-on framework supports this alternate installation method for Kubernetes and App Service Monitoring, which is partially automated using Terraform.

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

Before installing the Kubernetes and App Service Monitoring solution, ensure that you meet the following requirements:

• Your account is set up on Cisco Cloud Observability. See Account Administration.
• You are connected to the cluster that you want to monitor.
• You have administrator privileges on the monitored cluster to run the Helm chart commands.

Hardware Requirements

The default hardware settings are:

_{*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:

• Helm >= 3.8.0.

• Sufficient licenses. See License Management.

• OpenTelemetry Agent versions that are supported by Cisco Cloud Observability.

• Access to Dockerhub to pull the Splunk AppDynamics Operator and Collector images for the Kubernetes and App Service Monitoring:

Cluster Support

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

The k8s.cluster.id attribute is required to send MELT data for Kubernetes entities. By default, Splunk AppDynamics Helm charts 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.

In addition, for the Log Collector ensure your environment meets the Log Collector Requirements.

Required Deployment Tools

The following deployment tools are required for this installation method:

Install Kubernetes and App Service Monitoring Using the Cisco Cloud Observability Add-On for Amazon EKS Blueprints 

These are the high-level steps:

1. Get the Code
2. Generate and Download Operators and Collectors Files
3. Verify Your Connection to AWS and the EKS Cluster
4. Prepare the Terraform Configuration for Your Environment
5. Deploy the Cisco Cloud Observability Add-On for Amazon EKS Blueprints

1. Get the Code

Clone the Cisco Cloud Observability Add-On for Amazon EKS Blueprints project from the Cisco DevNet repository on GitHub:

$ cd ~
$ git clone https://github.com/CiscoDevNet/appdynamics-eks-blueprints-addon.git
$ cd appdynamics-eks-blueprints-addon

2. Generate and Download Operators and Collectors Files

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.

   

   For the Kubernetes cluster name, we recommend using the actual name of your EKS cluster to make it easy to identity your deployment. You can also use your EKS cluster name for the Credential set name.

4. Under ENABLE ADDITIONAL CONFIGURATIONS, check the boxes for Cluster Collector, Infrastructure Collector, and Log Collector Agent. Specify your operating system for each collector.
5. Click Generate configuration file. This step generates the operators-values.yaml and collectors-values.yaml files. Download both files.
6. Click Done.

7. Copy the operators-values.yaml and collectors-values.yaml files to the add-on project home directory for Terraform. If you downloaded these files to a different directory than ~/Downloads., adjust the command as needed.

   $ cd ~/appdynamics-eks-blueprints-addon/examples/addon/
   $ cp ~/Downloads/operators-values.yaml .
   $ cp ~/Downloads/collectors-values.yaml .

   CODE

3. Verify Your Connection to AWS and the EKS Cluster

1. Set the AWS environment variables:

   $ export AWS_REGION=<your_aws_region>
   $ export AWS_EKS_CLUSTER=<your_aws_eks_cluster_name>

   CODE

2. Invoke the Security Token Service (STS) to verify access to your AWS account via the AWS CLI:

   $ aws sts get-caller-identity

   CODE

   Sample output:

   {
       "UserId": "ABCDEFGHIJKLMNOPQRSTU",
       "Account": "012345678901",
       "Arn": "arn:aws:iam::012345678901:user/some.user"
   }

   CODE

3. Retrieve the AWS EKS kubeconfig and verify access to the EKS cluster:

   $ aws eks --region $AWS_REGION update-kubeconfig --name $AWS_EKS_CLUSTER
   $ kubectl config current-context
   $ kubectl get nodes -o wide

   CODE

   The output should display the updated context, current context, names of the EKS cluster nodes, status, Kubernetes version, internal and external IP addresses, and OS image.

4. Prepare the Terraform Configuration for Your Environment

Before you can execute the Terraform commands and deploy the Cisco Cloud Observability Helm Charts, you'll need to override some custom Terraform variables related to your Cisco Cloud Observability Tenant and EKS cluster by generating a custom terraform.tfvars file. The terraform.tfvars file is used to override default Terraform variables at runtime.

To streamline this process, you can use a Cisco Cloud Observability script to extract key values from the downloaded operators-values.yaml and collectors-values.yaml files. These key values contain information specific to your tenant, such as operator and collector endpoints, client secret, tenant ID, and token URL.

To verify that all the files are in the correct place:

1. Run the following command from the add-on project home directory for Terraform. Use the output to verify that the operators-values.yaml and collectors-values.yaml files are in the current directory.

   $ cd ~/appdynamics-eks-blueprints-addon/examples/addon/
   $ ls -alF

   CODE

2. From the current directory, run the following script:

   $ ../../bin/extract_cnao_config_values_for_terraform.sh

   CODE

   Example output:

   Begin processing Helm Chart files...
   Extracting Cisco Cloud Observability configuration values...
   Substituting EKS Cluster name variable...
   Substituting Helm Chart variables...
   Removing temporary backup file...
   Cisco Cloud Observability configuration values extraction complete.

   CODE

3. Examine the terraform.tfvars file:

   $ cat terraform.tfvars

   CODE

   You should see that the EKS cluster name and Helm chart variables are now uncommented and populated with the correct data.

5. Deploy the Cisco Cloud Observability Add-On for Amazon EKS Blueprints

1. From the current directory, run the following Terraform lifecycle commands in sequential order:

   $ terraform --version
   $ terraform init
   $ terraform validate
   $ terraform plan -out terraform-addon.tfplan
   $ terraform apply terraform-addon.tfplan

   CODE

2. In the Terraform output from the apply operation, verify that:

   1. The cco-operators were created.

   2. The cco-collectors were created.

   3. The Terraform apply operation was completed successfully.
      
      

Next Steps

Observe Your EKS Cluster

Once Kubernetes and App Service Monitoring is installed, Cisco Cloud Observability populates the Observe page with an entity-centric page that enables you to observe your EKS cluster. For more information on UI elements, see Observe UI Overview.

To observe your EKS cluster:

1. Log into the Cisco Cloud Observability UI.
2. On the Observe page, navigate to the Kubernetes domain. Click Clusters.

3. In the Filter View box, enter the following string:

   EntityStatus = 'active' && attributes(k8s.cluster.name) = '<your_EKS_cluster_name>'

   CODE
4. Click Apply.
5. From the filtered list of clusters, click your EKS cluster name.

Uninstall the Cisco Cloud Observability Add-On for Amazon EKS Blueprints

From the current directory, run the following Terraform lifecycle commands in sequential order:

$ cd ~/appdynamics-eks-blueprints-addon/examples/addon/
$ terraform destroy -auto-approve

Third party names, logos, marks, and general references used in these materials are the property of their respective owners or their affiliates in the United States and/or other countries. Inclusion of such references are for informational purposes only and are not intended to promote or otherwise suggest a relationship between Splunk AppDynamics and the third party.