Edit me

Installing the Container Cost Kubernetes agent is required to get access to container level visibility. The way it works is by collecting metrics from the cluster and storing them into a S3 bucket on your AWS account which then is copied over to nOps.

Prerequisites
Steps to Configure nOps Kubernetes Agent
Removing Agent
Installation using Insfrastructure as Code
1. Terraform
  1. Requirements
  2. Providers
2. Usage
Frequently Asked Questions

Prerequisites

You must have an active nOps account. If you do not have one, please register on nOps
Make sure you have access to the Kubernetes cluster (recommended version v1.23.6 or later) to deploy the agent.
Helm
kubectl
Unix-like terminal to execute the installation script.
Steps to Configure nOps Kubernetes Agent
Navigate to Container Cost Tab
- Go to your Container Cost Integrations Settings.
Setup Container Cost Integration
- Click the Setup button for the desired account. Ensure you are authenticated into that account.
- This step will:
  - Create an S3 bucket in your AWS account.
  - Grant writing permissions to the agent for writing files to that bucket.
  - Use either your OIDC Identity Provider to create a service role or an IAM User with permissions to write to the S3 bucket.
  - Allow nOps to copy those files.
Configure CloudFormation Stack
- On the CloudFormation stack creation page:
  - List the regions where your clusters for that specific account are located, separated by commas (e.g., us-east-1,us-east-2,us-west-1,us-west-2).
  - (Optional) If you don’t have an IAM OIDC provider configured, you can create an IAM User to grant the agent permissions to write to the S3 bucket. To do this, set CreateIAMUser to true. If you choose this approach, you must create and store secret key credentials to replace values in the installation script.
  - Select the I acknowledge that AWS CloudFormation might create IAM resources with custom names checkbox.
  - Click the Create stack button.
Check Integration Status
- After the creation is complete, return to the nOps platform.
- Click the Check Status button to verify the integration status.
Install Agent
- Click on the Install Agent Button
- Select Options
  - Before copying the script, you have the option to enable or disable:
    - Enable Debug Mode
    - Enable IPv6
  - Check or uncheck these options based on your requirements.
- Modify the Installation Script
  - Replace the placeholder <<REPLACE-CLUSTER-ARN>> with your actual cluster ARN in the following line:
    --set nopsAgent.env_variables.APP_NOPS_K8S_AGENT_CLUSTER_ARN=<<REPLACE-CLUSTER-ARN>>
- Copy the Installation Script
  - Click the Copy Script button to copy the generated installation script.
- Add IAM User Credentials (If Applicable)
  - If you chose to use an IAM User instead of an IAM Role, you need to add the following lines to the script with your access key ID and secret access key:
    --set nopsAgent.secrets.useAwsCredentials=true \ --set nopsAgent.secrets.awsAccessKeyId=<<REPLACE-YOUR-ACCESS-KEY-ID>> \ --set nopsAgent.secrets.awsSecretAccessKey=<<REPLACE-YOUR-SECRET-ACCESS-KEY>>
- Execute the Installation Script
  - Open your Unix-like terminal.
  - Execute the modified command by pasting it into the terminal and pressing Enter. After running the script, the nOps Kubernetes agent will be installed on your cluster, allowing you to gain detailed visibility into your container costs. — After successful configuration, you’ll gain clear visibility into your workloads. While EKS costs are often unclear, nOps helps by automatically finding waste through CPU and memory metrics. This lets you optimize resources and save money quickly.
    Removing Agent
    
    To remove the agent from your cluster you just need to follow these steps:
    # Delete nops-k8s-agent release helm uninstall nops-k8s-agent --namespace nops-k8s-agent # Delete the namespaces kubectl delete namespace nops-k8s-agent kubectl delete namespace nops-cost kubectl delete namespace nops-prometheus-system

Installation using Insfrastructure as Code

Terraform

Requirements

Name	Version
terraform	>= 1.3.2

Providers

Name	Version
aws	>= 5.58
helm	>= 2.7
kubernetes	>= 2.20

Usage

Helm Release

provider "aws" {
  region = "us-east-1"
  alias  = "virginia"
}

data "aws_ecrpublic_authorization_token" "token" {
  provider = aws.virginia
}

provider "kubernetes" {
  host                   = var.cluster_endpoint # Replace it with your cluster endpoint
  cluster_ca_certificate = base64decode(var.cluster_certificate_authority_data) # Replace it with your cluster certificate authority data
  exec {
    api_version = "client.authentication.k8s.io/v1beta1"
    command     = "aws"
    # This requires the awscli to be installed locally where Terraform is executed
    args = ["eks", "get-token", "--cluster-name", var.cluster_name] # Replace it with your cluster name
  }
}

provider "helm" {
  kubernetes {
    host                   = var.cluster_endpoint # Replace it with your cluster endpoint
    cluster_ca_certificate = base64decode(var.cluster_certificate_authority_data) # Replace it with your cluster certificate authority data
    exec {
      api_version = "client.authentication.k8s.io/v1beta1"
      command     = "aws"
      # This requires the awscli to be installed locally where Terraform is executed
      args = ["eks", "get-token", "--cluster-name", var.cluster_name] # Replace it with your cluster name
    }
  }
}

