SUMMARY.md

Table of contents

• Welcome to the Docs!

Install and Configure

• Installation
  • First Time User Guide
  • Next Steps with Kubecost
  • Environment
  • Helm Parameters
  • Ingress Examples
  • Kubecost v2 Install/Upgrade
  • Provider Installations
    • Amazon EKS Integration
    • AWS Marketplace Install
    • Installing Kubecost on GKE Autopilot Clusters
    • Installing Kubecost on Alibaba
    • Installation Kubecost with Istio (Rancher)
    • Installing Kubecost with Rafay
    • Installing Kubecost with Plural
    • Installing in Air-gapped Environments
    • Install Kubecost on Red Hat OpenShift
  • Cloud Billing Integrations
    • Multi-Cloud Integrations
    • AWS Cloud Billing Integration
      • AWS Cloud Integration using IRSA/EKS Pod Identities
      • AWS Spot Instances
      • AWS Node Price Reconciliation Methodology
    • Azure Cloud Billing Integration
      • Azure Cloud Integration using Azure Workload Identity
      • Azure Rate Card Configuration
    • GCP Cloud Billing Integration
      • Creating a Google Service Account
      • Accessing Kubecost with GCP Workload Identity
      • Accessing AWS CUR Data with Google Workload Identity Federation
    • Oracle Cloud Billing Integration
  • Multi-Cluster
    • ETL Federation
      • Kubecost Aggregator
      • Migration Guide from Thanos to Kubecost v2 (Aggregator)
      • Migration Guide from Federated ETL to Kubecost v2 (Aggregator)
      • Federated ETL Backups and Alerting
    • Long-Term Storage Configuration
      • AWS Multi-Cluster Storage Configuration
      • Azure Long-Term Storage
      • GCP Long-Term Storage
      • Hitachi Content Platform (HCP) Storage Configuration
      • Storj Storage Configuration
    • Secondary Clusters Guide
    • Multi-Cluster Diagnostics
• Additional Configuration
  • Adding a Product Key
  • Enabling Annotation Emission
  • Network Cost Configuration
  • Grafana Configuration Guide
  • Parallel Install for Upgrading
  • Prometheus Configuration Guide
    • Amazon Managed Service for Prometheus
    • AWS Agentless AMP
    • AWS Distro for Open Telemetry
    • AMP with Kubecost Prometheus (remote_write)
    • Grafana Cloud Integration for Kubecost
    • Grafana Mimir Integration for Kubecost
    • Google Cloud Managed Service for Prometheus
  • User Management (SAML)
    • Microsoft Entra ID SAML Integration for Kubecost
    • Okta SAML Integration for Kubecost
  • User Management (OIDC)
    • Microsoft Entra ID OIDC Integration for Kubecost
    • Configure Keycloak Identity Provider for Kubecost
    • Gluu Server with OIDC Configuration Guide
  • Tuning Resource Consumption
  • Cluster Controller
    • Cluster Turndown
    • Kubescaler
  • Availability Tiers
  • CSV Pricing
  • Windows Node Support
  • Kubecost Data Status Metrics
  • Service Key Rotation
  • Custom SMTP Configuration
  • NVIDIA GPU Monitoring Configurations

Using Kubecost

• Navigating the Kubecost UI
  • Allocations Dashboard
    • Efficiency and Idle
    • Network Traffic Cost Allocation
  • Assets Dashboard
  • Cloud Cost Explorer
    • Cloud Cost Metrics
  • Clusters Dashboard
  • Efficiency Dashboard
  • External Costs
  • Network Monitoring
  • Collections
  • Reports
  • Alerts
  • Savings
    • Actions
    • Cluster Right-Sizing Recommendations
    • Container Request Right-Sizing Recommendations
    • Abandoned Workloads
    • Unclaimed Volumes
    • Local Disks
    • Underutilized Nodes
    • Orphaned Resources
    • Spot Checklist
    • Spot Commander
    • Persistent Volume Right-Sizing Recommendations
    • GPU Optimization
    • Turbonomic Actions
  • Budgets
  • Audits
  • Anomaly Detection
  • Teams
  • Service Accounts
• Forecasting
• Carbon Costs
• Contexts
• Kubecost Data Audit
  • AWS/Kubecost Data Audit
  • Azure/Kubecost Data Audit
  • GCP/Kubecost Data Audit
• Admission Controller
• Accessibility
• Proactive Cost Controls

APIs

• Kubecost API Directory
• Monitoring APIs
  • Allocation API
  • Allocation Trends API
  • Assets API
  • Asset Diff API
  • Cloud Cost API
  • Cloud Cost Trends API
  • External Costs API
• Collections APIs
  • List collections
  • View a collection
  • Create a new collection
  • Update an existing collection
  • Delete a collection
  • Query collection total costs
  • Query collection time series costs
  • Query collection complement costs
  • Query category total costs
  • Query category time series costs
  • Query category complement costs
• Governance APIs
  • Budget API
  • Forecast API
  • Cost Events Audit API
  • Spec Cost Prediction API
• Diagnostic APIs
  • Events API
  • Aggregator Diagnostic APIs
  • Cost-model Cache API
• Savings APIs
  • Cluster Right-Sizing Recommendation API
  • Container Request Right Sizing Recommendation API (V2)
  • Container Request Recommendation Apply/Plan APIs
  • Abandoned Workloads API
  • Turbonomic Actions APIs
• Filter Parameters (v2)

Architecture

• Kubecost Core Architecture Overview
• OpenCost Product Comparison
• Open Source
• Kubecost Metrics
• Kube-State-Metrics (KSM) Emission
• ContainerStats Pipeline
• High Availability Mode
• GPU Allocation
• Kubecost Cluster Roles
• Pricing Sources Matrix
• Calculating Node Pricing
• Ports
• Security and Data Protection
• Kubecost Release Process

Integrations

• Kubecost Postgres Integration
• Importing Kubecost Data into Microsoft Power BI
• Integrating Kubecost with Datadog
• Using Custom Webhook to Create a Kubecost Stage in Spinnaker
• Kubecost Turbonomic Integration

Troubleshooting

• Frequently Asked Questions (FAQ)
• Kubecost Glossary
• Troubleshoot Install
• HTTP Error Troubleshooting
• Kubecost Diagnostics
• Kubecost Heapdump
• Profile an HTTP Endpoint
• Repair Kubecost ETLs
• Running a Query in Kubecost-bundled Prometheus
• Creating a Kubecost Support Ticket in Slack
• Capture a Bug Report
• Bug Bounty Program
• Capture a HAR File
• Guidelines for a Successful Enterprise Support Engagement

Other Resources

• Contact Us
• Kubecost Blog
• Kubecost Release Notes