Table of Contents

• Introduction to nOps Kubernetes Agent
• nOps Integration
• Development Requirements
  • Tilt
  • Helm
  • kubectl
  • k3d (for development)
  • make
• Development Setup

Introduction to nOps Kubernetes Agent

The nOps Kubernetes Agent (nops-k8s-agent) is essential for optimizing cloud infrastructure management. It is designed to:

• Collect metadata from Kubernetes clusters.
• Securely transfer this data to an Amazon S3 bucket.
• Support IPv6 clusters, ensuring compatibility with modern network configurations.
• Collect NVIDIA GPU metrics, enabling comprehensive monitoring and optimization for GPU-accelerated workloads.

This enables the nOps platform to:

• Analyze the collected data.
• Provide insights for cost optimization and resource management.

This document guides you through the setup and deployment process, ensuring a smooth integration with the nOps platform for enhanced operational efficiency.

nOps Integration

Check our help page to walk you through the integration.

---

Development Requirements

Before starting with the development of the nOps Kubernetes Agent, ensure you have the following tools installed and configured:

• Tilt: Automates the development cycle by updating containers in real time. Useful for rapid testing and iteration. Learn more.
• Helm: Helps manage Kubernetes applications through Helm charts. Helm charts simplify the deployment and management of applications on Kubernetes. Learn more.
• kubectl: A command-line tool for interacting with Kubernetes clusters. You will need it to deploy and manage applications, inspect cluster resources, and view logs. Ensure it's connected to a Kubernetes cluster (version v1.23.6+ recommended). Learn more.
• k3d: Simplifies running a local Kubernetes cluster within Docker containers. It's particularly handy for development purposes. Learn more.
• make: A build automation tool that automatically builds executable programs and libraries from source code by reading files called Makefiles which specify how to derive the target program.

These tools are essential for setting up your development environment and will be used throughout the setup and deployment process.

---

Development Setup

Follow these steps to set up your development environment for the nOps Kubernetes Agent:

1. Prepare the Helm Chart Values:

   • Copy the Helm chart values file from ./charts/nops-k8s-agent-dev/values.yaml to a new file named ./charts/nops-k8s-agent-dev/local_values.yaml.
   • Edit local_values.yaml to enter your specific configuration settings.

2. Set Up a Kubernetes Cluster:

   • Use any Kubernetes cluster provider of your choice. For development purposes, we recommend using k3d due to its simplicity and ease of use.
   • If using k3d, you can quickly launch a local cluster by running the following command:

     make dev_infra

   • This command initializes a local Kubernetes cluster suitable for development.

3. Deploy the Development Stack:

   • With your Kubernetes cluster running, deploy the nOps Kubernetes Agent development stack to the cluster:

     make run

   • This command deploys the necessary components, including the nOps Kubernetes Agent, into your Kubernetes cluster.

4. Verify the Deployment:

   • Ensure that all components are correctly deployed and running. You can check the status of the deployments by using:

     kubectl get pods

   • Look for pods related to the nOps Kubernetes Agent and confirm they are in the Running state.

By following these steps, you'll have a development environment set up for the nOps Kubernetes Agent. This environment will allow you to develop, test, and iterate on the agent within a local Kubernetes cluster.