### If this is the first time you install nOps agent you will need to create this namespace beforehand, if you come from previous script installation you can ommit this resource ###
resource "kubernetes_namespace" "nops_cost" {
  metadata {
    name = "nops-cost"
  }
}

### If this is the first time you install nOps agent you will need to create this namespace beforehand, if you come from previous script installation you can ommit this resource ###
resource "kubernetes_namespace" "nops_prometheus_system" {
  metadata {
    name = "nops-prometheus-system"
  }
}

resource "helm_release" "nops_container_insights" {
  name                = "nops-container-insights"
  namespace           = "nops-k8s-agent"
  create_namespace    = true
  
  repository          = "oci://public.ecr.aws/nops"
  repository_username = data.aws_ecrpublic_authorization_token.token.user_name
  repository_password = data.aws_ecrpublic_authorization_token.token.password
  chart               = "container-insights"
  version             = "0.8.46"
  
  set {
    name  = "nopsAgent.env_variables.APP_NOPS_K8S_AGENT_CLUSTER_ARN"
    value = "<your_eks_cluster_arn>"
  }

  set {
    name  = "nopsAgent.env_variables.APP_AWS_S3_BUCKET"
    value = "<your_s3_bucket_name>"
  }

  depends_on = [
    kubernetes_namespace.nops_cost,
    kubernetes_namespace.nops_prometheus_system
  ]
}

Create Addon (EKS Blueprints)

provider "aws" {
  region = "us-east-1"
  alias  = "virginia"
}

data "aws_ecrpublic_authorization_token" "token" {
  provider = aws.virginia
}

provider "kubernetes" {
  host                   = var.cluster_endpoint # Replace it with your cluster endpoint
  cluster_ca_certificate = base64decode(var.cluster_certificate_authority_data) # Replace it with your cluster certificate authority data
  exec {
    api_version = "client.authentication.k8s.io/v1beta1"
    command     = "aws"
    # This requires the awscli to be installed locally where Terraform is executed
    args = ["eks", "get-token", "--cluster-name", var.cluster_name] # Replace it with your cluster name
  }
}

provider "helm" {
  kubernetes {
    host                   = var.cluster_endpoint # Replace it with your cluster endpoint
    cluster_ca_certificate = base64decode(var.cluster_certificate_authority_data) # Replace it with your cluster certificate authority data
    exec {
      api_version = "client.authentication.k8s.io/v1beta1"
      command     = "aws"
      # This requires the awscli to be installed locally where Terraform is executed
      args = ["eks", "get-token", "--cluster-name", var.cluster_name] # Replace it with your cluster name
    }
  }
}

### If this is the first time you install nOps agent you will need to create this namespace beforehand, if you come from previous script installation you can ommit this resource ###
resource "kubernetes_namespace" "nops_cost" {
  metadata {
    name = "nops-cost"
  }
}

### If this is the first time you install nOps agent you will need to create this namespace beforehand, if you come from previous script installation you can ommit this resource ###
resource "kubernetes_namespace" "nops_prometheus_system" {
  metadata {
    name = "nops-prometheus-system"
  }
}

module "eks_blueprints_addon" {
  source = "aws-ia/eks-blueprints-addon/aws"
  version = "~> 1.0"

  chart               = "container-insights"
  chart_version       = "0.8.46"
  repository          = "oci://public.ecr.aws/nops"
  repository_username = data.aws_ecrpublic_authorization_token.token.user_name
  repository_password = data.aws_ecrpublic_authorization_token.token.password
  description         = "Helm Chart for nOps container insights"
  namespace           = "nops-k8s-agent"
  create_namespace    = true

  set = [
    {
      name  = "nopsAgent.env_variables.APP_NOPS_K8S_AGENT_CLUSTER_ARN"
      value = "<your_eks_cluster_arn>"
    },
    {
      name  = "nopsAgent.env_variables.APP_AWS_S3_BUCKET"
      value = "<your_s3_bucket_name>"
    }
  ]

  depends_on = [
    kubernetes_namespace.nops_cost,
    kubernetes_namespace.nops_prometheus_system
  ]
}

Required Parameters

The following table lists required configuration parameters for the Container Insights Helm chart and their default values.

Parameter	Description	Default
`nopsAgent.env_variables.APP_NOPS_K8S_AGENT_CLUSTER_ARN`	EKS Cluster ARN.	`-`
`nopsAgent.env_variables.APP_AWS_S3_BUCKET`	S3 Bucket name.	`-`

Optional Parameters

The following table lists the optional configuration parameters for Container Insights Helm chart and their default values.

Parameter	Description	Default
`nopsAgent.debug`	Debug mode	`false`
`opencost.loglevel`	Log level for nops-cost	`info`
`prometheus.ipv6_enabled`	Cluster uses IPV6.	`false`

Frequently Asked Questions

Will the agent installation affect my existing Prometheus setup? Answer: No, the agent installs its own Prometheus instance in a separate namespace, ensuring that it does not interfere with your current Prometheus deployments.

Tags:

Configure nOps Kubernetes Agent for Container Insights