From 467fd43ac727af041917150c8a79e242563a10a8 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Fri, 19 Sep 2025 13:29:41 +0530 Subject: [PATCH 01/34] added a file --- docs/user-guide/cost-visibility.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/user-guide/cost-visibility.md diff --git a/docs/user-guide/cost-visibility.md b/docs/user-guide/cost-visibility.md new file mode 100644 index 000000000..e69de29bb From 8b5a275aef83673b6d462c791ff1554d2b44048c Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Sun, 21 Sep 2025 18:09:03 +0530 Subject: [PATCH 02/34] docs: intr added --- docs/user-guide/cost-visibility.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/user-guide/cost-visibility.md b/docs/user-guide/cost-visibility.md index e69de29bb..c65689c28 100644 --- a/docs/user-guide/cost-visibility.md +++ b/docs/user-guide/cost-visibility.md @@ -0,0 +1,12 @@ +# Cost Visibility +## Introduction + +In Devtron, Cost Visibility helps you understand your infrastructure spends. Instead of only using your cloud provider billing dashboards, you can see costs directly within Devtron, broken down by **Applications**, **Clusters**, **Environments**, **Projects**, **Infra Components**. + +It tracks spend on **CPU**, **Memory**, **Storage**, **GPU**, **network**, and highlights efficiency along with potential savings. You can view costs in multiple currencies, select daily, monthly, or custom ranges, and navigate from overall spend to specific cost breakdowns. + +## Overview + +The **Overview** page provides a summary of infrastructure costs across your Applications, Clusters, Environments, Projects, and Infra Components in Devtron. It highlights overall spend, resource-level distribution, and opportunities for optimization (Potential Savings). + + From dbf0514e756033732c4f78fe26cc9773c4a8997b Mon Sep 17 00:00:00 2001 From: Arpit Agrawal Date: Wed, 24 Sep 2025 17:04:39 +0530 Subject: [PATCH 03/34] test test --- docs/user-guide/cost-visibility.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/cost-visibility.md b/docs/user-guide/cost-visibility.md index c65689c28..3b8cf0ffc 100644 --- a/docs/user-guide/cost-visibility.md +++ b/docs/user-guide/cost-visibility.md @@ -7,6 +7,8 @@ It tracks spend on **CPU**, **Memory**, **Storage**, **GPU**, **network**, and h ## Overview -The **Overview** page provides a summary of infrastructure costs across your Applications, Clusters, Environments, Projects, and Infra Components in Devtron. It highlights overall spend, resource-level distribution, and opportunities for optimization (Potential Savings). +The **Overview** page provides a summary of infrastructure costs across your Applications, Clusters, Environments, Projects, and Infra Components in Devtron. It highlights overall spend, resource-level distribution, and opportunities for optimization (Potential Savings). + +#test From d4b130a147d91136781fa1095cfe7d4516c38681 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Wed, 24 Sep 2025 17:07:11 +0530 Subject: [PATCH 04/34] docs: test-reversed --- docs/user-guide/cost-visibility.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/user-guide/cost-visibility.md b/docs/user-guide/cost-visibility.md index 3b8cf0ffc..39eaf4ec9 100644 --- a/docs/user-guide/cost-visibility.md +++ b/docs/user-guide/cost-visibility.md @@ -8,7 +8,3 @@ It tracks spend on **CPU**, **Memory**, **Storage**, **GPU**, **network**, and h ## Overview The **Overview** page provides a summary of infrastructure costs across your Applications, Clusters, Environments, Projects, and Infra Components in Devtron. It highlights overall spend, resource-level distribution, and opportunities for optimization (Potential Savings). - -#test - - From c732a94b5aac98117e7b42b6699ef57064814f4d Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 25 Sep 2025 16:26:50 +0530 Subject: [PATCH 05/34] docs: mid commit --- docs/user-guide/cost-visibility.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/cost-visibility.md b/docs/user-guide/cost-visibility.md index 39eaf4ec9..83b444739 100644 --- a/docs/user-guide/cost-visibility.md +++ b/docs/user-guide/cost-visibility.md @@ -7,4 +7,22 @@ It tracks spend on **CPU**, **Memory**, **Storage**, **GPU**, **network**, and h ## Overview -The **Overview** page provides a summary of infrastructure costs across your Applications, Clusters, Environments, Projects, and Infra Components in Devtron. It highlights overall spend, resource-level distribution, and opportunities for optimization (Potential Savings). +The **Overview** page provides a summary of infrastructure costs across your Applications, Clusters, Environments, Projects, and Infra Components in Devtron. It highlights overall spend, resource-level distribution, and opportunities for optimization (Potential Savings). + +At the top, you can choose your preferred currency time and time duration to set the context for your usage costs. This makes sure all costs on the **Overview** page are displayed in the correct currency and time range. + + + +## At a Glance + +The **At a Glance** summarizes the total cost for the selected period and breaks it down by resource type. Each card shows the cost, its share of the total, and a usage trend graph. + +|Card|Description| +|:---|:---| +||| +||| +||| +||| +||| + + \ No newline at end of file From ec2c919f96cbfaf6aca39b8234f745439f63c47f Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Fri, 26 Sep 2025 14:49:29 +0530 Subject: [PATCH 06/34] docs: overview page fixes --- docs/user-guide/cost-visibility.md | 110 ++++++++++++++++++++++++++--- 1 file changed, 101 insertions(+), 9 deletions(-) diff --git a/docs/user-guide/cost-visibility.md b/docs/user-guide/cost-visibility.md index 83b444739..2d7badb39 100644 --- a/docs/user-guide/cost-visibility.md +++ b/docs/user-guide/cost-visibility.md @@ -17,12 +17,104 @@ At the top, you can choose your preferred currency time and time duration to set The **At a Glance** summarizes the total cost for the selected period and breaks it down by resource type. Each card shows the cost, its share of the total, and a usage trend graph. -|Card|Description| -|:---|:---| -||| -||| -||| -||| -||| - - \ No newline at end of file +| Card | Description | +|:---------------- |:------------------------------------------------------------------------------------------------ | +| **Total Cost** | Shows the overall infrastructure cost for the selected time period, and the cost-trend graph for the selected period of time | +| **CPU Cost** | Shows the cost of CPU resources, their percentage contribution to the total cost, and the cost-trend graph for the selected period of time | +| **RAM Cost** | Shows the cost of memory resources, their percentage contribution to the total cost, and the cost-trend graph for the selected period of time | +| **PV Cost** | Shows the cost of persistent volume (storage), its percentage contribution to the total cost, and the cost-trend graph for the selected period of time | +| **GPU Cost** | Shows the cost of GPU resources, their percentage contribution to the total cost, and the cost-trend graph for the selected period of time | +| **Network Cost** | Shows the cost of network usage, its percentage contribution to the total cost, and the cost-trend graph for the selected period of time | + + + +## Potential Savings + +The Potential Savings section estimates how much cost can be reduced by comparing the resources you have provisioned with the resources you have actually used. It also shows the percentage of current spend that could be saved. + +| Field | Description | +|:---------------------- |:------------------------------------------------------------------------------------------------ | +| **Recommended Cost** | The estimated cost calculated from actual resource usage instead of allocated capacity | +| **Potential Savings** | The percentage of your current spend that could be reduced | +| **Monthly Savings** | The estimated savings for one month based on the difference between allocated and used resources | +| **Annual Savings** | The projected savings over a year based on the same calculation | + + + +## Track Performance + +The Track Performance section helps you understand costs in more detail by breaking them down across different views and time ranges. It includes two charts, **Cost Breakdown** and **Cost Trend**. + +### Cost Breakdown + +The Cost Breakdown chart helps you see how costs are distributed across different infrastructure components for the selected time period. + +Each bar represents one Application, Cluster, Environment, or Project, and the colored segments in the bar show the share of different resource types. This makes it easy to compare categories and see which resources are contributing most to their total cost. + +| Resource Type | Color Used in Chart | +|:--------------|:---------------------| +| **CPU Cost** | Light Green | +| **Memory Cost** | Blue | +| **Storage (PV) Cost** | Violet | +| **GPU Cost** | Dark Green | +| **Network Cost** | Orange | + +#### Filters + +| Filters | What It Shows | +|:-----------------|:--------------| +| **Application** | Each bar represents an application, segmented by CPU, Memory, Storage (PV), GPU, and Network costs. | +| **Cluster** | Each bar represents a cluster, segmented by CPU, Memory, Storage (PV), GPU, and Network costs. | +| **Environment** | Each bar represents an environment, segmented by CPU, Memory, Storage (PV), GPU, and Network costs. | +| **Project** | Each bar represents a project, segmented by CPU, Memory, Storage (PV), GPU, and Network costs. | + +#### Sorting Criteria + +| Sorting Option | Description | +|:-------------------|:------------| +| **Cost: High to Low** | Shows the highest cost items first. | +| **Cost: Low to High** | Shows the lowest cost items first. | +| **A to Z** | Sorts items alphabetically. | +| **Z to A** | Sorts items in reverse alphabetical order. | + +### Cost Trend + +The Cost Trend chart helps you understand, how your resource usage costs change over time, broken down by the selected category, Applications, Clusters, Environments, or Infrastructure Resources. + +Each bar represents the total cost for a specific time period (week, month, quarter, or year). + +Within the bar, each colored segment shows the contribution of the selected category (Applications, Clusters, Environments, or Infrastructure Resources). This makes it easier to inspect both the overall cost usage and the relative share of each category over the selected time range. + +#### Time Range + +| Option | What It Shows | +|:-----------|:--------------| +| **Week** | Breaks down costs for each week | +| **Month** | Aggregates costs by month | +| **Quarter**| Groups costs into calendar quarters (Q1, Q2, etc.) | +| **Year** | Shows yearly cost trends, useful for long-term analysis | + + + +#### Stack By + +| Option | What Each Segment Represents | +|:----------------------|:------------------------------| +| **Applications** | Cost share of each application in the selected time range | +| **Clusters** | Cost share of each cluster in the selected time range | +| **Environments** | Cost share of each environment (e.g., dev, staging, prod) | +| **Infrastructure Resources** | Cost share of CPU, Memory, Storage (PV), GPU, and Network, in the selected time range | + +## Actions and Insights + +The Actions & Insights section highlights where you can achieve the highest cost savings. It shows the categories with the largest cost saving opportunities, based on the difference between allocated resources and your actual usage. + +Each category will show + +| Field | Description | +|:-----------------------|:------------| +| **Name** | The name of the category (for example, a cluster, application, or environment) with the largest savings opportunities. | +| **Potential Savings (%)** | The percentage of your current spend that could be reduced, for the selected time range. | +| **Estimated Savings** | The estimated cost you could save in that category, based on the difference between provisioned and used resources, for the selected time range.| + +Clicking on any item in this list takes you to its detailed Cost Breakdown page. Refer [Cost Breakdown]() to learn more. \ No newline at end of file From c7e980d89f1fc0987ac570cad78b433834bbe8d6 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Fri, 26 Sep 2025 22:37:40 +0530 Subject: [PATCH 07/34] docs: added cost breakdown --- docs/user-guide/cost-visibility.md | 63 ++++++++++++++++++++++++------ 1 file changed, 50 insertions(+), 13 deletions(-) diff --git a/docs/user-guide/cost-visibility.md b/docs/user-guide/cost-visibility.md index 2d7badb39..e8dc1e903 100644 --- a/docs/user-guide/cost-visibility.md +++ b/docs/user-guide/cost-visibility.md @@ -30,12 +30,12 @@ The **At a Glance** summarizes the total cost for the selected period and breaks ## Potential Savings -The Potential Savings section estimates how much cost can be reduced by comparing the resources you have provisioned with the resources you have actually used. It also shows the percentage of current spend that could be saved. +The Potential Savings section estimates how much cost can be saved by comparing the resources you have provisioned with the resources you have actually used. It also shows the percentage of current spend that could be saved. | Field | Description | |:---------------------- |:------------------------------------------------------------------------------------------------ | | **Recommended Cost** | The estimated cost calculated from actual resource usage instead of allocated capacity | -| **Potential Savings** | The percentage of your current spend that could be reduced | +| **Potential Savings** | The percentage of your current spend that could be saved, for the selected time period | | **Monthly Savings** | The estimated savings for one month based on the difference between allocated and used resources | | **Annual Savings** | The projected savings over a year based on the same calculation | @@ -45,19 +45,19 @@ The Potential Savings section estimates how much cost can be reduced by comparin The Track Performance section helps you understand costs in more detail by breaking them down across different views and time ranges. It includes two charts, **Cost Breakdown** and **Cost Trend**. -### Cost Breakdown +### Cost Breakdown Graph The Cost Breakdown chart helps you see how costs are distributed across different infrastructure components for the selected time period. Each bar represents one Application, Cluster, Environment, or Project, and the colored segments in the bar show the share of different resource types. This makes it easy to compare categories and see which resources are contributing most to their total cost. -| Resource Type | Color Used in Chart | -|:--------------|:---------------------| -| **CPU Cost** | Light Green | -| **Memory Cost** | Blue | -| **Storage (PV) Cost** | Violet | -| **GPU Cost** | Dark Green | -| **Network Cost** | Orange | +| Resource Type | Color Used in Chart | +|:--------------------- |:---------------------| +| **CPU Cost** | Light Green | +| **Memory Cost** | Blue | +| **Storage (PV) Cost** | Violet | +| **GPU Cost** | Dark Green | +| **Network Cost** | Orange | #### Filters @@ -77,7 +77,7 @@ Each bar represents one Application, Cluster, Environment, or Project, and the c | **A to Z** | Sorts items alphabetically. | | **Z to A** | Sorts items in reverse alphabetical order. | -### Cost Trend +### Cost Trend Graph The Cost Trend chart helps you understand, how your resource usage costs change over time, broken down by the selected category, Applications, Clusters, Environments, or Infrastructure Resources. @@ -114,7 +114,44 @@ Each category will show | Field | Description | |:-----------------------|:------------| | **Name** | The name of the category (for example, a cluster, application, or environment) with the largest savings opportunities. | -| **Potential Savings (%)** | The percentage of your current spend that could be reduced, for the selected time range. | +| **Potential Savings (%)** | The percentage of your current spend that could be saved, for the selected time range. | | **Estimated Savings** | The estimated cost you could save in that category, based on the difference between provisioned and used resources, for the selected time range.| -Clicking on any item in this list takes you to its detailed Cost Breakdown page. Refer [Cost Breakdown]() to learn more. \ No newline at end of file +Clicking on any item in this list takes you to its detailed Cost Breakdown page. Refer [Cost Breakdown]() to learn more. + +## Cost Breakdown + +The Cost Breakdown page helps you analyze costs within a selected category, **Clusters**, **Applications**, **Environments**, or **Projects**. + +For the chosen category type, it shows the following: + +| Field | Description | +|:--------------------------- |:----------------------------------------------------------------------------| +| **Total Cost** | The actual spend for the selected category type (e.g., all clusters). | +| **Recommended Cost** | The estimated cost calculated from actual resource usage instead of allocated capacity| +| **Potential Savings** | The percentage of your current spend that could be reduced| +| **Monthly Savings** | The estimated savings for one month based on the difference between allocated and used resources | +| **Annual Savings** | The projected savings over a year based on the same calculation| +| **Top 10 Costly Resources** | A ranked list of 10 highest cost resources of the selected category.| + + + +You will also find a complete list of all the resources for the selected category at the bottom. +Each row in the list shows the following for the specific resource of the selected category: + +| **Field** | **Available in Categories** | **Description** | +|------------------------|---------------------------------|-------------------------------------------------------------------- | +| **Provider** | Clusters | Shows the cloud provider or infrastructure source for each cluster | +| **Type** | Clusters, Environments | Shows whether each cluster or environment is **Production** or **Non-Production** | +| **Applications Count** | Environments, Projects | Shows the number of applications linked to each environment or project. | +| **Environments** | Applications | Shows the number of environments where each application is deployed. | +| **Memory Cost** | All categories | Shows the cost of memory usage for each resource in the selected category. | +| **CPU Cost** | All categories | Shows the cost of CPU usage for each resource in the selected category. | +| **Storage (PV) Cost** | All categories | Shows the cost of persistent volume (storage) usage for each resource in the selected category. | +| **GPU Cost** | All categories | Shows the cost of GPU usage for each resource in the selected category. | +| **Network Cost** | All categories | Shows the cost of network usage for each resource in the selected category. | +| **Total Cost** | All categories | Shows the total cost of each resource. | +| **Potential Savings** | All categories | Shows the cost and percentage of your current spend that could be saved for each resource | + + + From a627374eacd35d8a15f9ffdb1cae18e2defdc6bc Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Fri, 26 Sep 2025 22:56:33 +0530 Subject: [PATCH 08/34] docs: fixes --- docs/user-guide/cost-visibility.md | 48 +++++++++++++++--------------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/user-guide/cost-visibility.md b/docs/user-guide/cost-visibility.md index e8dc1e903..74a3933ee 100644 --- a/docs/user-guide/cost-visibility.md +++ b/docs/user-guide/cost-visibility.md @@ -63,19 +63,19 @@ Each bar represents one Application, Cluster, Environment, or Project, and the c | Filters | What It Shows | |:-----------------|:--------------| -| **Application** | Each bar represents an application, segmented by CPU, Memory, Storage (PV), GPU, and Network costs. | -| **Cluster** | Each bar represents a cluster, segmented by CPU, Memory, Storage (PV), GPU, and Network costs. | -| **Environment** | Each bar represents an environment, segmented by CPU, Memory, Storage (PV), GPU, and Network costs. | -| **Project** | Each bar represents a project, segmented by CPU, Memory, Storage (PV), GPU, and Network costs. | +| **Application** | Each bar represents an application, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | +| **Cluster** | Each bar represents a cluster, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | +| **Environment** | Each bar represents an environment, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | +| **Project** | Each bar represents a project, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | #### Sorting Criteria | Sorting Option | Description | |:-------------------|:------------| -| **Cost: High to Low** | Shows the highest cost items first. | -| **Cost: Low to High** | Shows the lowest cost items first. | -| **A to Z** | Sorts items alphabetically. | -| **Z to A** | Sorts items in reverse alphabetical order. | +| **Cost: High to Low** | Shows the highest cost items first | +| **Cost: Low to High** | Shows the lowest cost items first | +| **A to Z** | Sorts items alphabetically | +| **Z to A** | Sorts items in reverse alphabetical order | ### Cost Trend Graph @@ -87,7 +87,7 @@ Within the bar, each colored segment shows the contribution of the selected cate #### Time Range -| Option | What It Shows | +| Options | Description | |:-----------|:--------------| | **Week** | Breaks down costs for each week | | **Month** | Aggregates costs by month | @@ -98,7 +98,7 @@ Within the bar, each colored segment shows the contribution of the selected cate #### Stack By -| Option | What Each Segment Represents | +| Options | Description | |:----------------------|:------------------------------| | **Applications** | Cost share of each application in the selected time range | | **Clusters** | Cost share of each cluster in the selected time range | @@ -113,9 +113,9 @@ Each category will show | Field | Description | |:-----------------------|:------------| -| **Name** | The name of the category (for example, a cluster, application, or environment) with the largest savings opportunities. | -| **Potential Savings (%)** | The percentage of your current spend that could be saved, for the selected time range. | -| **Estimated Savings** | The estimated cost you could save in that category, based on the difference between provisioned and used resources, for the selected time range.| +| **Name** | The name of the category (for example, a cluster, application, or environment) with the largest savings opportunities | +| **Potential Savings (%)** | The percentage of your current spend that could be saved, for the selected time range | +| **Estimated Savings** | The estimated cost you could save in that category, based on the difference between provisioned and used resources, for the selected time range| Clicking on any item in this list takes you to its detailed Cost Breakdown page. Refer [Cost Breakdown]() to learn more. @@ -132,25 +132,25 @@ For the chosen category type, it shows the following: | **Potential Savings** | The percentage of your current spend that could be reduced| | **Monthly Savings** | The estimated savings for one month based on the difference between allocated and used resources | | **Annual Savings** | The projected savings over a year based on the same calculation| -| **Top 10 Costly Resources** | A ranked list of 10 highest cost resources of the selected category.| +| **Top 10 Costly Resources** | A ranked list of 10 highest cost resources of the selected category| You will also find a complete list of all the resources for the selected category at the bottom. Each row in the list shows the following for the specific resource of the selected category: -| **Field** | **Available in Categories** | **Description** | -|------------------------|---------------------------------|-------------------------------------------------------------------- | +| Field | Available in Categories | Description | +|:------------------------|:---------------------------------|:-------------------------------------------------------------------- | | **Provider** | Clusters | Shows the cloud provider or infrastructure source for each cluster | | **Type** | Clusters, Environments | Shows whether each cluster or environment is **Production** or **Non-Production** | -| **Applications Count** | Environments, Projects | Shows the number of applications linked to each environment or project. | -| **Environments** | Applications | Shows the number of environments where each application is deployed. | -| **Memory Cost** | All categories | Shows the cost of memory usage for each resource in the selected category. | -| **CPU Cost** | All categories | Shows the cost of CPU usage for each resource in the selected category. | -| **Storage (PV) Cost** | All categories | Shows the cost of persistent volume (storage) usage for each resource in the selected category. | -| **GPU Cost** | All categories | Shows the cost of GPU usage for each resource in the selected category. | -| **Network Cost** | All categories | Shows the cost of network usage for each resource in the selected category. | -| **Total Cost** | All categories | Shows the total cost of each resource. | +| **Applications Count** | Environments, Projects | Shows the number of applications linked to each environment or project | +| **Environments** | Applications | Shows the number of environments where each application is deployed | +| **Memory Cost** | All categories | Shows the cost of memory usage for each resource in the selected category | +| **CPU Cost** | All categories | Shows the cost of CPU usage for each resource in the selected category | +| **Storage (PV) Cost** | All categories | Shows the cost of persistent volume (storage) usage for each resource in the selected category | +| **GPU Cost** | All categories | Shows the cost of GPU usage for each resource in the selected category | +| **Network Cost** | All categories | Shows the cost of network usage for each resource in the selected category | +| **Total Cost** | All categories | Shows the total cost of each resource | | **Potential Savings** | All categories | Shows the cost and percentage of your current spend that could be saved for each resource | From ff333d3866ad53cdf3245cb349564b0720e62ed2 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Mon, 29 Sep 2025 15:48:47 +0530 Subject: [PATCH 09/34] docs: structure changed --- docs/user-guide/cost-visibility/README.md | 6 ++ .../cost-visibility/configurations.md | 0 .../cost-visibility/cost-breakdown.md | 64 +++++++++++++++++++ .../overview-cost-visibility.md} | 46 +------------ 4 files changed, 72 insertions(+), 44 deletions(-) create mode 100644 docs/user-guide/cost-visibility/README.md create mode 100644 docs/user-guide/cost-visibility/configurations.md create mode 100644 docs/user-guide/cost-visibility/cost-breakdown.md rename docs/user-guide/{cost-visibility.md => cost-visibility/overview-cost-visibility.md} (66%) diff --git a/docs/user-guide/cost-visibility/README.md b/docs/user-guide/cost-visibility/README.md new file mode 100644 index 000000000..0e834eee1 --- /dev/null +++ b/docs/user-guide/cost-visibility/README.md @@ -0,0 +1,6 @@ +# Cost Visibility +## Introduction + +In Devtron, Cost Visibility helps you understand your infrastructure spends. Instead of only using your cloud provider billing dashboards, you can see costs directly within Devtron, broken down by **Applications**, **Clusters**, **Environments**, **Projects**, **Infra Components**. + +It tracks spend on **CPU**, **Memory**, **Storage**, **GPU**, **network**, and highlights efficiency along with potential savings. You can view costs in multiple currencies, select daily, monthly, or custom ranges, and navigate from overall spend to specific cost breakdowns. \ No newline at end of file diff --git a/docs/user-guide/cost-visibility/configurations.md b/docs/user-guide/cost-visibility/configurations.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/user-guide/cost-visibility/cost-breakdown.md b/docs/user-guide/cost-visibility/cost-breakdown.md new file mode 100644 index 000000000..cdf2042f8 --- /dev/null +++ b/docs/user-guide/cost-visibility/cost-breakdown.md @@ -0,0 +1,64 @@ +# Cost Breakdown + +The Cost Breakdown page helps you analyze costs within a selected category (**Clusters**, **Applications**, **Environments**, or **Projects**), for a specific time range. + +At the top of the **Cost Breakdown** page, you can apply filters in the top-right corner to adjust the view. + +| Filter | Description | +|------------------|-----------------------------------------------------------------------------| +| **Cluster Scope** | Choose whether to view costs across all clusters or environments, or limit the view to only production or non-production clusters or environments | +| **Currency** | Displays all cost values in the currency of your choice. | +| **Time Range** | Defines the time range for data displayed | + + +For the chosen category type, it shows the following: + +| Field | Description | +|:--------------------------- |:----------------------------------------------------------------------------| +| **Total Cost** | The actual spend for the selected category type (e.g., all clusters). | +| **Recommended Cost** | The estimated cost calculated from actual resource usage instead of allocated capacity| +| **Potential Savings** | The percentage of your current spend that could be reduced| +| **Monthly Savings** | The estimated savings for one month based on the difference between allocated and used resources | +| **Annual Savings** | The projected savings over a year based on the same calculation| +| **Top 10 Costly Resources** | A ranked list of 10 highest cost resources of the selected category| + + + +You will also find a complete list of all the resources for the selected category at the bottom. +Each row in the list shows the following for the specific resource of the selected category: + +| Field | Available For Categories | Description | +|:------------------------|:---------------------------------|:-------------------------------------------------------------------- | +| **Provider** | Clusters | Shows the cloud provider or infrastructure source for each cluster | +| **Type** | Clusters, Environments | Shows whether each cluster or environment is **Production** or **Non-Production** | +| **Applications Count** | Environments, Projects | Shows the number of applications linked to each environment or project | +| **Environments** | Applications | Shows the number of environments where each application is deployed | +| **Memory Cost** | All categories | Shows the cost of memory usage for each resource in the selected category | +| **CPU Cost** | All categories | Shows the cost of CPU usage for each resource in the selected category | +| **Storage (PV) Cost** | All categories | Shows the cost of persistent volume (storage) usage for each resource in the selected category | +| **GPU Cost** | All categories | Shows the cost of GPU usage for each resource in the selected category | +| **Network Cost** | All categories | Shows the cost of network usage for each resource in the selected category | +| **Total Cost** | All categories | Shows the total cost of each resource | +| **Potential Savings** | All categories | Shows the cost and percentage of your current spend that could be saved for each resource | + + + + +Clicking on any resource in the Cost Breakdown list opens its detailed cost breakdown view. Based on the category you will see the following + +| Field |Available For Categories | Description | +|:-----------------|:-------------|:----| +| **Total Cost** | All categories | Shows the overall cost for the selected resource, along with a cost trend graph for the chosen time range | +| **CPU** | All categories | Shows the total spend on CPU resources, along with the potential savings | +| **Memory** | All categories | Shows the total cost for memory resources, along with the potential savings | +| **Storage**| All categories | Shows the total cost for persistent volume (storage), along with potential savings | +| **GPU** | All categories | Shows the total cost for GPU resources, along with potential savings | +|**Top 10 costly namespace**|Cluster| A ranked list of 10 highest cost namespaces within a specific cluster| +|**Top 10 costly application**|Environments & Projects|A ranked list of 10 highest cost application within a specific environment or project| +|**Top 10 costly deployment**|Applications|A ranked list of 10 highest cost deployments within a specific application| +|**Cost Breakdown by Namespace**|Clusters|Shows the distribution of costs across namespaces within the selected cluster.
  • Each bar represents a namespace, segmented by CPU, Memory, GPU, Storage, and Network costs
  • Helps identify which namespaces are responsible for most cost inside a cluster
| +|**Cost Breakdown by Application**|Clusters, Projects, & Environments|Shows the cost distribution across applications in the selected category
  • Each bar represents an application, segmented by CPU, Memory, GPU, Storage, and Network costs
| +|**Cost Breakdown by Resource kind**|All categories|Shows the costs broken down by Kubernetes resource types (e.g., Pod, Deployment, StatefulSet, Job, DaemonSet, Rollout, Container).
  • Each bar represents a resource kind, segmented by CPU, Memory, GPU, Storage, and Network costs
| +|**Cost Breakdown by Deployment**|Applications|Shows the distribution of costs across deployments within the selected application
  • Each bar represents a deployment, segmented by CPU, Memory, GPU, Storage, and Network costs
| + + \ No newline at end of file diff --git a/docs/user-guide/cost-visibility.md b/docs/user-guide/cost-visibility/overview-cost-visibility.md similarity index 66% rename from docs/user-guide/cost-visibility.md rename to docs/user-guide/cost-visibility/overview-cost-visibility.md index 74a3933ee..75cc8d208 100644 --- a/docs/user-guide/cost-visibility.md +++ b/docs/user-guide/cost-visibility/overview-cost-visibility.md @@ -1,11 +1,6 @@ -# Cost Visibility -## Introduction - -In Devtron, Cost Visibility helps you understand your infrastructure spends. Instead of only using your cloud provider billing dashboards, you can see costs directly within Devtron, broken down by **Applications**, **Clusters**, **Environments**, **Projects**, **Infra Components**. +# Overview -It tracks spend on **CPU**, **Memory**, **Storage**, **GPU**, **network**, and highlights efficiency along with potential savings. You can view costs in multiple currencies, select daily, monthly, or custom ranges, and navigate from overall spend to specific cost breakdowns. - -## Overview +## Introduction The **Overview** page provides a summary of infrastructure costs across your Applications, Clusters, Environments, Projects, and Infra Components in Devtron. It highlights overall spend, resource-level distribution, and opportunities for optimization (Potential Savings). @@ -118,40 +113,3 @@ Each category will show | **Estimated Savings** | The estimated cost you could save in that category, based on the difference between provisioned and used resources, for the selected time range| Clicking on any item in this list takes you to its detailed Cost Breakdown page. Refer [Cost Breakdown]() to learn more. - -## Cost Breakdown - -The Cost Breakdown page helps you analyze costs within a selected category, **Clusters**, **Applications**, **Environments**, or **Projects**. - -For the chosen category type, it shows the following: - -| Field | Description | -|:--------------------------- |:----------------------------------------------------------------------------| -| **Total Cost** | The actual spend for the selected category type (e.g., all clusters). | -| **Recommended Cost** | The estimated cost calculated from actual resource usage instead of allocated capacity| -| **Potential Savings** | The percentage of your current spend that could be reduced| -| **Monthly Savings** | The estimated savings for one month based on the difference between allocated and used resources | -| **Annual Savings** | The projected savings over a year based on the same calculation| -| **Top 10 Costly Resources** | A ranked list of 10 highest cost resources of the selected category| - - - -You will also find a complete list of all the resources for the selected category at the bottom. -Each row in the list shows the following for the specific resource of the selected category: - -| Field | Available in Categories | Description | -|:------------------------|:---------------------------------|:-------------------------------------------------------------------- | -| **Provider** | Clusters | Shows the cloud provider or infrastructure source for each cluster | -| **Type** | Clusters, Environments | Shows whether each cluster or environment is **Production** or **Non-Production** | -| **Applications Count** | Environments, Projects | Shows the number of applications linked to each environment or project | -| **Environments** | Applications | Shows the number of environments where each application is deployed | -| **Memory Cost** | All categories | Shows the cost of memory usage for each resource in the selected category | -| **CPU Cost** | All categories | Shows the cost of CPU usage for each resource in the selected category | -| **Storage (PV) Cost** | All categories | Shows the cost of persistent volume (storage) usage for each resource in the selected category | -| **GPU Cost** | All categories | Shows the cost of GPU usage for each resource in the selected category | -| **Network Cost** | All categories | Shows the cost of network usage for each resource in the selected category | -| **Total Cost** | All categories | Shows the total cost of each resource | -| **Potential Savings** | All categories | Shows the cost and percentage of your current spend that could be saved for each resource | - - - From 9d447d7bdadbf5e88b3748e18a5acfbf4b2d390c Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Wed, 1 Oct 2025 07:11:18 +0530 Subject: [PATCH 10/34] docs: added configurations --- .../cost-visibility/configurations.md | 290 ++++++++++++++++++ 1 file changed, 290 insertions(+) diff --git a/docs/user-guide/cost-visibility/configurations.md b/docs/user-guide/cost-visibility/configurations.md index e69de29bb..42208b7b8 100644 --- a/docs/user-guide/cost-visibility/configurations.md +++ b/docs/user-guide/cost-visibility/configurations.md @@ -0,0 +1,290 @@ +# Configurations + +The Configurations page lets you manage configurations for Cost Visibility in Devtron. You can: + + * Set the default currency for all cost-related data. + * Enable or disable cost tracking for your connected clusters. + +## Currency (Default) + +You can select your preferred currency as default. + + + + +## Enable Cost Tracking + +To enable cost visibility for a cluster, follow the below steps: + +1. Choose your preferred cluster, and click on **Off/Enabled**, an **Edit Cluster** modal window will open. + +2. Enable the toggle next to **Enable cost tracking**. + +3. Select the cloud provider in which you have created your cluster. + +4. Based on the cloud provider you need to do the following configurations: + +{% tabs %} + +{% tab title="GCP" %} + +To enable cost visibility for Google Cloud in Devtron, you need to generate an API key and use it to connect Devtron with your GCP account. + +1. Generate the API key using standard [Google Cloud API key documentation](https://cloud.google.com/docs/authentication/api-keys#gcloud). + +2. Now go back to the **Edit cluster** modal window, and enter the API key in the **Cloud Provider API Key** field. + +{% endtab %} + +{% tab title="Azure" %} + +To enable cost visibility for your Azure clusters in Devtron, you need to allow Devtron to access your billing data securely. This requires two steps: + 1. Create a custom role in Azure with billing access. + 2. Create a service principal (an identity) that Devtron can use to fetch cost details. + + ### Step 1: Creating Custom Role + + 1. Open a text editor and copy the following JSON: + + ```json +{ + "Name": "OpenCostRole", + "IsCustom": true, + "Description": "Rate Card query role", + "Actions": [ + "Microsoft.Compute/virtualMachines/vmSizes/read", + "Microsoft.Resources/subscriptions/locations/read", + "Microsoft.Resources/providers/read", + "Microsoft.ContainerService/containerServices/read", + "Microsoft.Commerce/RateCard/read" + ], + "AssignableScopes": [ + "/subscriptions/YOUR_SUBSCRIPTION_ID" + ] +} + ``` + +2. Replace YOUR_SUBSCRIPTION_ID with your actual subscription ID. + +3. Save the file as `myrole.json`. + +4. Run the following command in your terminal: + +```bash +az role definition create --verbose --role-definition @myrole.json +``` + +This creates a role called `OpenCostRole` with just enough access to read pricing information. + +### Step 2: Create a Service Principal + +1. Run the command below, again replacing YOUR_SUBSCRIPTION_ID with your subscription ID: + +```bash +az ad sp create-for-rbac \ + --name "OpenCostAccess" \ + --role "OpenCostRole" \ + --scope "/subscriptions/YOUR_SUBSCRIPTION_ID" \ + --output json +``` + +2. You’ll get an output like this: + +```json +{ + "appId": "1d9b1532-abe4-4e08-b172-adfa5384da1", + "displayName": "OpenCostAccess", + "password": "3DZ8Q~KOE.WgdmmRkBHg3dF1rfrpFhSPk.Hnb4-", + "tenant": "aee9b2ed-7ecc-4cb2-bfed-60d71c0e957" +} +``` + +3. Note this information as you need to enter this in Devtron. + +### Step 3: Enter Details in Devtron + +Now go back to the **Edit cluster** modal window, and fill the following fields: + +| **Field** | **Value to Provide** | +|---------------------|---------------------------------| +| Subscription ID | Your Azure subscription ID | +| App ID | Value of `appId` from the output | +| Display Name | Value of `displayName` from the output| +| Password | Value of `password` from the output | +| Tenant | Value of `tenant` from the output | +| Billing Account | Optional (fill if available) | +| Offer ID | Optional (fill if available) | + +{% endtab %} + +{% tab title="AWS" %} + +To enable cost visibility for AWS in Devtron, follow the below steps: + +### Step 1: Set up a Spot Instance Data Feed + +1. Create an S3 bucket + +2. Assign full access permissions to the AWS Spot Data Feed service + +```json +{ + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Principal": { + "Service": "spot.amazonaws.com" + }, + "Action": "*", + "Resource": "arn:aws:s3:::devtron-spot-feed/*" + }, + { + "Effect": "Allow", + "Principal": { + "Service": "spot.amazonaws.com" + }, + "Action": "*", + "Resource": "arn:aws:s3:::devtron-spot-feed" + } + ] +} +``` + +3. Run the following command to subscribe to the data feed using the AWS CLI + +```bash +aws ec2 create-spot-datafeed-subscription \ + --bucket devtron-spot-feed --prefix cost +``` + +**Note:** You can subscribe to the Spot Data Feed for only one S3 bucket at a time. Running the command again updates the feed to the latest bucket. + +### Step 2: Create an IAM Role or Use Access Keys + +You can connect Devtron to AWS cost data using either of the following methods: + +#### IAM Role (Recommended) + +Create a Web Identity IAM role for your EKS/EC2 cluster with permissions to access the Spot Data Feed bucket. Attach the following policy (replace CHANGE-ME with your bucket name) + +```json +{ + "Version": "2012-10-17", + "Statement": [ + { + "Action": [ + "s3:ListAllMyBuckets", + "s3:ListBucket", + "s3:Get*" + ], + "Resource": [ + "arn:aws:s3:::CHANGE-ME", + "arn:aws:s3:::CHANGE-ME/*" + ], + "Effect": "Allow" + } + ] +} + +``` + +#### Access Keys (Alternative) + +Provide an Access Key and Secret Key with permissions `s3:ListBucket` and `s3:GetObject` for the Spot Data Feed bucket. + +### Step 3: Configure in Devtron + +Now go back to the **Edit cluster** modal window, and fill the following fields: + +| **Field** | **Description** | +|-----------------------|---------------------------------------------------------------------------------| +| Spot Data Bucket | Name of the S3 bucket storing Spot Instance Data Feed | +| Spot Data Region | AWS region of the Spot Data Feed | +| Spot Data Prefix | Prefix (if any) used for the Spot Data Feed | +| Project ID | Your AWS Account ID | +| Access Key | (Optional) AWS Access Key with S3 read permissions | +| Secret Access Key | (Optional) AWS Secret Access Key with S3 read permissions | +| IAM Role | (Recommended) IAM role ARN assigned to the EKS/EC2 cluster for bucket access | + +{% endtab %} + +{% endtabs %} + +5. Enter Prometheus endpoint of your cluster. Refer [Fetching Prometheus Endpoint](#fetching-prometheus-endpoint) to learn more. + +6. Click save. + +### Fetching Prometheus Endpoint + +{% hint style="warning" %} +### Note +Ensure [GitOps](../global-configurations/gitops.md) is configured before deploying Prometheus. If not, Prometheus will default to being deployed via Helm. +{% endhint %} + +#### Installing Prometheus + +1. Go to the **Chart Store** and search for `prometheus`. Use the Prometheus community's `kube-prometheus-stack` chart to deploy Prometheus. + + ![Figure : Chart Store](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app2.jpg) + +2. After selecting the chart, configure these values as needed before deployment. + + ```yaml + kube-state-metrics: + metricLabelsAllowlist: + - pods=[*] + ``` + +
+ + ```yaml + serviceMonitorSelectorNilUsesHelmValues: false + podMonitorSelectorNilUsesHelmValues: false + ``` + +
+ + Search for the above parameters, and update them as shown (or customize as needed). + + ![Figure a: Prometheus Chart Configuration](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app3.jpg) + + ![Figure b: Prometheus Chart Configuration (cont.)](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app-metrics-config.jpg) + +3. Enable `upgradeJob` parameter to install CRDs: + + Since Helm does not automatically apply CRDs, you need to enable the `upgradeJob` parameter in the Helm chart to ensure CRDs are applied before deploying Prometheus. + + In the Prometheus Helm chart settings, locate the `upgradeJob` parameter and set it to `true` if it is `false`. + + ![Figure : upgradeJob Parameter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app-new2.jpg) + +4. After enabling the parameter, click **Deploy Chart**. + +{% hint style="warning" %} +### Common Pitfall: Prometheus Deployment Timeout due to Failed CRDs + +While deploying `kube-prometheus-stack` chart, the deployment status may show as **Timed out**, and some CustomResourceDefinitions (CRDs) may appear as **Failed**. + +To solve it, refer [Troubleshoot Issues](#common-pitfall-prometheus-deployment-timeout-due-to-failed-crds) + +{% endhint %} + +#### Set Up Prometheus Endpoint + +{% hint style="warning" %} +### Who Can Perform This Action? +Only super admin users can set up Prometheus endpoint in a cluster. +{% endhint %} + +1. Once Prometheus is installed, go to its **App Details** and navigate to **Networking** → **Service** in the K8s resources. Expand the Prometheus server service to see the endpoints. + +2. Copy the URL of the `kube-prometheus` service as shown in the image below. + + ![Figure : Prometheus Service](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app4.jpg) + +3. Now enter the Prometheus endpoint: + 1. Paste the copied URL into the Prometheus endpoint field, ensuring it includes `http://` + 2. Click **Update Cluster** to save the changes. + + ![Figure : Prometheus Endpoint]() From f3798b2d999461ffff273658439312b9e8936c5c Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Tue, 7 Oct 2025 13:43:55 +0530 Subject: [PATCH 11/34] docs: added custom views --- .../cost-visibility/cost-breakdown.md | 47 ++++++++++++++++++- 1 file changed, 46 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/cost-visibility/cost-breakdown.md b/docs/user-guide/cost-visibility/cost-breakdown.md index cdf2042f8..e6704a716 100644 --- a/docs/user-guide/cost-visibility/cost-breakdown.md +++ b/docs/user-guide/cost-visibility/cost-breakdown.md @@ -10,6 +10,7 @@ At the top of the **Cost Breakdown** page, you can apply filters in the top-righ | **Currency** | Displays all cost values in the currency of your choice. | | **Time Range** | Defines the time range for data displayed | +## Inspecting Different Categories For the chosen category type, it shows the following: @@ -43,6 +44,7 @@ Each row in the list shows the following for the specific resource of the select +### Inspecting Specific Resource Clicking on any resource in the Cost Breakdown list opens its detailed cost breakdown view. Based on the category you will see the following @@ -61,4 +63,47 @@ Clicking on any resource in the Cost Breakdown list opens its detailed cost brea |**Cost Breakdown by Resource kind**|All categories|Shows the costs broken down by Kubernetes resource types (e.g., Pod, Deployment, StatefulSet, Job, DaemonSet, Rollout, Container).
  • Each bar represents a resource kind, segmented by CPU, Memory, GPU, Storage, and Network costs
| |**Cost Breakdown by Deployment**|Applications|Shows the distribution of costs across deployments within the selected application
  • Each bar represents a deployment, segmented by CPU, Memory, GPU, Storage, and Network costs
| - \ No newline at end of file + + +### Custom Views + +Custom Views allows you to define your own filtered view of cluster costs. Instead of looking at costs for the entire cluster, you can create a focused view based on propagated tags (for example, filter by team, environment, or application tag). + +This feature is available only under the Clusters category. + +**Note:** Custom Views are dependent on propagated tags (labels). If tags are not mentioned and propagated in the workloads, some resources may not appear in the view. Ensure that you have added and propagated tags for the workloads you want to include in the custom view. + +#### Creating a Custom View + +To create a custom view: + +1. Go to **Cost Visibility** → **Cost Breakdown** → **Cluster**. + +2. In the sidebar, click `+` icon next to **Custom Views**. + +3. Enter a **Name** and an optional **Description** for your view. + +4. Enter one or more label-based filters using **Key**, **Operator**, and **Value**. + +5. Click Apply Changes. + +Once applied, a Custom View works just like any other category breakdown in Cost Visibility. + +### Filters + +| **Field** | **Description** | +|--------------|---------------------------------------------------------------------------------| +| **Key** | The label key applied to your Kubernetes resources (for example, `app`, `team`). | +| **Operator** | Defines the comparison logic between the key and value. | +| **Value** | The label value to match against (for example, `logistics`, `prod`). | + +### Operators + +| **Operator** | **Meaning** | **Example** | +|--------------|--------------------------|--------------------------------------------| +| `:` | Equality | `app : frontend` → selects resources where `app=frontend`. | +| `!:` | Inequality | `team !: dev` → excludes resources with `team=dev`. | +| `~:` | Contains | `name ~: api` → selects resources where label contains `api`. | +| `!~` | Not Contains | `app !~: test` → excludes resources where label contains `test`. | +| `<~` | Contains Prefix | `env <~: prod` → selects resources where label starts with `prod`. | +| `!<~` | Not Contains Prefix | `env !<~: staging` → excludes resources where label starts with `staging`. | \ No newline at end of file From 7164b868b4ae3295e8a7674dfefea976ebe67990 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 9 Oct 2025 13:03:33 +0530 Subject: [PATCH 12/34] docs: added supademos --- docs/user-guide/cost-visibility/cost-breakdown.md | 6 ++---- .../cost-visibility/overview-cost-visibility.md | 12 +++++++++--- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/user-guide/cost-visibility/cost-breakdown.md b/docs/user-guide/cost-visibility/cost-breakdown.md index e6704a716..1c2878bc2 100644 --- a/docs/user-guide/cost-visibility/cost-breakdown.md +++ b/docs/user-guide/cost-visibility/cost-breakdown.md @@ -23,8 +23,6 @@ For the chosen category type, it shows the following: | **Annual Savings** | The projected savings over a year based on the same calculation| | **Top 10 Costly Resources** | A ranked list of 10 highest cost resources of the selected category| - - You will also find a complete list of all the resources for the selected category at the bottom. Each row in the list shows the following for the specific resource of the selected category: @@ -42,7 +40,7 @@ Each row in the list shows the following for the specific resource of the select | **Total Cost** | All categories | Shows the total cost of each resource | | **Potential Savings** | All categories | Shows the cost and percentage of your current spend that could be saved for each resource | - +{% embed url="https://app.supademo.com/demo/cmgaokrt93iuk2nomat2gyz7c" %} ### Inspecting Specific Resource @@ -63,7 +61,7 @@ Clicking on any resource in the Cost Breakdown list opens its detailed cost brea |**Cost Breakdown by Resource kind**|All categories|Shows the costs broken down by Kubernetes resource types (e.g., Pod, Deployment, StatefulSet, Job, DaemonSet, Rollout, Container).
  • Each bar represents a resource kind, segmented by CPU, Memory, GPU, Storage, and Network costs
| |**Cost Breakdown by Deployment**|Applications|Shows the distribution of costs across deployments within the selected application
  • Each bar represents a deployment, segmented by CPU, Memory, GPU, Storage, and Network costs
| - +{% embed url="https://app.supademo.com/demo/cmgga3snk6u0a2nomqwfntj11" %} ### Custom Views diff --git a/docs/user-guide/cost-visibility/overview-cost-visibility.md b/docs/user-guide/cost-visibility/overview-cost-visibility.md index 75cc8d208..4a7ac3822 100644 --- a/docs/user-guide/cost-visibility/overview-cost-visibility.md +++ b/docs/user-guide/cost-visibility/overview-cost-visibility.md @@ -21,7 +21,7 @@ The **At a Glance** summarizes the total cost for the selected period and breaks | **GPU Cost** | Shows the cost of GPU resources, their percentage contribution to the total cost, and the cost-trend graph for the selected period of time | | **Network Cost** | Shows the cost of network usage, its percentage contribution to the total cost, and the cost-trend graph for the selected period of time | - +{% embed url="https://app.supademo.com/demo/cmg7svcus10om2nommllm1nu2" %} ## Potential Savings @@ -34,7 +34,7 @@ The Potential Savings section estimates how much cost can be saved by comparing | **Monthly Savings** | The estimated savings for one month based on the difference between allocated and used resources | | **Annual Savings** | The projected savings over a year based on the same calculation | - +{% embed url="https://app.supademo.com/demo/cmg7qkb510x8w2nomc6d29rir" %} ## Track Performance @@ -46,6 +46,8 @@ The Cost Breakdown chart helps you see how costs are distributed across differen Each bar represents one Application, Cluster, Environment, or Project, and the colored segments in the bar show the share of different resource types. This makes it easy to compare categories and see which resources are contributing most to their total cost. +{% embed url="https://app.supademo.com/demo/cmgaj0aid3d8l2nomb611rpbl" %} + | Resource Type | Color Used in Chart | |:--------------------- |:---------------------| | **CPU Cost** | Light Green | @@ -80,6 +82,8 @@ Each bar represents the total cost for a specific time period (week, month, quar Within the bar, each colored segment shows the contribution of the selected category (Applications, Clusters, Environments, or Infrastructure Resources). This makes it easier to inspect both the overall cost usage and the relative share of each category over the selected time range. +{% embed url="https://app.supademo.com/demo/cmgg88zje6r362nom7ko7mz4t" %} + #### Time Range | Options | Description | @@ -112,4 +116,6 @@ Each category will show | **Potential Savings (%)** | The percentage of your current spend that could be saved, for the selected time range | | **Estimated Savings** | The estimated cost you could save in that category, based on the difference between provisioned and used resources, for the selected time range| -Clicking on any item in this list takes you to its detailed Cost Breakdown page. Refer [Cost Breakdown]() to learn more. +Clicking on any item in this list takes you to its detailed Cost Breakdown page. Refer [Cost Breakdown](./cost-breakdown.md) to learn more. + +{% embed url="https://app.supademo.com/demo/cmgj316cr0x93krn9l7g4uo7a" %} From b118b2411c418cad9f6bf2c4a539fac1fbb7beae Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 9 Oct 2025 15:06:09 +0530 Subject: [PATCH 13/34] docs: added Readme.md --- docs/user-guide/cost-visibility/configurations.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/user-guide/cost-visibility/configurations.md b/docs/user-guide/cost-visibility/configurations.md index 42208b7b8..4e53052f7 100644 --- a/docs/user-guide/cost-visibility/configurations.md +++ b/docs/user-guide/cost-visibility/configurations.md @@ -9,9 +9,6 @@ The Configurations page lets you manage configurations for Cost Visibility in De You can select your preferred currency as default. - - - ## Enable Cost Tracking To enable cost visibility for a cluster, follow the below steps: From bc7bd81accbdd7dc08456430911cf274a4a3efd9 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 9 Oct 2025 15:40:27 +0530 Subject: [PATCH 14/34] docs: fixes --- docs/user-guide/cost-visibility/README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/cost-visibility/README.md b/docs/user-guide/cost-visibility/README.md index 0e834eee1..29d16687c 100644 --- a/docs/user-guide/cost-visibility/README.md +++ b/docs/user-guide/cost-visibility/README.md @@ -1,6 +1,12 @@ # Cost Visibility ## Introduction -In Devtron, Cost Visibility helps you understand your infrastructure spends. Instead of only using your cloud provider billing dashboards, you can see costs directly within Devtron, broken down by **Applications**, **Clusters**, **Environments**, **Projects**, **Infra Components**. +Cost Visibility in Devtron provides a unified view of your Kubernetes infrastructure costs within the Devtron dashboard. It eliminates the need to switch between cloud provider billing consoles by integrating cost insights directly into your DevOps workflow. -It tracks spend on **CPU**, **Memory**, **Storage**, **GPU**, **network**, and highlights efficiency along with potential savings. You can view costs in multiple currencies, select daily, monthly, or custom ranges, and navigate from overall spend to specific cost breakdowns. \ No newline at end of file +You can view and analyze costs across multiple dimensions such as Clusters, Projects, Environments, Applications, and Infrastructure Resources. Devtron automatically tracks the spend on CPU, Memory, Storage, GPU, and Network, giving you a clear picture of how resources are utilized and what contributes most to your total cost. + +The dashboard highlights recommended costs and potential savings, helping you identify underutilized resources and opportunities for optimization. + +You can also view costs in multiple currencies and across different time periods, such as daily, monthly, quarterly, or custom ranges. This helps you move seamlessly from a high-level overview to a granular analysis of costs within a specific category. + +Cost Visibility empowers your team to make data-driven decisions, reduce wastage, and plan cloud budgets with greater confidence, all within the Devtron platform. \ No newline at end of file From c3babe8907ad256141029dd4c796f6ee11e400b9 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Fri, 10 Oct 2025 12:51:24 +0530 Subject: [PATCH 15/34] docs: added images and some fixes --- docs/user-guide/cost-visibility/README.md | 2 ++ docs/user-guide/cost-visibility/cost-breakdown.md | 2 ++ .../cost-visibility/overview-cost-visibility.md | 12 ++++++------ 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/user-guide/cost-visibility/README.md b/docs/user-guide/cost-visibility/README.md index 29d16687c..cd6825006 100644 --- a/docs/user-guide/cost-visibility/README.md +++ b/docs/user-guide/cost-visibility/README.md @@ -3,6 +3,8 @@ Cost Visibility in Devtron provides a unified view of your Kubernetes infrastructure costs within the Devtron dashboard. It eliminates the need to switch between cloud provider billing consoles by integrating cost insights directly into your DevOps workflow. +![Figure 1: Cost Visibility Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cost-visibility/cost-visibility-overview.jpg) + You can view and analyze costs across multiple dimensions such as Clusters, Projects, Environments, Applications, and Infrastructure Resources. Devtron automatically tracks the spend on CPU, Memory, Storage, GPU, and Network, giving you a clear picture of how resources are utilized and what contributes most to your total cost. The dashboard highlights recommended costs and potential savings, helping you identify underutilized resources and opportunities for optimization. diff --git a/docs/user-guide/cost-visibility/cost-breakdown.md b/docs/user-guide/cost-visibility/cost-breakdown.md index 1c2878bc2..bae9a1184 100644 --- a/docs/user-guide/cost-visibility/cost-breakdown.md +++ b/docs/user-guide/cost-visibility/cost-breakdown.md @@ -2,6 +2,8 @@ The Cost Breakdown page helps you analyze costs within a selected category (**Clusters**, **Applications**, **Environments**, or **Projects**), for a specific time range. +![Figure 1: Cost Breakdown Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cost-visibility/cost-visibility-cost-breakdown.jpg) + At the top of the **Cost Breakdown** page, you can apply filters in the top-right corner to adjust the view. | Filter | Description | diff --git a/docs/user-guide/cost-visibility/overview-cost-visibility.md b/docs/user-guide/cost-visibility/overview-cost-visibility.md index 4a7ac3822..211b63ad9 100644 --- a/docs/user-guide/cost-visibility/overview-cost-visibility.md +++ b/docs/user-guide/cost-visibility/overview-cost-visibility.md @@ -6,7 +6,7 @@ The **Overview** page provides a summary of infrastructure costs across your App At the top, you can choose your preferred currency time and time duration to set the context for your usage costs. This makes sure all costs on the **Overview** page are displayed in the correct currency and time range. - +![Figure 1: Cost Visibility Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cost-visibility/cost-visibility-overview.jpg) ## At a Glance @@ -50,11 +50,11 @@ Each bar represents one Application, Cluster, Environment, or Project, and the c | Resource Type | Color Used in Chart | |:--------------------- |:---------------------| -| **CPU Cost** | Light Green | -| **Memory Cost** | Blue | -| **Storage (PV) Cost** | Violet | -| **GPU Cost** | Dark Green | -| **Network Cost** | Orange | +| **CPU Cost** | LimeGreen | +| **Memory Cost** | SkyBlue | +| **Storage (PV) Cost** | AquaTeal | +| **GPU Cost** | Magenta | +| **Network Cost** | GoldenYellow | #### Filters From ae18ca0edabe1256363b0d805efb0fea840e7af2 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Sat, 11 Oct 2025 08:09:53 +0530 Subject: [PATCH 16/34] docs: added use cases and examples --- .../cost-visibility/cost-breakdown.md | 70 +++++++++++++++++-- 1 file changed, 66 insertions(+), 4 deletions(-) diff --git a/docs/user-guide/cost-visibility/cost-breakdown.md b/docs/user-guide/cost-visibility/cost-breakdown.md index bae9a1184..0e422599d 100644 --- a/docs/user-guide/cost-visibility/cost-breakdown.md +++ b/docs/user-guide/cost-visibility/cost-breakdown.md @@ -4,7 +4,16 @@ The Cost Breakdown page helps you analyze costs within a selected category (**Cl ![Figure 1: Cost Breakdown Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cost-visibility/cost-visibility-cost-breakdown.jpg) -At the top of the **Cost Breakdown** page, you can apply filters in the top-right corner to adjust the view. +At the top of the **Cost Breakdown** page, you can apply filters in the top-right corner to adjust the view. Selecting the right filters first ensures that the cost data matches your analysis goals and sets the right context for decision-making. + +For example, you might want to analyze your most recent infrastructure spend across production clusters. In that case, you can set the Cluster Scope filter to `Production` and select a Time Range of Last 30 Days. This will give you a focused view of active workloads and recent spending trends, without including cost from other clusters. + +{% hint style="success" %} + +### Use Case +Imagine your team is reviewing this month’s cloud spends and wants to focus only on production clusters. You open the Cost Breakdown page, set the **Cluster Scope** to `Production`, choose your preferred Currency, and adjust the Time Range to Last 30 Days. Instantly, the data updates to show just the relevant costs, providing you a clear picture of active environments and helps you spot any unusual spending patterns. With these quick filters, your team can focus on costs within the defined scope, ensuring the analysis stays relevant to your current objective. + +{% endhint %} | Filter | Description | |------------------|-----------------------------------------------------------------------------| @@ -14,7 +23,16 @@ At the top of the **Cost Breakdown** page, you can apply filters in the top-righ ## Inspecting Different Categories -For the chosen category type, it shows the following: +For the chosen category type (**Clusters**, **Applications**, **Environments**, or **Projects**), it shows the following: + +For example, if you select the Cluster category, you can view the total cost across all clusters, the recommended cost based on actual usage, and the potential savings if resources were optimized. This gives you a quick, high-level view of how efficiently each cluster is utilizing its allocated resources. + +{% hint style="success" %} + +### Use Case +Imagine your team is analyzing monthly infrastructure expenses for multiple clusters. You notice that the **Total Cost** for one cluster is significantly higher than the others. When you check the **Recommended Cost**, it’s much lower, showing that this cluster is over-provisioned. The Potential Savings metric confirms this, showing how much of your current spend could be reduced by aligning resource allocation with actual usage. With this insight, your team adjusts resource requests to improve overall cost efficiency without impacting performance. By the next billing cycle, costs come down, while the performance remains stable. + +{% endhint %} | Field | Description | |:--------------------------- |:----------------------------------------------------------------------------| @@ -25,7 +43,19 @@ For the chosen category type, it shows the following: | **Annual Savings** | The projected savings over a year based on the same calculation| | **Top 10 Costly Resources** | A ranked list of 10 highest cost resources of the selected category| -You will also find a complete list of all the resources for the selected category at the bottom. +You will also find a complete list of all the resources for the selected category at the bottom, helping you identify where most of your spending is concentrated. + +For example, if you’re viewing the Environment category, the list displays each environment along with its CPU, Memory, Storage, GPU, and Network costs. You can quickly compare environments and identify which ones have higher spend or greater potential savings. + +{% hint style="success" %} + +### Use Case +Suppose, you’re reviewing costs within the **Environment** category. As you go through the list, you noticed, one environment's **Total Cost** is higher than others. +You look across its row and notice that both **CPU Cost** and **Memory Cost** are also on the higher side. The Potential Savings column then shows a clear opportunity to optimize usage within that environment. With this focused view, you get a clearer understanding of where your resources are being used most and which environments might need attention, all from a single, organized view. You can then check detailed view for those environments to investigate further. + +{% endhint %} + + Each row in the list shows the following for the specific resource of the selected category: | Field | Available For Categories | Description | @@ -46,7 +76,18 @@ Each row in the list shows the following for the specific resource of the select ### Inspecting Specific Resource -Clicking on any resource in the Cost Breakdown list opens its detailed cost breakdown view. Based on the category you will see the following +Clicking on any resource in the Cost Breakdown list opens its detailed cost breakdown view. Based on the category you will see the following: + +For example, after identifying a high-cost Environment in the previous section, you can click on that environment to open its detailed breakdown. In the detailed breakdown view of the environment, you can see which Applications contribute most to its total cost, how resource types (like CPU, Memory, and Storage) are distributed. + +{% hint style=“success” %} + +### Use Case + +Continuing from the earlier scenario, you open the detailed cost breakdown for the environment that showed unusually high costs. In the **Top 10 Costly Applications** section, one application clearly dominates the cost chart. You then look at the **Cost Breakdown by Resource Kind** graph, where it becomes clear that most of this cost comes from Memory usage. +Investigating further, you confirm that a recent update introduced higher memory requests for that application. This explains the cost spike you noticed earlier. With this insight, your team can review and right-size resource allocations to keep the environment’s cost under control while maintaining stable performance. + +{% endhint %} | Field |Available For Categories | Description | |:-----------------|:-------------|:----| @@ -69,6 +110,27 @@ Clicking on any resource in the Cost Breakdown list opens its detailed cost brea Custom Views allows you to define your own filtered view of cluster costs. Instead of looking at costs for the entire cluster, you can create a focused view based on propagated tags (for example, filter by team, environment, or application tag). +For example, if your production workloads are labeled with `environment=production`, you can create a Custom View to track cost of production workloads only. +By creating a Custom View with: + +**Key**: `environment` +**Operator** : `:` +**Value** : `production` + +This helps you quickly analyze how much your production workloads are costing without manually filtering every time. As long as your workloads have the right labels, Devtron automatically groups and updates the data in your Custom View, giving you a consistent and focused view of your use case. + +{% hint style=“success” %} + +### Use Case + +Imagine your organization runs workloads for multiple teams, frontend, backend, and logistics, all within the same cluster. Each team’s workloads have propagated tags (labels) (for example, workloads of logistic team have `team=logistics` propagated tag). + +Your team often needs to check the monthly cloud spend for the logistics workloads, instead of applying filters for workloads every time, you create a Custom View once using that label. + +Now, whenever you open Cost Visibility, you simply select the “Logistics Team View” from the sidebar to instantly see total cost, usage patterns, and potential savings specific to that team because the workloads are already labeled, the data stays accurate, and your analysis remains consistent, saving time and effort each time you review costs. + +{% endhint %} + This feature is available only under the Clusters category. **Note:** Custom Views are dependent on propagated tags (labels). If tags are not mentioned and propagated in the workloads, some resources may not appear in the view. Ensure that you have added and propagated tags for the workloads you want to include in the custom view. From ec05c634fbf36819083774bf4625674f9a944ced Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 16 Oct 2025 16:35:17 +0530 Subject: [PATCH 17/34] docs: added application overview --- .../application-overview.md | 49 +++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 docs/user-guide/creating-application/application-overview.md diff --git a/docs/user-guide/creating-application/application-overview.md b/docs/user-guide/creating-application/application-overview.md new file mode 100644 index 000000000..4a0a6e919 --- /dev/null +++ b/docs/user-guide/creating-application/application-overview.md @@ -0,0 +1,49 @@ +# Introduction + +The Application Overview page in Devtron gives you a complete view of your Devtron Applications. It includes information about your projects, applications, environments, and pipelines, all in a single view. + +It helps you understand how your applications are organized, how your workflows are performing, and where you can improve visibility and control by giving you all the information in a single pane of view. + +## At a Glance + +The At a Glance section displays the total count of Projects, Devtron Applications, Helm Applications, and Environments, giving you an instant view of your overall applications in Devtron. + +| **Card** | **Description** | +|------------------------|----------------| +| **Projects** | Total number of projects in Devtron | +| **Devtron Applications** | Total number of Devtron applications across all the clusters | +| **Helm Applications** | Total number of Helm applications across all the clusters| +| **Environments** | Total number of Environments in Devtron across all the clusters| + +The Workflow Overview section displays how your CI/CD workflows are functioning in Devtron. It displays important metrics such as the number of build and deployment pipelines, external image sources, and production pipelines. It also shows how many pipelines follow GitOps best practices and have image scanning enabled. + +| **Card** | **Description** | +|-----------|-----------------| +| **Build Pipelines** | Shows the total number of build pipelines configured in your Devtron | +| **Deployment Pipelines** | Displays the total number of deployment pipelines across all applications| +| **External Image Sources** | Displays the total number of build pipelines which uses external image source | +| **Scanning Enabled in Workflows** | Shows the count of workflows that have image scanning enabled for security checks | +| **GitOps Compliance (Prod Pipelines)** | Displays how many production pipelines are configured using GitOps for configuration consistency| +| **Production Pipelines** | Indicates the total number of production pipelines defined within your Devtron| + +### Build & Deployment Metrics + +The Build & Deployment Metrics section helps you assess how efficiently your teams deliver software using Devtron pipelines. It uses the industry standard DORA metrics to measure delivery performance and reliability across production deployment pipelines. + +You can track four key metrics over a selected time range (for example, the last 30 days). + +| **Metric** | **Description** | +|-------------|-----------------| +| **Deployment Frequency** | Indicates how often code changes are successfully deployed to production. Higher frequency shows faster delivery and stronger CI/CD maturity| +| **Mean Lead Time** | The average time taken from code commit to production deployment. Shorter lead times reflect faster delivery cycles and efficient workflows | +| **Change Failure Rate** | The percentage of deployments that result in a failure. Lower values indicate more stable releases and stronger testing practices | +| **Mean Time to Recovery (MTTR)** | The average time it takes to restore service after a failure. A shorter recovery time reflects stronger incident response and operational resilience | +| **Pipelines Count by Performance** | Categorizes pipelines into **Elite**, **High**, **Medium**, and **Low** performance based on DORA metrics. Helps identify which pipelines are performing well and which may need improvement | + +{% hint style=“success” %} + +### Use Case + +Suppose your DevOps team is reviewing delivery performance for the last month. You notice that while Deployment Frequency has increased, the Mean Lead Time has also gone up. This suggests that more deployments are happening, but each one is taking longer to reach production. By comparing the Change Failure Rate and Mean Time to Recovery, your team can identify whether the delay is due to testing, approvals, or rollback handling. With these insights, you can fine-tune your workflow or automation to achieve faster and more reliable releases. + +{% endhint %} \ No newline at end of file From b682ea3b3a4b8b173f0c634b5504e4e5b1823698 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Sat, 18 Oct 2025 08:03:49 +0530 Subject: [PATCH 18/34] docs: added more sections and application overview --- .../application-overview.md | 171 +++++++++++++++++- 1 file changed, 161 insertions(+), 10 deletions(-) diff --git a/docs/user-guide/creating-application/application-overview.md b/docs/user-guide/creating-application/application-overview.md index 4a0a6e919..92f5f25da 100644 --- a/docs/user-guide/creating-application/application-overview.md +++ b/docs/user-guide/creating-application/application-overview.md @@ -4,6 +4,8 @@ The Application Overview page in Devtron gives you a complete view of your Devtr It helps you understand how your applications are organized, how your workflows are performing, and where you can improve visibility and control by giving you all the information in a single pane of view. +![Figure 1: Application Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/application-overview/application-overview.jpg) + ## At a Glance The At a Glance section displays the total count of Projects, Devtron Applications, Helm Applications, and Environments, giving you an instant view of your overall applications in Devtron. @@ -15,16 +17,22 @@ The At a Glance section displays the total count of Projects, Devtron Applicatio | **Helm Applications** | Total number of Helm applications across all the clusters| | **Environments** | Total number of Environments in Devtron across all the clusters| +{% embed url="https://app.supademo.com/demo/cmgoybsk909t912sxbkjaixtr" %} + +## Workflow Overview + The Workflow Overview section displays how your CI/CD workflows are functioning in Devtron. It displays important metrics such as the number of build and deployment pipelines, external image sources, and production pipelines. It also shows how many pipelines follow GitOps best practices and have image scanning enabled. | **Card** | **Description** | |-----------|-----------------| | **Build Pipelines** | Shows the total number of build pipelines configured in your Devtron | -| **Deployment Pipelines** | Displays the total number of deployment pipelines across all applications| -| **External Image Sources** | Displays the total number of build pipelines which uses external image source | -| **Scanning Enabled in Workflows** | Shows the count of workflows that have image scanning enabled for security checks | -| **GitOps Compliance (Prod Pipelines)** | Displays how many production pipelines are configured using GitOps for configuration consistency| -| **Production Pipelines** | Indicates the total number of production pipelines defined within your Devtron| +| **Deployment Pipelines** | Shows the total number of deployment pipelines across all applications| +| **External Image Sources** | Shows the total number of build pipelines which uses external image source | +| **Scanning Enabled in Workflows** | Shows the percentage of workflows that have scanning enabled for images | +| **GitOps Compliance (Prod Pipelines)** | Shows how many production pipelines are configured using GitOps for configuration consistency| +| **Production Pipelines** | Shows the total number of production pipelines defined within your Devtron| + +{% embed url="https://app.supademo.com/demo/cmgvkilsc4rpcyzgyfz27ywut" %} ### Build & Deployment Metrics @@ -34,16 +42,159 @@ You can track four key metrics over a selected time range (for example, the last | **Metric** | **Description** | |-------------|-----------------| -| **Deployment Frequency** | Indicates how often code changes are successfully deployed to production. Higher frequency shows faster delivery and stronger CI/CD maturity| -| **Mean Lead Time** | The average time taken from code commit to production deployment. Shorter lead times reflect faster delivery cycles and efficient workflows | -| **Change Failure Rate** | The percentage of deployments that result in a failure. Lower values indicate more stable releases and stronger testing practices | -| **Mean Time to Recovery (MTTR)** | The average time it takes to restore service after a failure. A shorter recovery time reflects stronger incident response and operational resilience | +| **Deployment Frequency** |Shows how often your deployment pipelines push new releases to production | +| **Mean Lead Time** | Shows the average time it takes for a code change to move from commit to production. It helps you understand how quickly your team can deliver new features or fixes| +| **Change Failure Rate** | Indicates the percentage of deployments that result in a failure or rollback. It helps you measure release stability and identify where improvements can reduce disruptions| +| **Mean Time to Recovery (MTTR)** | Measures how long it takes to recover from a failed deployment. It helps you assess how effectively your team can respond to and fix issues when they occur| | **Pipelines Count by Performance** | Categorizes pipelines into **Elite**, **High**, **Medium**, and **Low** performance based on DORA metrics. Helps identify which pipelines are performing well and which may need improvement | +{% embed url="https://app.supademo.com/demo/cmgvm5zcy4scyyzgykhpfbjwn" %} + +Each DORA metric in Devtron uses color-coded categories to represent pipeline performance levels. These colors help you quickly interpret how your production deployment pipelines are performing, from **Elite** (best-performing) to **Low** (needs attention). + +The meaning for each color vary slightly across different metrics, reflecting how delivery speed, stability, and recovery time are measured in real-world DevOps performance. The table below summarizes what each color means for every DORA metric in Devtron. + +| **Metric** | **Color** | **Category** | **Description** | **Range / Criteria** | +|-------------|------------|---------------|------------------|-----------------------| +| **Deployment Frequency** | 🟪 **Elite** | Top performing pipelines | Deployed more than once per day | > 1 per day | +| | 🟩 **High** | High-performing pipelines | Deployed between once per day and once per week | 1 per day – 1 per week | +| | 🟨 **Medium** | Moderately active pipelines | Deployed between once per week and once per month | 1 per week – 1 per month | +| | 🟥 **Low** | Infrequently deployed pipelines | Deployed between once per month and once per 6 months | 1 per month – 1 per 6 months | +| **Mean Lead Time** | 🟪 **Elite** | Top performing pipelines | Mean lead time is less than 1 day | < 1 day | +| | 🟩 **High** | High-performing pipelines | Mean lead time is between 1 day and 1 week | 1 day – 1 week | +| | 🟨 **Medium** | Moderately efficient pipelines | Mean lead time is between 1 week and 1 month | 1 week – 1 month | +| | 🟥 **Low** | Slow pipelines | Mean lead time is between 1 day and 6 months | 1 day – 6 months | +| **Change Failure Rate** | 🟪 **Elite** | Top performing pipelines | Change failure rate is between 0–15% | 0–15% | +| | 🟩 **High** | High-performing pipelines | Change failure rate is between 16–30% | 16–30% | +| | 🟨 **Medium** | Moderately stable pipelines | Change failure rate is between 31–45% | 31–45% | +| | 🟥 **Low** | Unstable pipelines | Change failure rate is between 46–60% | 46–60% | +| **Mean Time to Recovery (MTTR)** | 🟪 **Elite** | Top performing pipelines | Mean time to recovery is less than 1 hour | < 1 hour | +| | 🟩 **High** | High-performing pipelines | Mean time to recovery is between 1 hour and 1 day | 1 hour – 1 day | +| | 🟨 **Medium** | Moderately resilient pipelines | Mean time to recovery is between 1 day and 1 week | 1 day – 1 week | +| | 🟥 **Low** | Slow recovery pipelines | Mean time to recovery is more than 1 week | > 1 week | + {% hint style=“success” %} ### Use Case Suppose your DevOps team is reviewing delivery performance for the last month. You notice that while Deployment Frequency has increased, the Mean Lead Time has also gone up. This suggests that more deployments are happening, but each one is taking longer to reach production. By comparing the Change Failure Rate and Mean Time to Recovery, your team can identify whether the delay is due to testing, approvals, or rollback handling. With these insights, you can fine-tune your workflow or automation to achieve faster and more reliable releases. -{% endhint %} \ No newline at end of file +{% endhint %} + +## Triggers & Build Time + +The Triggers & Build Time section provides a detailed view of your build and deployment activities in Devtron. It helps you understand how frequently builds and deployments are triggered, how long they take, and how successful they are over time. + +At the top, you will see three key indicators: + +| **Field** | **Description** | +|------------|----------------| +| **Total Build Triggers** | The total number of builds triggered across all pipelines within the selected time period. | +| **Average Build Time** | The average time taken for a build to complete successfully. | +| **Total Deployment Triggers** | The total number of deployments triggered during the selected time period. | + +Below each indicator, you will also find a corresponding graph that visualizes its trend over selected period of time. You can adjust the **Time Range** in the top-right corner of the graph to analyze workflow trends over different periods. + +| Option | Description | +|:----------------|:-------------| +| **Today** | Shows build and deployment activity for the current day | +| **This Week** | Displays data from the current week | +| **Last Week** | Displays data from the previous week for comparison | +| **This Month** | Aggregates data for the ongoing month | +| **Last Month** | Shows activity from the previous month to help you analyze changes month-over-month| +| **This Quarter**| Groups workflow data into the current quarter (Q1, Q2, Q3, or Q4) | + +{% embed url="https://app.supademo.com/demo/cmgvmh7mo4stnyzgyvk9dr2g7" %} + +### Build Triggers Graph + +This graph displays how build triggers change over time. +* **Blue line:** Total build triggers +* **Green line:** Successful builds +* **Red line:** Failed builds + +Hover over any point on the graph to view daily build statistics, including total, successful, and failed builds. This helps you identify trends in build frequency and stability. + +### Deployment Triggers Graph + +This graph tracks how often deployments are triggered and how many of them succeed or fail. + +* **Blue line:** Total deployments triggered +* **Green line:** Successful deployments +* **Red line:** Failed deployments + +Hover over a specific date to see deployment counts and outcomes, helping you understand deployment frequency and reliability trends. + + +### Average Build Time Graph + +This graph shows how the average build duration varies during the selected time range. + +* The **blue line** represents the average build time per day (in minutes). +* The **dotted line** shows the overall average for the selected period. + +It helps you identify days when build duration increased significantly, signaling potential issues like resource bottlenecks or slower build steps. + +{% hint style="success" %} +### Use Case + +Suppose your team wants to analyze why release cycles slowed down this month. +You open the **Triggers & Build Time** section and notice that build triggers spiked on October 10, with several failed builds. Deployment triggers show a similar peak on October 8, where 73 deployments ran, and 18 failed. Meanwhile, the Average Build Time graph shows a sudden rise on October 3, where builds took three times longer than usual. + +With these insights, your team can connect the dots between build failures, longer build durations, and delayed deployments, helping you take timely corrective action to keep releases smooth and predictable. +{% endhint %} + +## Most & Least Triggered Pipelines + +This section shows the build and deployment pipelines that were triggered the most and the least within the selected time range. +It helps you identify which pipelines are most active and where fewer executions might indicate inactive or underused workflows. + +{% embed url="https://app.supademo.com/demo/cmgvn5zsw4t45yzgychnu2lfv" %} + +The section provides two tabs, **Build Pipelines** and **Deployment Pipelines**, each displaying a bar chart that ranks pipelines based on how frequently they were triggered during the selected time range. + +| **Tab** | **Description** | +|:---------|:----------------| +| **Build Pipelines** | Displays the most and least triggered build pipelines based on their total build trigger count. Each bar represents a single pipeline, and its length indicates how often the pipeline was triggered. | +| **Deployment Pipelines** | Displays the most and least triggered deployment pipelines based on their total deployment trigger count. Each bar represents a single deployment pipeline, and its length indicates the number of deployment triggers during the selected time range. | + +### Sorting and Filters + +| **Control** | **Description** | +|:--------------|:----------------| +| **Time Range** | Allows you to choose a time range such as **Today**, **This Week**, **This Month**, **Last Month**, or **This Quarter** to analyze pipeline activity during that period. | +| **Sorting Order** | Lets you sort the list **High to Low** or **Low to High** based on trigger count, helping you focus on the busiest or least used pipelines. | + +## Cost Visibility + +The Cost Visibility section provides a comparison of costs across your applications and build pipelines within Devtron. + +![Figure 2: Cost Visibility](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/application-overview/application-overview-cost-visibility.jpg) + +It shows: + + * **Top 10 Costly Applications**: It shows which deployed applications consume the most resources (such as CPU, memory, or storage) across your clusters. + + * **Top 10 Costly Build Pipelines**: It shows the list of build pipelines that have the highest cost during image builds. + +You can use the time range filter (Last 24 Hours, Last 7 Days, Last 30 Days, or Last 90 Days) to select the preferred time range. + +{% hint style="warning" %} + +### Note +If a cluster does not have cost tracking enabled, its data will not appear in this section. +Enable the **Cost Visibility** module for those clusters to view accurate cost insights. +{% endhint %} + +## Best Practices + +The Best Practices section helps shows you the percentage of production pipelines for which you have enabled approval policies. It gives you a quick view of how many pipelines have checks in place before important configuration changes or deployments go live. + +![Figure 3: Best Practices](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/application-overview/application-overview-best-practices.jpg) + +These insights help you ensure that the right governance controls are followed, reducing risks from unreviewed or accidental changes. + +| **Field** | **Description** | +|:-----------|:----------------| +| **Config Change Approval** | Indicates the percentage of pipelines that require approval before applying configuration changes| +| **Deployment Approval** | Indicates the percentage of pipelines that require approval before executing a deployment | \ No newline at end of file From 998f11b209b3af354bd14eca17a81b59e57866b3 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Tue, 21 Oct 2025 15:20:36 +0530 Subject: [PATCH 19/34] docs: added infrastructure overview --- .../infrastructure-overview.md | 265 ++++++++++++++++++ 1 file changed, 265 insertions(+) create mode 100644 docs/user-guide/creating-application/infrastructure-overview.md diff --git a/docs/user-guide/creating-application/infrastructure-overview.md b/docs/user-guide/creating-application/infrastructure-overview.md new file mode 100644 index 000000000..2368990a8 --- /dev/null +++ b/docs/user-guide/creating-application/infrastructure-overview.md @@ -0,0 +1,265 @@ +# Infrastructure Overview + +## Introduction + +## At a Glance + +The At a Glance section helps you quickly understand the overall state of your connected clusters and available resources. It helps you understand your current infrastructure capacity and connectivity status at a single glance. + +| **Card** | **Description** | +|:----------|:----------------| +| **Reachable Clusters** | Shows the number of clusters that are currently reachable out of the total clusters connected to Devtron | +| **Total CPU Capacity** | Displays the total CPU capacity across all reachable clusters, giving you an overview of your available compute power| +| **Total Memory Capacity** | Displays the total memory capacity across all reachable clusters, helping you keep track of your memory resources | + + +{% embed url="" %} + +{% hint style=“info” %} +If some clusters don’t appear, they might be temporarily unreachable. You can verify their status under Cluster Configuration. +{% endhint %} + +## Cluster & Nodes + +The **Cluster & Nodes** section helps you monitor the health and stability of your connected clusters and nodes. It gives you visibility into cluster connectivity, node errors, and scheduling readiness, allowing you to quickly spot and resolve any infrastructure level issues before they affect workloads. + +| **Card** | **Description** | +|:----------|:----------------| +| **Cluster Health Status** | Displays the number of clusters which are healthy. A healthy cluster indicates active connectivity, while **Connection Failed** highlights clusters that are currently unreachable| +| **Node Errors** | Shows whether any node-level issues exist. If you see **No node errors**, all nodes are operating normally | +| **Node Scheduling** | Displays the percentage of nodes currently available for scheduling workloads. **Schedulable** nodes are ready to accept pods| + +{% hint style="info" %} +If you notice connection failures or scheduling issues, verify your cluster connectivity and node configurations under **Cluster Management**. +{% endhint %} + +{% embed url="" %} + +### Cluster Counts + +The **Cluster Counts** section gives you visibility into how your clusters are distributed across different cloud providers and Kubernetes versions. It helps you identify where most of your clusters are hosted and which versions are actively running in your infrastructure. + +There are two views available: + +| **Tab** | **Description** | +|:---------|:----------------| +| **By Providers** | Displays the total number of clusters grouped by cloud providers such as **GCP**, **AWS**, **Azure**, or Unknown. This helps you understand your cloud distribution and dependency. | +| **By Cluster Versions** | Displays the number of clusters based on their Kubernetes version. This helps you track version diversity and identify clusters that may require upgrades for consistency and security. | + +{% hint style="info" %} +You can sort the data **High to Low** or **Low to High** to quickly identify the most used cloud provider or the most common Kubernetes version in your setup. +{% endhint %} + +{% embed url="" %} + +### Cluster Capacity & Resource Allocation + +The **Cluster Capacity & Resource Allocation** section provides a detailed view of how CPU and Memory resources are distributed and utilized across all connected clusters. +It helps you assess infrastructure efficiency, monitor resource limits, and identify clusters that may be underutilized or overcommitted. + +| **Field** | **Description** | +|:-----------|:----------------| +| **Cluster Name** | Lists all clusters connected to Devtron. You can click on a cluster name to view its detailed resource usage | +| **CPU** | Displays the total CPU capacity, along with utilization, requests, and limits for each cluster. This helps you track compute usage and detect over-provisioning | +| **Memory** | Displays the total memory capacity, along with utilization, requests, and limits for each cluster. It helps you ensure workloads are balanced, and resource allocation is efficient | + +You can **sort** the data by: +* **Cluster Name** (A to Z or Z to A) +* **Utilization** (High to Low or Low to High) + +{% hint style="info" %} +If a cluster shows zero utilization or capacity, it may be inactive or disconnected. Verify its status under **Cluster Configuration**. +{% endhint %} + +{% embed url="" %} + +## Node Counts + +The **Node Counts** section helps you visualize how nodes are distributed across clusters and autoscaling modes. +It provides a quick overview of your cluster node density and helps identify environments with higher or lower capacity. + +| **Tab** | **Description** | +|:----------|:----------------| +| **By Cluster** | This graph displays the total number of nodes within each cluster. Each bar shows the number of clusters within a specific cluster. This view helps you assess how evenly nodes are distributed and whether specific clusters may be over or under-provisioned | +| **By Autoscaler** | Groups nodes based on their autoscaling configuration (for example, **GKE Automode** or **Not Detected**). Each bar shows the number of nodes within the autoscaling configuration| + +You can **sort** the chart data using the dropdown in the top-right corner: +* **High to Low** or **Low to High**, to focus on clusters with the most or fewest nodes. + +{% hint style="info" %} +If some clusters show **Not Detected** under autoscaler, it means Devtron could not identify their scaling configuration. +You can verify autoscaling settings in your respective cloud console or cluster configuration. +{% endhint %} + + + +{% embed url="" %} + +### Cost Breakdown Graph + +The Cost Breakdown chart helps you see how costs are distributed across different infrastructure components for the selected time period. + +Each bar represents one Application, Cluster, Environment, or Project, and the colored segments in the bar show the share of different resource types. This makes it easy to compare categories and see which resources are contributing most to their total cost. + +{% embed url="https://app.supademo.com/demo/cmgaj0aid3d8l2nomb611rpbl" %} + +| Resource Type | Color Used in Chart | +|:--------------------- |:---------------------| +| **CPU Cost** | LimeGreen | +| **Memory Cost** | SkyBlue | +| **Storage (PV) Cost** | AquaTeal | +| **GPU Cost** | Magenta | +| **Network Cost** | GoldenYellow | + +#### Filters + +| Filters | What It Shows | +|:-----------------|:--------------| +| **Application** | Each bar represents an application, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | +| **Cluster** | Each bar represents a cluster, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | +| **Environment** | Each bar represents an environment, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | +| **Project** | Each bar represents a project, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | + +#### Sorting Criteria + +| Sorting Option | Description | +|:-------------------|:------------| +| **Cost: High to Low** | Shows the highest cost items first | +| **Cost: Low to High** | Shows the lowest cost items first | +| **A to Z** | Sorts items alphabetically | +| **Z to A** | Sorts items in reverse alphabetical order | + +# Overview + +## Introduction + +The **Overview** page provides a summary of infrastructure costs across your Applications, Clusters, Environments, Projects, and Infra Components in Devtron. It highlights overall spend, resource-level distribution, and opportunities for optimization (Potential Savings). + +At the top, you can choose your preferred currency time and time duration to set the context for your usage costs. This makes sure all costs on the **Overview** page are displayed in the correct currency and time range. + +![Figure 1: Cost Visibility Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cost-visibility/cost-visibility-overview.jpg) + +## At a Glance + +The **At a Glance** summarizes the total cost for the selected period and breaks it down by resource type. Each card shows the cost, its share of the total, and a usage trend graph. + +| Card | Description | +|:---------------- |:------------------------------------------------------------------------------------------------ | +| **Total Cost** | Shows the overall infrastructure cost for the selected time period, and the cost-trend graph for the selected period of time | +| **CPU Cost** | Shows the cost of CPU resources, their percentage contribution to the total cost, and the cost-trend graph for the selected period of time | +| **RAM Cost** | Shows the cost of memory resources, their percentage contribution to the total cost, and the cost-trend graph for the selected period of time | +| **PV Cost** | Shows the cost of persistent volume (storage), its percentage contribution to the total cost, and the cost-trend graph for the selected period of time | +| **GPU Cost** | Shows the cost of GPU resources, their percentage contribution to the total cost, and the cost-trend graph for the selected period of time | +| **Network Cost** | Shows the cost of network usage, its percentage contribution to the total cost, and the cost-trend graph for the selected period of time | + +{% embed url="https://app.supademo.com/demo/cmg7svcus10om2nommllm1nu2" %} + +## Potential Savings + +The Potential Savings section estimates how much cost can be saved by comparing the resources you have provisioned with the resources you have actually used. It also shows the percentage of current spend that could be saved. + +| Field | Description | +|:---------------------- |:------------------------------------------------------------------------------------------------ | +| **Recommended Cost** | The estimated cost calculated from actual resource usage instead of allocated capacity | +| **Potential Savings** | The percentage of your current spend that could be saved, for the selected time period | +| **Monthly Savings** | The estimated savings for one month based on the difference between allocated and used resources | +| **Annual Savings** | The projected savings over a year based on the same calculation | + +{% embed url="https://app.supademo.com/demo/cmg7qkb510x8w2nomc6d29rir" %} + +## Track Performance + +The Track Performance section helps you understand costs in more detail by breaking them down across different views and time ranges. It includes two charts, **Cost Breakdown** and **Cost Trend**. + +### Cost Breakdown Graph + +The Cost Breakdown chart helps you see how costs are distributed across different infrastructure components for the selected time period. + +Each bar represents one Application, Cluster, Environment, or Project, and the colored segments in the bar show the share of different resource types. This makes it easy to compare categories and see which resources are contributing most to their total cost. + +{% embed url="https://app.supademo.com/demo/cmgaj0aid3d8l2nomb611rpbl" %} + +| Resource Type | Color Used in Chart | +|:--------------------- |:---------------------| +| **CPU Cost** | LimeGreen | +| **Memory Cost** | SkyBlue | +| **Storage (PV) Cost** | AquaTeal | +| **GPU Cost** | Magenta | +| **Network Cost** | GoldenYellow | + +#### Filters + +| Filters | What It Shows | +|:-----------------|:--------------| +| **Application** | Each bar represents an application, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | +| **Cluster** | Each bar represents a cluster, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | +| **Environment** | Each bar represents an environment, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | +| **Project** | Each bar represents a project, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | + +#### Sorting Criteria + +| Sorting Option | Description | +|:-------------------|:------------| +| **Cost: High to Low** | Shows the highest cost items first | +| **Cost: Low to High** | Shows the lowest cost items first | +| **A to Z** | Sorts items alphabetically | +| **Z to A** | Sorts items in reverse alphabetical order | + +### Cost Trend Graph + +The Cost Trend chart helps you understand, how your resource usage costs change over time, broken down by the selected category, Applications, Clusters, Environments, or Infrastructure Resources. + +Each bar represents the total cost for a specific time period (week, month, quarter, or year). + +Within the bar, each colored segment shows the contribution of the selected category (Applications, Clusters, Environments, or Infrastructure Resources). This makes it easier to inspect both the overall cost usage and the relative share of each category over the selected time range. + +{% embed url="https://app.supademo.com/demo/cmgg88zje6r362nom7ko7mz4t" %} + +#### Time Range + +| Options | Description | +|:-----------|:--------------| +| **Week** | Breaks down costs for each week | +| **Month** | Aggregates costs by month | +| **Quarter**| Groups costs into calendar quarters (Q1, Q2, etc.) | +| **Year** | Shows yearly cost trends, useful for long-term analysis | + + + +#### Stack By + +| Options | Description | +|:----------------------|:------------------------------| +| **Applications** | Cost share of each application in the selected time range | +| **Clusters** | Cost share of each cluster in the selected time range | +| **Environments** | Cost share of each environment (e.g., dev, staging, prod) | +| **Infrastructure Resources** | Cost share of CPU, Memory, Storage (PV), GPU, and Network, in the selected time range | + +## Actions and Insights + +The Actions & Insights section highlights where you can achieve the highest cost savings. It shows the categories with the largest cost saving opportunities, based on the difference between allocated resources and your actual usage. + +It also shows, which version of Kubernetes your cluster is running, and you can also check the compatibility of the cluster to upgrade to the latest Kubernetes version. You can click **Show All** to expand and view additional clusters that are not immediately visible in the list. + +Each item in the **Top saving opportunities** will show + +| Field | Description | +|:-----------------------|:------------| +| **Name** | The name of the category (for example, a cluster, application, or environment) with the largest savings opportunities | +| **Potential Savings (%)** | The percentage of your current spend that could be saved, for the selected time range | +| **Estimated Savings** | The estimated cost you could save in that category, based on the difference between provisioned and used resources, for the selected time range| + +Clicking on any item in this list takes you to its detailed Cost Breakdown page. Refer [Cost Breakdown](./cost-breakdown.md) to learn more. + +### Checking Upgrade Compatibility + +1. To check upgrade capability, go to **Infrastructure Management** → **Overview**. + +2. Under **Check cluster update compatibility**, hover over the cluster you want to check compatibility for and click the search button. + +3. A pop-up modal will appear, select the target version, and click scan cluster. + +4. A Page will open, with the summary of all the API-endpoints that are compatible for upgrading. You can also check **Deprecated Fields** (Against current API version), **Resources with no PDB**, **Resources with 0 Disruption PDB** + + +{% embed url="" %} From fe0639d1a4c9fd62f15479387319c98edc879a02 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Wed, 22 Oct 2025 15:09:49 +0530 Subject: [PATCH 20/34] docs: implement changes --- docs/user-guide/cost-visibility/README.md | 6 +- .../cost-visibility/configurations.md | 12 +- .../cost-visibility/cost-breakdown.md | 18 +-- .../overview-cost-visibility.md | 121 +++++++++++++---- .../application-overview.md | 52 ++++++-- .../infrastructure-overview.md | 125 +++--------------- 6 files changed, 171 insertions(+), 163 deletions(-) diff --git a/docs/user-guide/cost-visibility/README.md b/docs/user-guide/cost-visibility/README.md index cd6825006..de03a0fa6 100644 --- a/docs/user-guide/cost-visibility/README.md +++ b/docs/user-guide/cost-visibility/README.md @@ -5,10 +5,8 @@ Cost Visibility in Devtron provides a unified view of your Kubernetes infrastruc ![Figure 1: Cost Visibility Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cost-visibility/cost-visibility-overview.jpg) -You can view and analyze costs across multiple dimensions such as Clusters, Projects, Environments, Applications, and Infrastructure Resources. Devtron automatically tracks the spend on CPU, Memory, Storage, GPU, and Network, giving you a clear picture of how resources are utilized and what contributes most to your total cost. +You can view and analyze costs across multiple scopes such as Clusters, Projects, Environments, Applications, and Infrastructure Resources. Devtron automatically tracks the spend on CPU, Memory, Storage, GPU, and Network, giving you a clear picture of how resources are utilized and what contributes most to your total cost. The dashboard highlights recommended costs and potential savings, helping you identify underutilized resources and opportunities for optimization. -You can also view costs in multiple currencies and across different time periods, such as daily, monthly, quarterly, or custom ranges. This helps you move seamlessly from a high-level overview to a granular analysis of costs within a specific category. - -Cost Visibility empowers your team to make data-driven decisions, reduce wastage, and plan cloud budgets with greater confidence, all within the Devtron platform. \ No newline at end of file +You can choose your preferred currency to view all cost data consistently across different time periods, such as daily, monthly, quarterly, or custom ranges. This helps you move seamlessly from a high-level overview to a granular analysis of costs within a specific category. diff --git a/docs/user-guide/cost-visibility/configurations.md b/docs/user-guide/cost-visibility/configurations.md index 4e53052f7..3152925ee 100644 --- a/docs/user-guide/cost-visibility/configurations.md +++ b/docs/user-guide/cost-visibility/configurations.md @@ -1,19 +1,23 @@ # Configurations -The Configurations page lets you manage configurations for Cost Visibility in Devtron. You can: +The **Configurations** page lets you manage configurations for Cost Visibility in Devtron. You can: * Set the default currency for all cost-related data. * Enable or disable cost tracking for your connected clusters. +--- + ## Currency (Default) You can select your preferred currency as default. +--- + ## Enable Cost Tracking To enable cost visibility for a cluster, follow the below steps: -1. Choose your preferred cluster, and click on **Off/Enabled**, an **Edit Cluster** modal window will open. +1. Choose your preferred cluster, and click on **Off/Enabled**. An **Edit Cluster** modal window will open. 2. Enable the toggle next to **Enable cost tracking**. @@ -75,7 +79,7 @@ This creates a role called `OpenCostRole` with just enough access to read pricin ### Step 2: Create a Service Principal -1. Run the command below, again replacing YOUR_SUBSCRIPTION_ID with your subscription ID: +1. Run the command below, again replacing `YOUR_SUBSCRIPTION_ID` with your subscription ID: ```bash az ad sp create-for-rbac \ @@ -210,7 +214,7 @@ Now go back to the **Edit cluster** modal window, and fill the following fields: 5. Enter Prometheus endpoint of your cluster. Refer [Fetching Prometheus Endpoint](#fetching-prometheus-endpoint) to learn more. -6. Click save. +6. Click **Save**. ### Fetching Prometheus Endpoint diff --git a/docs/user-guide/cost-visibility/cost-breakdown.md b/docs/user-guide/cost-visibility/cost-breakdown.md index 0e422599d..b8156a3e8 100644 --- a/docs/user-guide/cost-visibility/cost-breakdown.md +++ b/docs/user-guide/cost-visibility/cost-breakdown.md @@ -1,10 +1,10 @@ # Cost Breakdown -The Cost Breakdown page helps you analyze costs within a selected category (**Clusters**, **Applications**, **Environments**, or **Projects**), for a specific time range. +While the **Overview** section gives you a quick summary of overall spending, the **Cost Breakdown** page lets you analyze deeper into where those costs come from. It helps you analyze costs within a selected category (**Clusters**, **Applications**, **Environments**, or **Projects**), for a specific time range. ![Figure 1: Cost Breakdown Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cost-visibility/cost-visibility-cost-breakdown.jpg) -At the top of the **Cost Breakdown** page, you can apply filters in the top-right corner to adjust the view. Selecting the right filters first ensures that the cost data matches your analysis goals and sets the right context for decision-making. +At the top of the **Cost Breakdown** page, you can apply filters in the top-right corner to adjust the view. Selecting the right filters helps you to focus on the most relevant cost information for your preferred analysis. For example, you might want to analyze your most recent infrastructure spend across production clusters. In that case, you can set the Cluster Scope filter to `Production` and select a Time Range of Last 30 Days. This will give you a focused view of active workloads and recent spending trends, without including cost from other clusters. @@ -108,16 +108,16 @@ Investigating further, you confirm that a recent update introduced higher memory ### Custom Views -Custom Views allows you to define your own filtered view of cluster costs. Instead of looking at costs for the entire cluster, you can create a focused view based on propagated tags (for example, filter by team, environment, or application tag). +**Custom Views** allows you to define your own filtered view of cluster costs. Instead of looking at costs for the entire cluster, you can create a focused view based on propagated tags (for example, filter by team, environment, or application tag). -For example, if your production workloads are labeled with `environment=production`, you can create a Custom View to track cost of production workloads only. -By creating a Custom View with: +For example, if your production workloads are labeled with `environment=production`, you can create a custom view to track cost of production workloads only. +By creating a custom view with: **Key**: `environment` **Operator** : `:` **Value** : `production` -This helps you quickly analyze how much your production workloads are costing without manually filtering every time. As long as your workloads have the right labels, Devtron automatically groups and updates the data in your Custom View, giving you a consistent and focused view of your use case. +This helps you quickly analyze how much your production workloads are costing without manually filtering every time. As long as your workloads have the right labels, Devtron automatically groups and updates the data in your custom view, giving you a consistent and focused view of your use case. {% hint style=“success” %} @@ -125,7 +125,7 @@ This helps you quickly analyze how much your production workloads are costing wi Imagine your organization runs workloads for multiple teams, frontend, backend, and logistics, all within the same cluster. Each team’s workloads have propagated tags (labels) (for example, workloads of logistic team have `team=logistics` propagated tag). -Your team often needs to check the monthly cloud spend for the logistics workloads, instead of applying filters for workloads every time, you create a Custom View once using that label. +Your team often needs to check the monthly cloud spend for the logistics workloads, instead of applying filters for workloads every time, you create a custom view once using that label. Now, whenever you open Cost Visibility, you simply select the “Logistics Team View” from the sidebar to instantly see total cost, usage patterns, and potential savings specific to that team because the workloads are already labeled, the data stays accurate, and your analysis remains consistent, saving time and effort each time you review costs. @@ -163,8 +163,8 @@ Once applied, a Custom View works just like any other category breakdown in Cost | **Operator** | **Meaning** | **Example** | |--------------|--------------------------|--------------------------------------------| -| `:` | Equality | `app : frontend` → selects resources where `app=frontend`. | -| `!:` | Inequality | `team !: dev` → excludes resources with `team=dev`. | +| `:` | Equals to | `app : frontend` → selects resources where `app=frontend`. | +| `!:` | Not Equals To | `team !: dev` → excludes resources with `team=dev`. | | `~:` | Contains | `name ~: api` → selects resources where label contains `api`. | | `!~` | Not Contains | `app !~: test` → excludes resources where label contains `test`. | | `<~` | Contains Prefix | `env <~: prod` → selects resources where label starts with `prod`. | diff --git a/docs/user-guide/cost-visibility/overview-cost-visibility.md b/docs/user-guide/cost-visibility/overview-cost-visibility.md index 211b63ad9..7e18d82b4 100644 --- a/docs/user-guide/cost-visibility/overview-cost-visibility.md +++ b/docs/user-guide/cost-visibility/overview-cost-visibility.md @@ -8,6 +8,19 @@ At the top, you can choose your preferred currency time and time duration to set ![Figure 1: Cost Visibility Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cost-visibility/cost-visibility-overview.jpg) +Cost Overview has the following sections: + +1. [At a Glance](#at-a-glance) +2. [Potential Savings](#potential-savings) +3. [Track Performance](#track-performance) +4. [Actions and Insights](#actions-and-insights) + +{% hint style="info" %} +### Note +Cost Visibility is currently supported **only for Devtron and Helm applications**. +It is **not available** for applications deployed through **Argo CD** or **Flux**. +{% endhint %} + ## At a Glance The **At a Glance** summarizes the total cost for the selected period and breaks it down by resource type. Each card shows the cost, its share of the total, and a usage trend graph. @@ -21,33 +34,39 @@ The **At a Glance** summarizes the total cost for the selected period and breaks | **GPU Cost** | Shows the cost of GPU resources, their percentage contribution to the total cost, and the cost-trend graph for the selected period of time | | **Network Cost** | Shows the cost of network usage, its percentage contribution to the total cost, and the cost-trend graph for the selected period of time | +{% hint style="success" %} +### Tip +Network cost refers to the expenses associated with **data transfer**, including communication between **pods, nodes, and external services** within or across clusters. Refer to [AWS guide on network cost](https://aws.amazon.com/premiumsupport/knowledge-center/eks-cluster-networking-costs/) to learn more. +{% endhint %} + {% embed url="https://app.supademo.com/demo/cmg7svcus10om2nommllm1nu2" %} ## Potential Savings -The Potential Savings section estimates how much cost can be saved by comparing the resources you have provisioned with the resources you have actually used. It also shows the percentage of current spend that could be saved. +The **Potential Savings** section estimates how much cost can be saved by comparing the resources you have provisioned with the resources you have actually used. It also shows the percentage of current spend that could be saved. | Field | Description | |:---------------------- |:------------------------------------------------------------------------------------------------ | | **Recommended Cost** | The estimated cost calculated from actual resource usage instead of allocated capacity | -| **Potential Savings** | The percentage of your current spend that could be saved, for the selected time period | -| **Monthly Savings** | The estimated savings for one month based on the difference between allocated and used resources | -| **Annual Savings** | The projected savings over a year based on the same calculation | +| **Potential Savings** | The amount which you could have saved, for the selected time period| +| **Estimated cost reduction** | The percentage of your current spend that could be saved, for the selected time period | {% embed url="https://app.supademo.com/demo/cmg7qkb510x8w2nomc6d29rir" %} ## Track Performance -The Track Performance section helps you understand costs in more detail by breaking them down across different views and time ranges. It includes two charts, **Cost Breakdown** and **Cost Trend**. +The **Track Performance** section helps you understand costs in more detail by breaking them down across different views and time ranges. It includes two charts, **Cost Breakdown** and **Cost Trend**. -### Cost Breakdown Graph +### Cost Breakdown Bar Chart -The Cost Breakdown chart helps you see how costs are distributed across different infrastructure components for the selected time period. +The **Cost Breakdown** Bar Chart helps you see how costs are distributed across different infrastructure components for the selected time period. -Each bar represents one Application, Cluster, Environment, or Project, and the colored segments in the bar show the share of different resource types. This makes it easy to compare categories and see which resources are contributing most to their total cost. +Each bar represents one [Application](../../reference/glossary.md#devtron-apps), [Cluster](../../reference/glossary.md#cluster), [Environment](../../reference/glossary.md#environment), or [Project](../global-configurations/projects.md), and the colored segments in the bar show the share of different resource types. This makes it easy to compare categories and see which resources are contributing most to their total cost. {% embed url="https://app.supademo.com/demo/cmgaj0aid3d8l2nomb611rpbl" %} +#### Color Schema + | Resource Type | Color Used in Chart | |:--------------------- |:---------------------| | **CPU Cost** | LimeGreen | @@ -60,7 +79,7 @@ Each bar represents one Application, Cluster, Environment, or Project, and the c | Filters | What It Shows | |:-----------------|:--------------| -| **Application** | Each bar represents an application, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | +| **Application** | Each bar represents an application (Devtron App or Helm App), segmented by CPU, Memory, Storage (PV), GPU, and Network costs | | **Cluster** | Each bar represents a cluster, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | | **Environment** | Each bar represents an environment, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | | **Project** | Each bar represents a project, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | @@ -74,13 +93,22 @@ Each bar represents one Application, Cluster, Environment, or Project, and the c | **A to Z** | Sorts items alphabetically | | **Z to A** | Sorts items in reverse alphabetical order | -### Cost Trend Graph +#### Time Range Filters + +| Options | Description | +|:-----------|:--------------| +| **Last 24 hours** | Shows cost for the last 24 hours | +| **Last 7 days** | Shows cost for last 7 days | +| **Last 30 days**| Shows cost for the last 30 days | +| **last 90 days** | Shows cost for the last 90 days | -The Cost Trend chart helps you understand, how your resource usage costs change over time, broken down by the selected category, Applications, Clusters, Environments, or Infrastructure Resources. +### Cost Trend Line Chart -Each bar represents the total cost for a specific time period (week, month, quarter, or year). +The **Cost Trend** line chart helps you understand, how your total and individual resource usage costs change over time. It helps you analyze spending patterns and identify which resources contribute most to your overall cost. -Within the bar, each colored segment shows the contribution of the selected category (Applications, Clusters, Environments, or Infrastructure Resources). This makes it easier to inspect both the overall cost usage and the relative share of each category over the selected time range. +Each colored line represents a specific resource, CPU, Memory, Storage, Network, or GPU, while the Total line combines all costs. Hovering over any point on the graph displays the exact cost breakdown for that day. + +You can change the time range (for example, Last 7 Days, Last 30 Days, or Last 90 Days) to view trends for a specific period. {% embed url="https://app.supademo.com/demo/cmgg88zje6r362nom7ko7mz4t" %} @@ -88,27 +116,68 @@ Within the bar, each colored segment shows the contribution of the selected cate | Options | Description | |:-----------|:--------------| -| **Week** | Breaks down costs for each week | -| **Month** | Aggregates costs by month | -| **Quarter**| Groups costs into calendar quarters (Q1, Q2, etc.) | -| **Year** | Shows yearly cost trends, useful for long-term analysis | +| **Last 24 hours** | Shows cost for the last 24 hours | +| **Last 7 days** | Shows cost for last 7 days | +| **Last 30 days**| Shows cost for the last 30 days | +| **last 90 days** | Shows cost for the last 90 days | - +#### Color Schema -#### Stack By +| Resource Type | Color Used in Chart | +|:--------------------- |:---------------------| +| **CPU Cost** | LimeGreen | +| **Memory Cost** | SkyBlue | +| **Storage (PV) Cost** | AquaTeal | +| **GPU Cost** | Magenta | +| **Network Cost** | GoldenYellow | + +### Most Cost Efficient + +The Most Cost Efficient section helps you identify which resources are utilizing costs most effectively across different scopes, such as Cluster, Application, Environment, or Project. + +Each row in the list displays + +| **Field** | **Description** | +|------------|-----------------| +| **Name** | The name of the selected category (for example, a project, application, cluster, or environment)| +| **Total Cost** | The total cost incurred by that category within the selected time range | +| **Cost Efficiency (%)** | Indicates how efficiently the resource utilizes its allocated cost compared to others. Higher values represent better cost efficiency | + +You can use the dropdown menus to customize your view: + +| **Filter** | **Description** | +|-------------|-----------------| +| **Scope Selector** | Lets you choose whether to view cost efficiency by **Cluster**, **Application**, **Environment**, or **Project**. | +| **Time Range** | Allows you to select the time range, **Last 24 Hours**, **Last 7 Days**, **Last 30 Days**, or **Last 90 Days**. | -| Options | Description | -|:----------------------|:------------------------------| -| **Applications** | Cost share of each application in the selected time range | -| **Clusters** | Cost share of each cluster in the selected time range | -| **Environments** | Cost share of each environment (e.g., dev, staging, prod) | -| **Infrastructure Resources** | Cost share of CPU, Memory, Storage (PV), GPU, and Network, in the selected time range | + +### Most Expensive + +The Most Expensive section highlights the clusters, applications, environments, or projects that contribute the highest costs over a selected time range. This helps you quickly identify where your infrastructure expenses are concentrated and which components may require optimization. + +Each row in the list displays: + +| **Field** | **Description** | +|------------|-----------------| +| **Name** | The name of the selected category, such as a **Cluster**, **Application**, **Environment**, or **Project** | +| **Cost Type** | The selected cost type, such as **CPU**, **Memory**, **Storage**, **GPU**, **Network**, or **Total Cost** | +| **Total Cost** | The total cost incurred by that category for the chosen cost type within the specified time period | + +You can customize the view using the following filters: + +| **Filter** | **Description** | +|-------------|-----------------| +| **Scope Selector** | Lets you choose for which category (**Cluster**, **Application**, **Environment**, or **Project**), you want to view the most expensive resources | +| **Time Range** | Allows you to choose the time period for cost evaluation, **Last 24 Hours**, **Last 7 Days**, **Last 30 Days**, or **Last 90 Days**. | +| **Cost Type** | Enables you to filter costs by specific categories such as **CPU Cost**, **Memory Cost**, **Storage Cost**, **GPU Cost**, **Network Cost**, or **Total Cost**. | ## Actions and Insights The Actions & Insights section highlights where you can achieve the highest cost savings. It shows the categories with the largest cost saving opportunities, based on the difference between allocated resources and your actual usage. -Each category will show +It also shows the cost visibility status, which displays the number of clusters where cost visibility is enabled, failed, in progress, or not enabled. This helps you understand for which clusters cost data is currently being tracked and if you want you can enable/disable cost tracking for the cluster by clicking on **Go to configurations** button. Refer [configurations](./configurations.md) to learn more. + +Each category in the **Top saving opportunities** will show | Field | Description | |:-----------------------|:------------| diff --git a/docs/user-guide/creating-application/application-overview.md b/docs/user-guide/creating-application/application-overview.md index 92f5f25da..8c990f3ee 100644 --- a/docs/user-guide/creating-application/application-overview.md +++ b/docs/user-guide/creating-application/application-overview.md @@ -1,14 +1,27 @@ -# Introduction +# Application Overview -The Application Overview page in Devtron gives you a complete view of your Devtron Applications. It includes information about your projects, applications, environments, and pipelines, all in a single view. +## Introduction -It helps you understand how your applications are organized, how your workflows are performing, and where you can improve visibility and control by giving you all the information in a single pane of view. +The **Application Overview** page in Devtron gives you a complete view of your Devtron Applications. It includes information about your projects, applications, environments, and pipelines, all in a single view. + +It helps you understand how your applications are organized, how your workflows are performing, thus, giving you better visibility and control in a single pane of view. ![Figure 1: Application Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/application-overview/application-overview.jpg) +The **Application Overview** page contains the following sections: + +1. [At a Glance](#at-a-glance) +2. [Workflow Overview](#workflow-overview) +3. [Triggers & Build Time](#triggers--build-time) +4. [Most & Least Triggered Pipelines](#most--least-triggered-pipelines) +5. [Cost Visibility](#cost-visibility) +6. [Best Practices](#best-practices) + +--- + ## At a Glance -The At a Glance section displays the total count of Projects, Devtron Applications, Helm Applications, and Environments, giving you an instant view of your overall applications in Devtron. +The **At a Glance** section displays the total count of Projects, Devtron Applications, Helm Applications, and Environments, giving you an instant view of your overall applications in Devtron. | **Card** | **Description** | |------------------------|----------------| @@ -19,9 +32,11 @@ The At a Glance section displays the total count of Projects, Devtron Applicatio {% embed url="https://app.supademo.com/demo/cmgoybsk909t912sxbkjaixtr" %} +--- + ## Workflow Overview -The Workflow Overview section displays how your CI/CD workflows are functioning in Devtron. It displays important metrics such as the number of build and deployment pipelines, external image sources, and production pipelines. It also shows how many pipelines follow GitOps best practices and have image scanning enabled. +The **Workflow Overview** section displays how your CI/CD workflows are functioning in Devtron. It displays important metrics such as the number of build and deployment pipelines, external image sources, and production pipelines. It also shows how many pipelines follow GitOps best practices and have image scanning enabled. | **Card** | **Description** | |-----------|-----------------| @@ -36,7 +51,7 @@ The Workflow Overview section displays how your CI/CD workflows are functioning ### Build & Deployment Metrics -The Build & Deployment Metrics section helps you assess how efficiently your teams deliver software using Devtron pipelines. It uses the industry standard DORA metrics to measure delivery performance and reliability across production deployment pipelines. +The **Build & Deployment Metrics** section helps you assess how efficiently your teams deliver software using Devtron pipelines. It uses the industry standard DORA metrics to measure delivery performance and reliability across production deployment pipelines. You can track four key metrics over a selected time range (for example, the last 30 days). @@ -81,9 +96,11 @@ Suppose your DevOps team is reviewing delivery performance for the last month. Y {% endhint %} +--- + ## Triggers & Build Time -The Triggers & Build Time section provides a detailed view of your build and deployment activities in Devtron. It helps you understand how frequently builds and deployments are triggered, how long they take, and how successful they are over time. +The **Triggers & Build Time** section provides a detailed view of your build and deployment activities in Devtron. It helps you understand how frequently builds and deployments are triggered, how long they take, and how successful they are over time. At the top, you will see three key indicators: @@ -102,7 +119,7 @@ Below each indicator, you will also find a corresponding graph that visualizes i | **Last Week** | Displays data from the previous week for comparison | | **This Month** | Aggregates data for the ongoing month | | **Last Month** | Shows activity from the previous month to help you analyze changes month-over-month| -| **This Quarter**| Groups workflow data into the current quarter (Q1, Q2, Q3, or Q4) | +| **This Quarter**| Groups workflow data by the current quarter (**Jan-March**, **April-June**, **July-September**, or **October-December**) | {% embed url="https://app.supademo.com/demo/cmgvmh7mo4stnyzgyvk9dr2g7" %} @@ -144,6 +161,8 @@ You open the **Triggers & Build Time** section and notice that build triggers sp With these insights, your team can connect the dots between build failures, longer build durations, and delayed deployments, helping you take timely corrective action to keep releases smooth and predictable. {% endhint %} +--- + ## Most & Least Triggered Pipelines This section shows the build and deployment pipelines that were triggered the most and the least within the selected time range. @@ -165,9 +184,16 @@ The section provides two tabs, **Build Pipelines** and **Deployment Pipelines**, | **Time Range** | Allows you to choose a time range such as **Today**, **This Week**, **This Month**, **Last Month**, or **This Quarter** to analyze pipeline activity during that period. | | **Sorting Order** | Lets you sort the list **High to Low** or **Low to High** based on trigger count, helping you focus on the busiest or least used pipelines. | +--- + ## Cost Visibility -The Cost Visibility section provides a comparison of costs across your applications and build pipelines within Devtron. +{% hint style="info" %} +This section provides a quick overview of cost insights within the **Application Overview** dashboard. +For a more detailed breakdown of cost and usage across clusters, see the full [Cost Visibility](../cost-visibility/README.md) +{% endhint %} + +The **Cost Visibility** section provides a comparison of costs across your applications and build pipelines within Devtron. ![Figure 2: Cost Visibility](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/application-overview/application-overview-cost-visibility.jpg) @@ -177,18 +203,20 @@ It shows: * **Top 10 Costly Build Pipelines**: It shows the list of build pipelines that have the highest cost during image builds. -You can use the time range filter (Last 24 Hours, Last 7 Days, Last 30 Days, or Last 90 Days) to select the preferred time range. +You can use the time range filter (Last 24 Hours, Last 7 Days, Last 30 Days, or Last 90 Days) to select the preferred time range. {% hint style="warning" %} ### Note If a cluster does not have cost tracking enabled, its data will not appear in this section. -Enable the **Cost Visibility** module for those clusters to view accurate cost insights. +Enable the **Cost Visibility** module for those clusters to view accurate cost insights. Refer [Cost Visibility Configurations](../cost-visibility/configurations.md) to learn more. {% endhint %} +--- + ## Best Practices -The Best Practices section helps shows you the percentage of production pipelines for which you have enabled approval policies. It gives you a quick view of how many pipelines have checks in place before important configuration changes or deployments go live. +The **Best Practices** section helps shows you the percentage of production pipelines for which you have enabled approval policies. It gives you a quick view of how many pipelines have checks in place before important configuration changes or deployments go live. ![Figure 3: Best Practices](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/application-overview/application-overview-best-practices.jpg) diff --git a/docs/user-guide/creating-application/infrastructure-overview.md b/docs/user-guide/creating-application/infrastructure-overview.md index 2368990a8..8389f9af0 100644 --- a/docs/user-guide/creating-application/infrastructure-overview.md +++ b/docs/user-guide/creating-application/infrastructure-overview.md @@ -2,6 +2,17 @@ ## Introduction +The **Infrastructure Overview** page provides a centralized view of your Kubernetes infrastructure across all connected clusters. It displays cluster health, resource capacity, node distribution, and version details in a single dashboard. + +It contains the following sections: + +1. [At a Glance](#at-a-glance) +2. [Cluster & Nodes](#cluster--nodes) +3. [Cost Visibility](#cost-visibility) +4. [Actions & Insights](#actions-and-insights) + +--- + ## At a Glance The At a Glance section helps you quickly understand the overall state of your connected clusters and available resources. It helps you understand your current infrastructure capacity and connectivity status at a single glance. @@ -19,6 +30,8 @@ The At a Glance section helps you quickly understand the overall state of your c If some clusters don’t appear, they might be temporarily unreachable. You can verify their status under Cluster Configuration. {% endhint %} +--- + ## Cluster & Nodes The **Cluster & Nodes** section helps you monitor the health and stability of your connected clusters and nodes. It gives you visibility into cluster connectivity, node errors, and scheduling readiness, allowing you to quickly spot and resolve any infrastructure level issues before they affect workloads. @@ -73,6 +86,8 @@ If a cluster shows zero utilization or capacity, it may be inactive or disconnec {% embed url="" %} +--- + ## Node Counts The **Node Counts** section helps you visualize how nodes are distributed across clusters and autoscaling modes. @@ -91,11 +106,9 @@ If some clusters show **Not Detected** under autoscaler, it means Devtron could You can verify autoscaling settings in your respective cloud console or cluster configuration. {% endhint %} - - {% embed url="" %} -### Cost Breakdown Graph +### Cost Visibility The Cost Breakdown chart helps you see how costs are distributed across different infrastructure components for the selected time period. @@ -129,111 +142,7 @@ Each bar represents one Application, Cluster, Environment, or Project, and the c | **A to Z** | Sorts items alphabetically | | **Z to A** | Sorts items in reverse alphabetical order | -# Overview - -## Introduction - -The **Overview** page provides a summary of infrastructure costs across your Applications, Clusters, Environments, Projects, and Infra Components in Devtron. It highlights overall spend, resource-level distribution, and opportunities for optimization (Potential Savings). - -At the top, you can choose your preferred currency time and time duration to set the context for your usage costs. This makes sure all costs on the **Overview** page are displayed in the correct currency and time range. - -![Figure 1: Cost Visibility Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cost-visibility/cost-visibility-overview.jpg) - -## At a Glance - -The **At a Glance** summarizes the total cost for the selected period and breaks it down by resource type. Each card shows the cost, its share of the total, and a usage trend graph. - -| Card | Description | -|:---------------- |:------------------------------------------------------------------------------------------------ | -| **Total Cost** | Shows the overall infrastructure cost for the selected time period, and the cost-trend graph for the selected period of time | -| **CPU Cost** | Shows the cost of CPU resources, their percentage contribution to the total cost, and the cost-trend graph for the selected period of time | -| **RAM Cost** | Shows the cost of memory resources, their percentage contribution to the total cost, and the cost-trend graph for the selected period of time | -| **PV Cost** | Shows the cost of persistent volume (storage), its percentage contribution to the total cost, and the cost-trend graph for the selected period of time | -| **GPU Cost** | Shows the cost of GPU resources, their percentage contribution to the total cost, and the cost-trend graph for the selected period of time | -| **Network Cost** | Shows the cost of network usage, its percentage contribution to the total cost, and the cost-trend graph for the selected period of time | - -{% embed url="https://app.supademo.com/demo/cmg7svcus10om2nommllm1nu2" %} - -## Potential Savings - -The Potential Savings section estimates how much cost can be saved by comparing the resources you have provisioned with the resources you have actually used. It also shows the percentage of current spend that could be saved. - -| Field | Description | -|:---------------------- |:------------------------------------------------------------------------------------------------ | -| **Recommended Cost** | The estimated cost calculated from actual resource usage instead of allocated capacity | -| **Potential Savings** | The percentage of your current spend that could be saved, for the selected time period | -| **Monthly Savings** | The estimated savings for one month based on the difference between allocated and used resources | -| **Annual Savings** | The projected savings over a year based on the same calculation | - -{% embed url="https://app.supademo.com/demo/cmg7qkb510x8w2nomc6d29rir" %} - -## Track Performance - -The Track Performance section helps you understand costs in more detail by breaking them down across different views and time ranges. It includes two charts, **Cost Breakdown** and **Cost Trend**. - -### Cost Breakdown Graph - -The Cost Breakdown chart helps you see how costs are distributed across different infrastructure components for the selected time period. - -Each bar represents one Application, Cluster, Environment, or Project, and the colored segments in the bar show the share of different resource types. This makes it easy to compare categories and see which resources are contributing most to their total cost. - -{% embed url="https://app.supademo.com/demo/cmgaj0aid3d8l2nomb611rpbl" %} - -| Resource Type | Color Used in Chart | -|:--------------------- |:---------------------| -| **CPU Cost** | LimeGreen | -| **Memory Cost** | SkyBlue | -| **Storage (PV) Cost** | AquaTeal | -| **GPU Cost** | Magenta | -| **Network Cost** | GoldenYellow | - -#### Filters - -| Filters | What It Shows | -|:-----------------|:--------------| -| **Application** | Each bar represents an application, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | -| **Cluster** | Each bar represents a cluster, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | -| **Environment** | Each bar represents an environment, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | -| **Project** | Each bar represents a project, segmented by CPU, Memory, Storage (PV), GPU, and Network costs | - -#### Sorting Criteria - -| Sorting Option | Description | -|:-------------------|:------------| -| **Cost: High to Low** | Shows the highest cost items first | -| **Cost: Low to High** | Shows the lowest cost items first | -| **A to Z** | Sorts items alphabetically | -| **Z to A** | Sorts items in reverse alphabetical order | - -### Cost Trend Graph - -The Cost Trend chart helps you understand, how your resource usage costs change over time, broken down by the selected category, Applications, Clusters, Environments, or Infrastructure Resources. - -Each bar represents the total cost for a specific time period (week, month, quarter, or year). - -Within the bar, each colored segment shows the contribution of the selected category (Applications, Clusters, Environments, or Infrastructure Resources). This makes it easier to inspect both the overall cost usage and the relative share of each category over the selected time range. - -{% embed url="https://app.supademo.com/demo/cmgg88zje6r362nom7ko7mz4t" %} - -#### Time Range - -| Options | Description | -|:-----------|:--------------| -| **Week** | Breaks down costs for each week | -| **Month** | Aggregates costs by month | -| **Quarter**| Groups costs into calendar quarters (Q1, Q2, etc.) | -| **Year** | Shows yearly cost trends, useful for long-term analysis | - - - -#### Stack By - -| Options | Description | -|:----------------------|:------------------------------| -| **Applications** | Cost share of each application in the selected time range | -| **Clusters** | Cost share of each cluster in the selected time range | -| **Environments** | Cost share of each environment (e.g., dev, staging, prod) | -| **Infrastructure Resources** | Cost share of CPU, Memory, Storage (PV), GPU, and Network, in the selected time range | +--- ## Actions and Insights From 82eb3f3dea9f7cf0a702ea2b1c18055423101478 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Wed, 22 Oct 2025 15:57:08 +0530 Subject: [PATCH 21/34] docs: added supademos --- .../overview-cost-visibility.md | 16 +++++----- .../infrastructure-overview.md | 30 +++++++++---------- 2 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/user-guide/cost-visibility/overview-cost-visibility.md b/docs/user-guide/cost-visibility/overview-cost-visibility.md index 7e18d82b4..740775e71 100644 --- a/docs/user-guide/cost-visibility/overview-cost-visibility.md +++ b/docs/user-guide/cost-visibility/overview-cost-visibility.md @@ -25,6 +25,8 @@ It is **not available** for applications deployed through **Argo CD** or **Flux* The **At a Glance** summarizes the total cost for the selected period and breaks it down by resource type. Each card shows the cost, its share of the total, and a usage trend graph. +{% embed url="https://app.supademo.com/demo/cmg7svcus10om2nommllm1nu2" %} + | Card | Description | |:---------------- |:------------------------------------------------------------------------------------------------ | | **Total Cost** | Shows the overall infrastructure cost for the selected time period, and the cost-trend graph for the selected period of time | @@ -39,19 +41,19 @@ The **At a Glance** summarizes the total cost for the selected period and breaks Network cost refers to the expenses associated with **data transfer**, including communication between **pods, nodes, and external services** within or across clusters. Refer to [AWS guide on network cost](https://aws.amazon.com/premiumsupport/knowledge-center/eks-cluster-networking-costs/) to learn more. {% endhint %} -{% embed url="https://app.supademo.com/demo/cmg7svcus10om2nommllm1nu2" %} - ## Potential Savings The **Potential Savings** section estimates how much cost can be saved by comparing the resources you have provisioned with the resources you have actually used. It also shows the percentage of current spend that could be saved. +{% embed url="https://app.supademo.com/demo/cmg7qkb510x8w2nomc6d29rir" %} + | Field | Description | |:---------------------- |:------------------------------------------------------------------------------------------------ | | **Recommended Cost** | The estimated cost calculated from actual resource usage instead of allocated capacity | | **Potential Savings** | The amount which you could have saved, for the selected time period| | **Estimated cost reduction** | The percentage of your current spend that could be saved, for the selected time period | -{% embed url="https://app.supademo.com/demo/cmg7qkb510x8w2nomc6d29rir" %} + ## Track Performance @@ -61,10 +63,10 @@ The **Track Performance** section helps you understand costs in more detail by b The **Cost Breakdown** Bar Chart helps you see how costs are distributed across different infrastructure components for the selected time period. -Each bar represents one [Application](../../reference/glossary.md#devtron-apps), [Cluster](../../reference/glossary.md#cluster), [Environment](../../reference/glossary.md#environment), or [Project](../global-configurations/projects.md), and the colored segments in the bar show the share of different resource types. This makes it easy to compare categories and see which resources are contributing most to their total cost. - {% embed url="https://app.supademo.com/demo/cmgaj0aid3d8l2nomb611rpbl" %} +Each bar represents one [Application](../../reference/glossary.md#devtron-apps), [Cluster](../../reference/glossary.md#cluster), [Environment](../../reference/glossary.md#environment), or [Project](../global-configurations/projects.md), and the colored segments in the bar show the share of different resource types. This makes it easy to compare categories and see which resources are contributing most to their total cost. + #### Color Schema | Resource Type | Color Used in Chart | @@ -106,12 +108,12 @@ Each bar represents one [Application](../../reference/glossary.md#devtron-apps), The **Cost Trend** line chart helps you understand, how your total and individual resource usage costs change over time. It helps you analyze spending patterns and identify which resources contribute most to your overall cost. +{% embed url="https://app.supademo.com/demo/cmgg88zje6r362nom7ko7mz4t" %} + Each colored line represents a specific resource, CPU, Memory, Storage, Network, or GPU, while the Total line combines all costs. Hovering over any point on the graph displays the exact cost breakdown for that day. You can change the time range (for example, Last 7 Days, Last 30 Days, or Last 90 Days) to view trends for a specific period. -{% embed url="https://app.supademo.com/demo/cmgg88zje6r362nom7ko7mz4t" %} - #### Time Range | Options | Description | diff --git a/docs/user-guide/creating-application/infrastructure-overview.md b/docs/user-guide/creating-application/infrastructure-overview.md index 8389f9af0..602eb6e75 100644 --- a/docs/user-guide/creating-application/infrastructure-overview.md +++ b/docs/user-guide/creating-application/infrastructure-overview.md @@ -17,6 +17,8 @@ It contains the following sections: The At a Glance section helps you quickly understand the overall state of your connected clusters and available resources. It helps you understand your current infrastructure capacity and connectivity status at a single glance. +{% embed url="https://app.supademo.com/demo/cmh0e4sh81naf6nxtlvrh3kwy" %} + | **Card** | **Description** | |:----------|:----------------| | **Reachable Clusters** | Shows the number of clusters that are currently reachable out of the total clusters connected to Devtron | @@ -24,8 +26,6 @@ The At a Glance section helps you quickly understand the overall state of your c | **Total Memory Capacity** | Displays the total memory capacity across all reachable clusters, helping you keep track of your memory resources | -{% embed url="" %} - {% hint style=“info” %} If some clusters don’t appear, they might be temporarily unreachable. You can verify their status under Cluster Configuration. {% endhint %} @@ -36,6 +36,8 @@ If some clusters don’t appear, they might be temporarily unreachable. You can The **Cluster & Nodes** section helps you monitor the health and stability of your connected clusters and nodes. It gives you visibility into cluster connectivity, node errors, and scheduling readiness, allowing you to quickly spot and resolve any infrastructure level issues before they affect workloads. +{% embed url="https://app.supademo.com/demo/cmh0eklkn1npo6nxta30w3fnb" %} + | **Card** | **Description** | |:----------|:----------------| | **Cluster Health Status** | Displays the number of clusters which are healthy. A healthy cluster indicates active connectivity, while **Connection Failed** highlights clusters that are currently unreachable| @@ -46,12 +48,12 @@ The **Cluster & Nodes** section helps you monitor the health and stability of yo If you notice connection failures or scheduling issues, verify your cluster connectivity and node configurations under **Cluster Management**. {% endhint %} -{% embed url="" %} - ### Cluster Counts The **Cluster Counts** section gives you visibility into how your clusters are distributed across different cloud providers and Kubernetes versions. It helps you identify where most of your clusters are hosted and which versions are actively running in your infrastructure. +{% embed url="https://app.supademo.com/demo/cmh0f2cp21nuo6nxt0u0xu6ab" %} + There are two views available: | **Tab** | **Description** | @@ -63,12 +65,11 @@ There are two views available: You can sort the data **High to Low** or **Low to High** to quickly identify the most used cloud provider or the most common Kubernetes version in your setup. {% endhint %} -{% embed url="" %} - ### Cluster Capacity & Resource Allocation -The **Cluster Capacity & Resource Allocation** section provides a detailed view of how CPU and Memory resources are distributed and utilized across all connected clusters. -It helps you assess infrastructure efficiency, monitor resource limits, and identify clusters that may be underutilized or overcommitted. +The **Cluster Capacity & Resource Allocation** section provides a detailed view of how CPU and Memory resources are distributed and utilized across all connected clusters. It helps you assess infrastructure efficiency, monitor resource limits, and identify clusters that may be underutilized or over committed. + +{% embed url="https://app.supademo.com/demo/cmh1t50wh0e6rnitlu546ellj" %} | **Field** | **Description** | |:-----------|:----------------| @@ -84,8 +85,6 @@ You can **sort** the data by: If a cluster shows zero utilization or capacity, it may be inactive or disconnected. Verify its status under **Cluster Configuration**. {% endhint %} -{% embed url="" %} - --- ## Node Counts @@ -93,6 +92,8 @@ If a cluster shows zero utilization or capacity, it may be inactive or disconnec The **Node Counts** section helps you visualize how nodes are distributed across clusters and autoscaling modes. It provides a quick overview of your cluster node density and helps identify environments with higher or lower capacity. +{% embed url="https://app.supademo.com/demo/cmh1te7ck0ei9nitl41zpx5mg" %} + | **Tab** | **Description** | |:----------|:----------------| | **By Cluster** | This graph displays the total number of nodes within each cluster. Each bar shows the number of clusters within a specific cluster. This view helps you assess how evenly nodes are distributed and whether specific clusters may be over or under-provisioned | @@ -106,15 +107,13 @@ If some clusters show **Not Detected** under autoscaler, it means Devtron could You can verify autoscaling settings in your respective cloud console or cluster configuration. {% endhint %} -{% embed url="" %} - ### Cost Visibility The Cost Breakdown chart helps you see how costs are distributed across different infrastructure components for the selected time period. Each bar represents one Application, Cluster, Environment, or Project, and the colored segments in the bar show the share of different resource types. This makes it easy to compare categories and see which resources are contributing most to their total cost. -{% embed url="https://app.supademo.com/demo/cmgaj0aid3d8l2nomb611rpbl" %} +{% embed url="https://app.supademo.com/demo/cmh1u1s3o0fbmnitleo58pcg3" %} | Resource Type | Color Used in Chart | |:--------------------- |:---------------------| @@ -148,6 +147,8 @@ Each bar represents one Application, Cluster, Environment, or Project, and the c The Actions & Insights section highlights where you can achieve the highest cost savings. It shows the categories with the largest cost saving opportunities, based on the difference between allocated resources and your actual usage. +{% embed url="https://app.supademo.com/demo/cmh1u9uss0fvjnitlk1tn4lv0" %} + It also shows, which version of Kubernetes your cluster is running, and you can also check the compatibility of the cluster to upgrade to the latest Kubernetes version. You can click **Show All** to expand and view additional clusters that are not immediately visible in the list. Each item in the **Top saving opportunities** will show @@ -169,6 +170,3 @@ Clicking on any item in this list takes you to its detailed Cost Breakdown page. 3. A pop-up modal will appear, select the target version, and click scan cluster. 4. A Page will open, with the summary of all the API-endpoints that are compatible for upgrading. You can also check **Deprecated Fields** (Against current API version), **Resources with no PDB**, **Resources with 0 Disruption PDB** - - -{% embed url="" %} From 6dc4ceb3ef3aada86795bb24646469bfe052ffe5 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Wed, 22 Oct 2025 16:12:58 +0530 Subject: [PATCH 22/34] docs: supademo position changes --- .../creating-application/application-overview.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/user-guide/creating-application/application-overview.md b/docs/user-guide/creating-application/application-overview.md index 8c990f3ee..502d20245 100644 --- a/docs/user-guide/creating-application/application-overview.md +++ b/docs/user-guide/creating-application/application-overview.md @@ -23,6 +23,8 @@ The **Application Overview** page contains the following sections: The **At a Glance** section displays the total count of Projects, Devtron Applications, Helm Applications, and Environments, giving you an instant view of your overall applications in Devtron. +{% embed url="https://app.supademo.com/demo/cmgoybsk909t912sxbkjaixtr" %} + | **Card** | **Description** | |------------------------|----------------| | **Projects** | Total number of projects in Devtron | @@ -30,14 +32,14 @@ The **At a Glance** section displays the total count of Projects, Devtron Applic | **Helm Applications** | Total number of Helm applications across all the clusters| | **Environments** | Total number of Environments in Devtron across all the clusters| -{% embed url="https://app.supademo.com/demo/cmgoybsk909t912sxbkjaixtr" %} - --- ## Workflow Overview The **Workflow Overview** section displays how your CI/CD workflows are functioning in Devtron. It displays important metrics such as the number of build and deployment pipelines, external image sources, and production pipelines. It also shows how many pipelines follow GitOps best practices and have image scanning enabled. +{% embed url="https://app.supademo.com/demo/cmgvkilsc4rpcyzgyfz27ywut" %} + | **Card** | **Description** | |-----------|-----------------| | **Build Pipelines** | Shows the total number of build pipelines configured in your Devtron | @@ -47,12 +49,12 @@ The **Workflow Overview** section displays how your CI/CD workflows are function | **GitOps Compliance (Prod Pipelines)** | Shows how many production pipelines are configured using GitOps for configuration consistency| | **Production Pipelines** | Shows the total number of production pipelines defined within your Devtron| -{% embed url="https://app.supademo.com/demo/cmgvkilsc4rpcyzgyfz27ywut" %} - ### Build & Deployment Metrics The **Build & Deployment Metrics** section helps you assess how efficiently your teams deliver software using Devtron pipelines. It uses the industry standard DORA metrics to measure delivery performance and reliability across production deployment pipelines. +{% embed url="https://app.supademo.com/demo/cmgvm5zcy4scyyzgykhpfbjwn" %} + You can track four key metrics over a selected time range (for example, the last 30 days). | **Metric** | **Description** | @@ -63,8 +65,6 @@ You can track four key metrics over a selected time range (for example, the last | **Mean Time to Recovery (MTTR)** | Measures how long it takes to recover from a failed deployment. It helps you assess how effectively your team can respond to and fix issues when they occur| | **Pipelines Count by Performance** | Categorizes pipelines into **Elite**, **High**, **Medium**, and **Low** performance based on DORA metrics. Helps identify which pipelines are performing well and which may need improvement | -{% embed url="https://app.supademo.com/demo/cmgvm5zcy4scyyzgykhpfbjwn" %} - Each DORA metric in Devtron uses color-coded categories to represent pipeline performance levels. These colors help you quickly interpret how your production deployment pipelines are performing, from **Elite** (best-performing) to **Low** (needs attention). The meaning for each color vary slightly across different metrics, reflecting how delivery speed, stability, and recovery time are measured in real-world DevOps performance. The table below summarizes what each color means for every DORA metric in Devtron. @@ -102,6 +102,8 @@ Suppose your DevOps team is reviewing delivery performance for the last month. Y The **Triggers & Build Time** section provides a detailed view of your build and deployment activities in Devtron. It helps you understand how frequently builds and deployments are triggered, how long they take, and how successful they are over time. +{% embed url="https://app.supademo.com/demo/cmgvmh7mo4stnyzgyvk9dr2g7" %} + At the top, you will see three key indicators: | **Field** | **Description** | @@ -121,8 +123,6 @@ Below each indicator, you will also find a corresponding graph that visualizes i | **Last Month** | Shows activity from the previous month to help you analyze changes month-over-month| | **This Quarter**| Groups workflow data by the current quarter (**Jan-March**, **April-June**, **July-September**, or **October-December**) | -{% embed url="https://app.supademo.com/demo/cmgvmh7mo4stnyzgyvk9dr2g7" %} - ### Build Triggers Graph This graph displays how build triggers change over time. From 2490e8f920c310ae465a52f3ffab06297663ace9 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 23 Oct 2025 09:44:13 +0530 Subject: [PATCH 23/34] docs: implemented changes --- .../cost-visibility/configurations.md | 39 ++++++++++++---- .../cost-visibility/cost-breakdown.md | 44 +++++++++++-------- .../application-overview.md | 4 +- 3 files changed, 59 insertions(+), 28 deletions(-) diff --git a/docs/user-guide/cost-visibility/configurations.md b/docs/user-guide/cost-visibility/configurations.md index 3152925ee..f0afa60e6 100644 --- a/docs/user-guide/cost-visibility/configurations.md +++ b/docs/user-guide/cost-visibility/configurations.md @@ -35,6 +35,10 @@ To enable cost visibility for Google Cloud in Devtron, you need to generate an A 2. Now go back to the **Edit cluster** modal window, and enter the API key in the **Cloud Provider API Key** field. +{% hint style="info" %} +If you face any issues while enabling or configuring the **Cost Visibility** module, reach out to [Devtron Support Team](mailto:enterprise@devtron.ai) for assistance. +{% endhint %} + {% endtab %} {% tab title="Azure" %} @@ -65,7 +69,7 @@ To enable cost visibility for your Azure clusters in Devtron, you need to allow } ``` -2. Replace YOUR_SUBSCRIPTION_ID with your actual subscription ID. +2. Replace `YOUR_SUBSCRIPTION_ID` with your actual subscription ID. 3. Save the file as `myrole.json`. @@ -116,11 +120,15 @@ Now go back to the **Edit cluster** modal window, and fill the following fields: | Billing Account | Optional (fill if available) | | Offer ID | Optional (fill if available) | +{% hint style="info" %} +If you face any issues while enabling or configuring the **Cost Visibility** module, reach out to [Devtron Support Team](mailto:enterprise@devtron.ai) for assistance. +{% endhint %} + {% endtab %} {% tab title="AWS" %} -To enable cost visibility for AWS in Devtron, follow the below steps: +If you have spot node instances in your AWS cluster, then only you need to do the below additional configurations for your AWS cluster, else you can skip the below configurations ### Step 1: Set up a Spot Instance Data Feed @@ -158,8 +166,10 @@ To enable cost visibility for AWS in Devtron, follow the below steps: aws ec2 create-spot-datafeed-subscription \ --bucket devtron-spot-feed --prefix cost ``` +{% hint style="warning" %} +### Note +You can subscribe to the Spot Data Feed for only one S3 bucket at a time. Running the command again updates the feed to the latest bucket.{% endhint %} -**Note:** You can subscribe to the Spot Data Feed for only one S3 bucket at a time. Running the command again updates the feed to the latest bucket. ### Step 2: Create an IAM Role or Use Access Keys @@ -214,7 +224,16 @@ Now go back to the **Edit cluster** modal window, and fill the following fields: 5. Enter Prometheus endpoint of your cluster. Refer [Fetching Prometheus Endpoint](#fetching-prometheus-endpoint) to learn more. -6. Click **Save**. +{% hint style="warning" %} +Prometheus endpoint should be publicly exposed for the cost visibility to work. +{% endhint %} + +6. Click **Save**, cost visibility will be enabled for the cluster. + +{% hint style="warning"%} +### Note +After enabling cost visibility, you will see your cluster information after 1 hour in cost visibility module. +{% endhint %} ### Fetching Prometheus Endpoint @@ -271,7 +290,13 @@ To solve it, refer [Troubleshoot Issues](#common-pitfall-prometheus-deployment-t {% endhint %} -#### Set Up Prometheus Endpoint +5. After the chart deployed successfully, you need to make the Prometheus endpoint exposed publicly. + +{% hint style="info" %} +If you face any issues while enabling or configuring the **Cost Visibility** module, please contact the [Devtron Support Team](mailto:support@devtron.ai) for assistance. +{% endhint %} + + diff --git a/docs/user-guide/cost-visibility/cost-breakdown.md b/docs/user-guide/cost-visibility/cost-breakdown.md index b8156a3e8..9d7e01c65 100644 --- a/docs/user-guide/cost-visibility/cost-breakdown.md +++ b/docs/user-guide/cost-visibility/cost-breakdown.md @@ -4,14 +4,14 @@ While the **Overview** section gives you a quick summary of overall spending, th ![Figure 1: Cost Breakdown Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cost-visibility/cost-visibility-cost-breakdown.jpg) -At the top of the **Cost Breakdown** page, you can apply filters in the top-right corner to adjust the view. Selecting the right filters helps you to focus on the most relevant cost information for your preferred analysis. + You can apply filters in the top-right corner to adjust the view. Selecting the right filters helps you to focus on the most relevant cost information for your preferred analysis. -For example, you might want to analyze your most recent infrastructure spend across production clusters. In that case, you can set the Cluster Scope filter to `Production` and select a Time Range of Last 30 Days. This will give you a focused view of active workloads and recent spending trends, without including cost from other clusters. +For example, you might want to analyze your most recent infrastructure spend across production clusters. In that case, you can set the Clusters Scope filter to `Production` and select a Time Range of Last 30 Days. This will give you a focused view of active workloads and recent spending trends, without including cost from other clusters. {% hint style="success" %} ### Use Case -Imagine your team is reviewing this month’s cloud spends and wants to focus only on production clusters. You open the Cost Breakdown page, set the **Cluster Scope** to `Production`, choose your preferred Currency, and adjust the Time Range to Last 30 Days. Instantly, the data updates to show just the relevant costs, providing you a clear picture of active environments and helps you spot any unusual spending patterns. With these quick filters, your team can focus on costs within the defined scope, ensuring the analysis stays relevant to your current objective. +Imagine your team is reviewing this month’s cloud spends and wants to focus only on production clusters. You open the Cost Breakdown page, set the **Clusters Scope** to `Production`, choose your preferred Currency, and adjust the Time Range to Last 30 Days. Instantly, the data updates to show just the relevant costs, providing you a clear picture of active environments and helps you spot any unusual spending patterns. With these quick filters, your team can focus on costs within the defined scope, ensuring the analysis stays relevant to your current objective. {% endhint %} @@ -21,11 +21,13 @@ Imagine your team is reviewing this month’s cloud spends and wants to focus on | **Currency** | Displays all cost values in the currency of your choice. | | **Time Range** | Defines the time range for data displayed | +--- + ## Inspecting Different Categories For the chosen category type (**Clusters**, **Applications**, **Environments**, or **Projects**), it shows the following: -For example, if you select the Cluster category, you can view the total cost across all clusters, the recommended cost based on actual usage, and the potential savings if resources were optimized. This gives you a quick, high-level view of how efficiently each cluster is utilizing its allocated resources. +For example, if you select the Clusters category, you can view the total cost across all clusters, the recommended cost based on actual usage, and the potential savings if resources were optimized. This gives you a quick, high-level view of how efficiently each cluster is utilizing its allocated resources. {% hint style="success" %} @@ -38,28 +40,26 @@ Imagine your team is analyzing monthly infrastructure expenses for multiple clus |:--------------------------- |:----------------------------------------------------------------------------| | **Total Cost** | The actual spend for the selected category type (e.g., all clusters). | | **Recommended Cost** | The estimated cost calculated from actual resource usage instead of allocated capacity| -| **Potential Savings** | The percentage of your current spend that could be reduced| -| **Monthly Savings** | The estimated savings for one month based on the difference between allocated and used resources | -| **Annual Savings** | The projected savings over a year based on the same calculation| +| **Potential Savings** | The amount which you could have saved, for the selected time period| +| **Estimated cost reduction**| The percentage of your current spend that could be saved, for the selected time period | | **Top 10 Costly Resources** | A ranked list of 10 highest cost resources of the selected category| You will also find a complete list of all the resources for the selected category at the bottom, helping you identify where most of your spending is concentrated. -For example, if you’re viewing the Environment category, the list displays each environment along with its CPU, Memory, Storage, GPU, and Network costs. You can quickly compare environments and identify which ones have higher spend or greater potential savings. +For example, if you’re viewing the Cluster category, the list displays each cluster along with its CPU, Memory, Storage, GPU, and Network costs. You can quickly compare clusters and identify which ones have higher spend or greater potential savings. {% hint style="success" %} ### Use Case -Suppose, you’re reviewing costs within the **Environment** category. As you go through the list, you noticed, one environment's **Total Cost** is higher than others. -You look across its row and notice that both **CPU Cost** and **Memory Cost** are also on the higher side. The Potential Savings column then shows a clear opportunity to optimize usage within that environment. With this focused view, you get a clearer understanding of where your resources are being used most and which environments might need attention, all from a single, organized view. You can then check detailed view for those environments to investigate further. +Suppose you’re reviewing costs within the Clusters category. As you go through the list, you notice one cluster’s **Total Cost** is higher than others. You look across its row and notice that both Memory Cost and Storage (PV) Cost are also on the higher side. The **Potential Savings** column then shows a clear opportunity to optimize usage within that cluster. With this focused view, you get a clear understanding of where your resources are being used most and which clusters might need attention, all from a single, organized view. You can then check the detailed view for those clusters to investigate further. {% endhint %} Each row in the list shows the following for the specific resource of the selected category: -| Field | Available For Categories | Description | -|:------------------------|:---------------------------------|:-------------------------------------------------------------------- | +| Field | Available For Categories | Description | +|:-----------------------|:--------------------------------|:-------------------------------------------------------------------- | | **Provider** | Clusters | Shows the cloud provider or infrastructure source for each cluster | | **Type** | Clusters, Environments | Shows whether each cluster or environment is **Production** or **Non-Production** | | **Applications Count** | Environments, Projects | Shows the number of applications linked to each environment or project | @@ -78,14 +78,15 @@ Each row in the list shows the following for the specific resource of the select Clicking on any resource in the Cost Breakdown list opens its detailed cost breakdown view. Based on the category you will see the following: -For example, after identifying a high-cost Environment in the previous section, you can click on that environment to open its detailed breakdown. In the detailed breakdown view of the environment, you can see which Applications contribute most to its total cost, how resource types (like CPU, Memory, and Storage) are distributed. +For example, after identifying a high cost Cluster in the previous section, you can click on that cluster to open its detailed breakdown. In the detailed breakdown view of the cluster, you can see which Namespaces and Applications contribute most to its total cost, and how resource types (like CPU, Memory, and Storage) are distributed. {% hint style=“success” %} ### Use Case -Continuing from the earlier scenario, you open the detailed cost breakdown for the environment that showed unusually high costs. In the **Top 10 Costly Applications** section, one application clearly dominates the cost chart. You then look at the **Cost Breakdown by Resource Kind** graph, where it becomes clear that most of this cost comes from Memory usage. -Investigating further, you confirm that a recent update introduced higher memory requests for that application. This explains the cost spike you noticed earlier. With this insight, your team can review and right-size resource allocations to keep the environment’s cost under control while maintaining stable performance. +Continuing from the earlier scenario, you open the detailed cost breakdown for the cluster that showed unusually high costs. In the **Top 10 Costly Namespaces** section, one namespace clearly dominates the cost chart. You then look at the Cost Breakdown by Resource Kind graph, where it becomes evident that most of this cost comes from CPU usage. + +Investigating further, you discover that a few workloads in that namespace have been consistently running above their requested CPU limits. This explains the cost spike you noticed earlier. With this insight, your team can adjust resource requests and limits for those workloads to optimize cluster performance and reduce unnecessary costs. {% endhint %} @@ -110,6 +111,12 @@ Investigating further, you confirm that a recent update introduced higher memory **Custom Views** allows you to define your own filtered view of cluster costs. Instead of looking at costs for the entire cluster, you can create a focused view based on propagated tags (for example, filter by team, environment, or application tag). +{% hint style="warning" %} +### Note +This feature is available only under the Clusters category. +{% endhint %} + + For example, if your production workloads are labeled with `environment=production`, you can create a custom view to track cost of production workloads only. By creating a custom view with: @@ -131,9 +138,10 @@ Now, whenever you open Cost Visibility, you simply select the “Logistics Team {% endhint %} -This feature is available only under the Clusters category. - -**Note:** Custom Views are dependent on propagated tags (labels). If tags are not mentioned and propagated in the workloads, some resources may not appear in the view. Ensure that you have added and propagated tags for the workloads you want to include in the custom view. +{% hint style="warning" %} +### Note +Custom Views are dependent on propagated tags (labels). If tags are not mentioned and propagated in the workloads, some resources may not appear in the view. Ensure that you have added and propagated tags for the workloads you want to include in the custom view. +{% endhint %} #### Creating a Custom View diff --git a/docs/user-guide/creating-application/application-overview.md b/docs/user-guide/creating-application/application-overview.md index 502d20245..82c6b716c 100644 --- a/docs/user-guide/creating-application/application-overview.md +++ b/docs/user-guide/creating-application/application-overview.md @@ -117,11 +117,11 @@ Below each indicator, you will also find a corresponding graph that visualizes i | Option | Description | |:----------------|:-------------| | **Today** | Shows build and deployment activity for the current day | -| **This Week** | Displays data from the current week | +| **This Week** | Displays data from the current week (Monday-Sunday) | | **Last Week** | Displays data from the previous week for comparison | | **This Month** | Aggregates data for the ongoing month | | **Last Month** | Shows activity from the previous month to help you analyze changes month-over-month| -| **This Quarter**| Groups workflow data by the current quarter (**Jan-March**, **April-June**, **July-September**, or **October-December**) | +| **This Quarter**| Groups workflow data by the current quarter (**April-June**, **July-September**, **October-December**, or **Jan-March**) | ### Build Triggers Graph From 93b5bf9e5c1b37c3e44c8b18e9e240a4e223e477 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 23 Oct 2025 17:25:10 +0530 Subject: [PATCH 24/34] docs: replaced supademos --- .../cost-visibility/cost-breakdown.md | 6 ++- .../overview-cost-visibility.md | 43 +++++++++++++++++-- .../application-overview.md | 33 +++++++++++++- 3 files changed, 76 insertions(+), 6 deletions(-) diff --git a/docs/user-guide/cost-visibility/cost-breakdown.md b/docs/user-guide/cost-visibility/cost-breakdown.md index 9d7e01c65..f4fda9011 100644 --- a/docs/user-guide/cost-visibility/cost-breakdown.md +++ b/docs/user-guide/cost-visibility/cost-breakdown.md @@ -1,5 +1,7 @@ # Cost Breakdown +## Introduction + While the **Overview** section gives you a quick summary of overall spending, the **Cost Breakdown** page lets you analyze deeper into where those costs come from. It helps you analyze costs within a selected category (**Clusters**, **Applications**, **Environments**, or **Projects**), for a specific time range. ![Figure 1: Cost Breakdown Overview](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/cost-visibility/cost-visibility-cost-breakdown.jpg) @@ -159,7 +161,7 @@ To create a custom view: Once applied, a Custom View works just like any other category breakdown in Cost Visibility. -### Filters +#### Filters | **Field** | **Description** | |--------------|---------------------------------------------------------------------------------| @@ -167,7 +169,7 @@ Once applied, a Custom View works just like any other category breakdown in Cost | **Operator** | Defines the comparison logic between the key and value. | | **Value** | The label value to match against (for example, `logistics`, `prod`). | -### Operators +#### Operators | **Operator** | **Meaning** | **Example** | |--------------|--------------------------|--------------------------------------------| diff --git a/docs/user-guide/cost-visibility/overview-cost-visibility.md b/docs/user-guide/cost-visibility/overview-cost-visibility.md index 740775e71..34da55e72 100644 --- a/docs/user-guide/cost-visibility/overview-cost-visibility.md +++ b/docs/user-guide/cost-visibility/overview-cost-visibility.md @@ -108,9 +108,9 @@ Each bar represents one [Application](../../reference/glossary.md#devtron-apps), The **Cost Trend** line chart helps you understand, how your total and individual resource usage costs change over time. It helps you analyze spending patterns and identify which resources contribute most to your overall cost. -{% embed url="https://app.supademo.com/demo/cmgg88zje6r362nom7ko7mz4t" %} +{% embed url="https://app.supademo.com/demo/cmh343wdi09qkcdwp0vw8ncaw" %} -Each colored line represents a specific resource, CPU, Memory, Storage, Network, or GPU, while the Total line combines all costs. Hovering over any point on the graph displays the exact cost breakdown for that day. +Each colored line represents a specific infrastructure component, CPU, Memory, Storage, Network, or GPU, while the Total line combines all costs. Hovering over any point on the graph displays the exact cost breakdown for that day. You can change the time range (for example, Last 7 Days, Last 30 Days, or Last 90 Days) to view trends for a specific period. @@ -137,6 +137,8 @@ You can change the time range (for example, Last 7 Days, Last 30 Days, or Last 9 The Most Cost Efficient section helps you identify which resources are utilizing costs most effectively across different scopes, such as Cluster, Application, Environment, or Project. +{% embed url="https://app.supademo.com/demo/cmh344vs309sicdwphlwbua6e" %} + Each row in the list displays | **Field** | **Description** | @@ -157,6 +159,8 @@ You can use the dropdown menus to customize your view: The Most Expensive section highlights the clusters, applications, environments, or projects that contribute the highest costs over a selected time range. This helps you quickly identify where your infrastructure expenses are concentrated and which components may require optimization. +{% embed url="https://app.supademo.com/demo/cmh34ohno0au7cdwpoz8p8bgg" %} + Each row in the list displays: | **Field** | **Description** | @@ -177,6 +181,8 @@ You can customize the view using the following filters: The Actions & Insights section highlights where you can achieve the highest cost savings. It shows the categories with the largest cost saving opportunities, based on the difference between allocated resources and your actual usage. +{% embed url="https://app.supademo.com/demo/cmgj316cr0x93krn9l7g4uo7a" %} + It also shows the cost visibility status, which displays the number of clusters where cost visibility is enabled, failed, in progress, or not enabled. This helps you understand for which clusters cost data is currently being tracked and if you want you can enable/disable cost tracking for the cluster by clicking on **Go to configurations** button. Refer [configurations](./configurations.md) to learn more. Each category in the **Top saving opportunities** will show @@ -189,4 +195,35 @@ Each category in the **Top saving opportunities** will show Clicking on any item in this list takes you to its detailed Cost Breakdown page. Refer [Cost Breakdown](./cost-breakdown.md) to learn more. -{% embed url="https://app.supademo.com/demo/cmgj316cr0x93krn9l7g4uo7a" %} +--- + +## FAQs + +
+1. Why am I not seeing cost data on the Overview page? +Cost Visibility is only supported for **Devtron** and **Helm** applications. +If you’re only using **Argo CD** or **Flux** apps, their cost data won’t appear. +Also, ensure that **Cost Visibility** is enabled for your cluster, refer [Configurations](./configurations.md) to learn more. +
+ +
+2. What should I do if the graphs look empty or incomplete? +This usually happens when cost tracking is not enabled for certain clusters or when there’s no activity in the selected time range. +Try expanding the time range. +
+ +
+3. Can I compare costs across different clusters or applications? +Yes. The **Cost Breakdown**, let you compare spend across **Clusters**, **Applications**, **Environments**, or **Projects**. +You can also use filters and sorting options to focus on a specific scope or resource type. +
+ +
+4. What does Potential Savings mean in simple terms? +It shows how much you could save if your resources were right-sized, i.e, it’s the difference between what you’ve **allocated** and what you actually **use**. +
+ +
+5. How often is the cost data updated? +Cost data is refreshed **automatically every hour**, based on the latest metrics from Prometheus. +
diff --git a/docs/user-guide/creating-application/application-overview.md b/docs/user-guide/creating-application/application-overview.md index 82c6b716c..6e4d8ca4d 100644 --- a/docs/user-guide/creating-application/application-overview.md +++ b/docs/user-guide/creating-application/application-overview.md @@ -225,4 +225,35 @@ These insights help you ensure that the right governance controls are followed, | **Field** | **Description** | |:-----------|:----------------| | **Config Change Approval** | Indicates the percentage of pipelines that require approval before applying configuration changes| -| **Deployment Approval** | Indicates the percentage of pipelines that require approval before executing a deployment | \ No newline at end of file +| **Deployment Approval** | Indicates the percentage of pipelines that require approval before executing a deployment | + +## FAQs + +
+1. Why do the counts of Devtron and Helm applications differ from what I see in my dashboards? +The counts displayed in the application overview across **all connected clusters**, which are reachable. If some applications are missing, verify that, the clusters where they are deployed are reachable. + +Disconnected clusters or standalone Helm releases won’t appear until Devtron syncs them. + +If still you cannot see your applications, contact [Devtron Support]() for assistant. +
+ +
+2. Why do my triggers or build time graphs look empty? +Graphs may appear blank if: +* No builds or deployments were triggered during the selected **Time Range** +* Pipelines were recently created and have no activity yet +Try expanding the time filter (for example, from **This Week** to **Last 30 Days**) or verifying pipeline execution history. +
+ +
+3. Why do I see cost data for some applications but not others? +Cost data appears only for applications deployed in clusters where **Cost Visibility** is enabled. +If a cluster doesn’t have cost visibility enabled, its data won’t appear. +You can enable it under **Cost Visibility** → **Configurations** to start tracking cost for those applications. Refer [Configurations](../cost-visibility/configurations.md) to learn more. +
+ +
+4. How frequently are these metrics updated? +Metrics on the **Application Overview** page are refreshed automatically every hour. +
\ No newline at end of file From 46d05098251f55af20247b04954a4942894c6946 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 23 Oct 2025 21:12:42 +0530 Subject: [PATCH 25/34] docs: implemented changes --- .../cost-visibility/cost-breakdown.md | 37 ++++++++++++++++++- .../application-overview.md | 2 +- .../infrastructure-overview.md | 10 ++--- 3 files changed, 42 insertions(+), 7 deletions(-) diff --git a/docs/user-guide/cost-visibility/cost-breakdown.md b/docs/user-guide/cost-visibility/cost-breakdown.md index f4fda9011..90bfd3411 100644 --- a/docs/user-guide/cost-visibility/cost-breakdown.md +++ b/docs/user-guide/cost-visibility/cost-breakdown.md @@ -178,4 +178,39 @@ Once applied, a Custom View works just like any other category breakdown in Cost | `~:` | Contains | `name ~: api` → selects resources where label contains `api`. | | `!~` | Not Contains | `app !~: test` → excludes resources where label contains `test`. | | `<~` | Contains Prefix | `env <~: prod` → selects resources where label starts with `prod`. | -| `!<~` | Not Contains Prefix | `env !<~: staging` → excludes resources where label starts with `staging`. | \ No newline at end of file +| `!<~` | Not Contains Prefix | `env !<~: staging` → excludes resources where label starts with `staging`. | + +--- + +## FAQs + +## FAQs + +
+1. Why does Cost Visibility show data for some clusters but not others? +Cost data appears only for clusters where **Cost Visibility** is enabled. +If a cluster doesn’t show cost insights, verify that the **Cost Visibility** module is active for that cluster. + +Refer [Configurations](./configurations.md) to learn more. +
+ +
+2. What does **Connection Failed** mean in Cluster Health Status? +**Connection Failed** means Devtron could not reach the cluster’s API server or retrieve data from it. +This can happen due to: +* Network or firewall restrictions +* Expired or invalid Kubernetes credentials +* Misconfigured cluster agent + +Try revalidating credentials or redeploying the Devtron agent to restore connectivity. +
+ +
+3. Why does a cluster show **Not Detected** under Autoscaler in Node Counts? +This means Devtron couldn’t identify any predefined autoscaling configuration, it can be a custom autoscaler. +
+ +
+4. How often is the infrastructure data updated? +Infrastructure data (including metrics, cost, and health status) is refreshed automatically every hour. +
\ No newline at end of file diff --git a/docs/user-guide/creating-application/application-overview.md b/docs/user-guide/creating-application/application-overview.md index 6e4d8ca4d..f4fa2758c 100644 --- a/docs/user-guide/creating-application/application-overview.md +++ b/docs/user-guide/creating-application/application-overview.md @@ -235,7 +235,7 @@ The counts displayed in the application overview across **all connected clusters Disconnected clusters or standalone Helm releases won’t appear until Devtron syncs them. -If still you cannot see your applications, contact [Devtron Support]() for assistant. +If still you cannot see your applications, contact [Devtron Support](mailto:enterprise@devtron.ai) for assistant.
diff --git a/docs/user-guide/creating-application/infrastructure-overview.md b/docs/user-guide/creating-application/infrastructure-overview.md index 602eb6e75..ca1ade15b 100644 --- a/docs/user-guide/creating-application/infrastructure-overview.md +++ b/docs/user-guide/creating-application/infrastructure-overview.md @@ -117,11 +117,11 @@ Each bar represents one Application, Cluster, Environment, or Project, and the c | Resource Type | Color Used in Chart | |:--------------------- |:---------------------| -| **CPU Cost** | LimeGreen | -| **Memory Cost** | SkyBlue | -| **Storage (PV) Cost** | AquaTeal | -| **GPU Cost** | Magenta | -| **Network Cost** | GoldenYellow | +| **CPU Cost** | LimeGreen | +| **Memory Cost** | SkyBlue | +| **Storage (PV) Cost** | AquaTeal | +| **GPU Cost** | Magenta | +| **Network Cost** | GoldenYellow | #### Filters From 618bc43261cf48897ac78344363cf043673bfc6d Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 23 Oct 2025 21:21:00 +0530 Subject: [PATCH 26/34] docs: minor fix --- docs/user-guide/cost-visibility/cost-breakdown.md | 2 -- docs/user-guide/cost-visibility/overview-cost-visibility.md | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/user-guide/cost-visibility/cost-breakdown.md b/docs/user-guide/cost-visibility/cost-breakdown.md index 90bfd3411..acef51713 100644 --- a/docs/user-guide/cost-visibility/cost-breakdown.md +++ b/docs/user-guide/cost-visibility/cost-breakdown.md @@ -184,8 +184,6 @@ Once applied, a Custom View works just like any other category breakdown in Cost ## FAQs -## FAQs -
1. Why does Cost Visibility show data for some clusters but not others? Cost data appears only for clusters where **Cost Visibility** is enabled. diff --git a/docs/user-guide/cost-visibility/overview-cost-visibility.md b/docs/user-guide/cost-visibility/overview-cost-visibility.md index 34da55e72..69f937ae4 100644 --- a/docs/user-guide/cost-visibility/overview-cost-visibility.md +++ b/docs/user-guide/cost-visibility/overview-cost-visibility.md @@ -226,4 +226,4 @@ It shows how much you could save if your resources were right-sized, i.e, it’s
5. How often is the cost data updated? Cost data is refreshed **automatically every hour**, based on the latest metrics from Prometheus. -
+
\ No newline at end of file From c03fc0e7b571811985c3925e370fa8e285986948 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 23 Oct 2025 21:29:13 +0530 Subject: [PATCH 27/34] docs: minor fixes --- .../overview-cost-visibility.md | 2 +- .../infrastructure-overview.md | 42 +++++++++++++++++-- 2 files changed, 39 insertions(+), 5 deletions(-) diff --git a/docs/user-guide/cost-visibility/overview-cost-visibility.md b/docs/user-guide/cost-visibility/overview-cost-visibility.md index 69f937ae4..b1869db6b 100644 --- a/docs/user-guide/cost-visibility/overview-cost-visibility.md +++ b/docs/user-guide/cost-visibility/overview-cost-visibility.md @@ -18,7 +18,7 @@ Cost Overview has the following sections: {% hint style="info" %} ### Note Cost Visibility is currently supported **only for Devtron and Helm applications**. -It is **not available** for applications deployed through **Argo CD** or **Flux**. +It is **not available** for applications deployed externally through **Argo CD** or **Flux**. {% endhint %} ## At a Glance diff --git a/docs/user-guide/creating-application/infrastructure-overview.md b/docs/user-guide/creating-application/infrastructure-overview.md index ca1ade15b..1f28dd9c4 100644 --- a/docs/user-guide/creating-application/infrastructure-overview.md +++ b/docs/user-guide/creating-application/infrastructure-overview.md @@ -15,7 +15,7 @@ It contains the following sections: ## At a Glance -The At a Glance section helps you quickly understand the overall state of your connected clusters and available resources. It helps you understand your current infrastructure capacity and connectivity status at a single glance. +The **At a Glance** section helps you quickly understand the overall state of your connected clusters and available resources. It helps you understand your current infrastructure capacity and connectivity status at a single glance. {% embed url="https://app.supademo.com/demo/cmh0e4sh81naf6nxtlvrh3kwy" %} @@ -77,11 +77,12 @@ The **Cluster Capacity & Resource Allocation** section provides a detailed view | **CPU** | Displays the total CPU capacity, along with utilization, requests, and limits for each cluster. This helps you track compute usage and detect over-provisioning | | **Memory** | Displays the total memory capacity, along with utilization, requests, and limits for each cluster. It helps you ensure workloads are balanced, and resource allocation is efficient | -You can **sort** the data by: +You can sort the data by: * **Cluster Name** (A to Z or Z to A) * **Utilization** (High to Low or Low to High) {% hint style="info" %} +### Note If a cluster shows zero utilization or capacity, it may be inactive or disconnected. Verify its status under **Cluster Configuration**. {% endhint %} @@ -99,7 +100,7 @@ It provides a quick overview of your cluster node density and helps identify env | **By Cluster** | This graph displays the total number of nodes within each cluster. Each bar shows the number of clusters within a specific cluster. This view helps you assess how evenly nodes are distributed and whether specific clusters may be over or under-provisioned | | **By Autoscaler** | Groups nodes based on their autoscaling configuration (for example, **GKE Automode** or **Not Detected**). Each bar shows the number of nodes within the autoscaling configuration| -You can **sort** the chart data using the dropdown in the top-right corner: +You can sort the chart data using the dropdown in the top-right corner: * **High to Low** or **Low to High**, to focus on clusters with the most or fewest nodes. {% hint style="info" %} @@ -145,7 +146,7 @@ Each bar represents one Application, Cluster, Environment, or Project, and the c ## Actions and Insights -The Actions & Insights section highlights where you can achieve the highest cost savings. It shows the categories with the largest cost saving opportunities, based on the difference between allocated resources and your actual usage. +The **Actions & Insights** section highlights where you can achieve the highest cost savings. It shows the categories with the largest cost saving opportunities, based on the difference between allocated resources and your actual usage. {% embed url="https://app.supademo.com/demo/cmh1u9uss0fvjnitlk1tn4lv0" %} @@ -170,3 +171,36 @@ Clicking on any item in this list takes you to its detailed Cost Breakdown page. 3. A pop-up modal will appear, select the target version, and click scan cluster. 4. A Page will open, with the summary of all the API-endpoints that are compatible for upgrading. You can also check **Deprecated Fields** (Against current API version), **Resources with no PDB**, **Resources with 0 Disruption PDB** + +--- + +## FAQs + +
+1. Why does Cost Visibility show data for some clusters but not others? +Cost data appears only for clusters where **Cost Visibility** is enabled. +If a cluster doesn’t show cost insights, verify that the **Cost Visibility** module is active for that cluster. + +Refer [Configurations](./configurations.md) to learn more. +
+ +
+2. What does **Connection Failed** mean in Cluster Health Status? +**Connection Failed** means Devtron could not reach the cluster’s API server or retrieve data from it. +This can happen due to: +* Network or firewall restrictions +* Expired or invalid Kubernetes credentials +* Misconfigured cluster agent + +Try revalidating credentials or redeploying the Devtron agent to restore connectivity. +
+ +
+3. Why does a cluster show **Not Detected** under Autoscaler in Node Counts? +This means Devtron couldn’t identify any predefined autoscaling configuration, it can be a custom autoscaler. +
+ +
+4. How often is the infrastructure data updated? +Infrastructure data (including metrics, cost, and health status) is refreshed automatically every hour. +
\ No newline at end of file From b07676a1d894d56cc85521a2316f5f7307c45d02 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 23 Oct 2025 21:52:56 +0530 Subject: [PATCH 28/34] docs: changes implemented over the call --- docs/user-guide/cost-visibility/README.md | 2 +- .../user-guide/cost-visibility/configurations.md | 10 +++++----- .../user-guide/cost-visibility/cost-breakdown.md | 2 +- .../cost-visibility/overview-cost-visibility.md | 6 +++--- .../creating-application/application-overview.md | 16 ++++++++-------- .../infrastructure-overview.md | 2 +- 6 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/user-guide/cost-visibility/README.md b/docs/user-guide/cost-visibility/README.md index de03a0fa6..1fef48c7c 100644 --- a/docs/user-guide/cost-visibility/README.md +++ b/docs/user-guide/cost-visibility/README.md @@ -1,5 +1,5 @@ # Cost Visibility -## Introduction +## Introduction [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing) Cost Visibility in Devtron provides a unified view of your Kubernetes infrastructure costs within the Devtron dashboard. It eliminates the need to switch between cloud provider billing consoles by integrating cost insights directly into your DevOps workflow. diff --git a/docs/user-guide/cost-visibility/configurations.md b/docs/user-guide/cost-visibility/configurations.md index f0afa60e6..886493ea4 100644 --- a/docs/user-guide/cost-visibility/configurations.md +++ b/docs/user-guide/cost-visibility/configurations.md @@ -246,7 +246,7 @@ Ensure [GitOps](../global-configurations/gitops.md) is configured before deployi 1. Go to the **Chart Store** and search for `prometheus`. Use the Prometheus community's `kube-prometheus-stack` chart to deploy Prometheus. - ![Figure : Chart Store](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app2.jpg) + ![Figure 1: Chart Store](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app2.jpg) 2. After selecting the chart, configure these values as needed before deployment. @@ -267,9 +267,9 @@ Ensure [GitOps](../global-configurations/gitops.md) is configured before deployi Search for the above parameters, and update them as shown (or customize as needed). - ![Figure a: Prometheus Chart Configuration](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app3.jpg) + ![Figure 2a: Prometheus Chart Configuration](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app3.jpg) - ![Figure b: Prometheus Chart Configuration (cont.)](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app-metrics-config.jpg) + ![Figure 2b: Prometheus Chart Configuration (cont.)](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app-metrics-config.jpg) 3. Enable `upgradeJob` parameter to install CRDs: @@ -277,7 +277,7 @@ Ensure [GitOps](../global-configurations/gitops.md) is configured before deployi In the Prometheus Helm chart settings, locate the `upgradeJob` parameter and set it to `true` if it is `false`. - ![Figure : upgradeJob Parameter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app-new2.jpg) + ![Figure 3: upgradeJob Parameter](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app-new2.jpg) 4. After enabling the parameter, click **Deploy Chart**. @@ -307,7 +307,7 @@ Only super admin users can set up Prometheus endpoint in a cluster. 2. Copy the URL of the `kube-prometheus` service as shown in the image below. - ![Figure : Prometheus Service](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app4.jpg) + ![Figure 4: Prometheus Service](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app4.jpg) 3. Now enter the Prometheus endpoint: 1. Paste the copied URL into the Prometheus endpoint field, ensuring it includes `http://` diff --git a/docs/user-guide/cost-visibility/cost-breakdown.md b/docs/user-guide/cost-visibility/cost-breakdown.md index acef51713..7fb1b0ee7 100644 --- a/docs/user-guide/cost-visibility/cost-breakdown.md +++ b/docs/user-guide/cost-visibility/cost-breakdown.md @@ -1,6 +1,6 @@ # Cost Breakdown -## Introduction +## Introduction [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing) While the **Overview** section gives you a quick summary of overall spending, the **Cost Breakdown** page lets you analyze deeper into where those costs come from. It helps you analyze costs within a selected category (**Clusters**, **Applications**, **Environments**, or **Projects**), for a specific time range. diff --git a/docs/user-guide/cost-visibility/overview-cost-visibility.md b/docs/user-guide/cost-visibility/overview-cost-visibility.md index b1869db6b..af929c58a 100644 --- a/docs/user-guide/cost-visibility/overview-cost-visibility.md +++ b/docs/user-guide/cost-visibility/overview-cost-visibility.md @@ -135,7 +135,7 @@ You can change the time range (for example, Last 7 Days, Last 30 Days, or Last 9 ### Most Cost Efficient -The Most Cost Efficient section helps you identify which resources are utilizing costs most effectively across different scopes, such as Cluster, Application, Environment, or Project. +The **Most Cost Efficient** section helps you identify which resources are utilizing costs most effectively across different scopes, such as Cluster, Application, Environment, or Project. {% embed url="https://app.supademo.com/demo/cmh344vs309sicdwphlwbua6e" %} @@ -157,7 +157,7 @@ You can use the dropdown menus to customize your view: ### Most Expensive -The Most Expensive section highlights the clusters, applications, environments, or projects that contribute the highest costs over a selected time range. This helps you quickly identify where your infrastructure expenses are concentrated and which components may require optimization. +The **Most Expensive** section highlights the clusters, applications, environments, or projects that contribute the highest costs over a selected time range. This helps you quickly identify where your infrastructure expenses are concentrated and which components may require optimization. {% embed url="https://app.supademo.com/demo/cmh34ohno0au7cdwpoz8p8bgg" %} @@ -179,7 +179,7 @@ You can customize the view using the following filters: ## Actions and Insights -The Actions & Insights section highlights where you can achieve the highest cost savings. It shows the categories with the largest cost saving opportunities, based on the difference between allocated resources and your actual usage. +The **Actions & Insights** section highlights where you can achieve the highest cost savings. It shows the categories with the largest cost saving opportunities, based on the difference between allocated resources and your actual usage. {% embed url="https://app.supademo.com/demo/cmgj316cr0x93krn9l7g4uo7a" %} diff --git a/docs/user-guide/creating-application/application-overview.md b/docs/user-guide/creating-application/application-overview.md index f4fa2758c..bfe436eed 100644 --- a/docs/user-guide/creating-application/application-overview.md +++ b/docs/user-guide/creating-application/application-overview.md @@ -126,9 +126,9 @@ Below each indicator, you will also find a corresponding graph that visualizes i ### Build Triggers Graph This graph displays how build triggers change over time. -* **Blue line:** Total build triggers -* **Green line:** Successful builds -* **Red line:** Failed builds +* **Blue line** - Total build triggers +* **Green line** - Successful builds +* **Red line** - Failed builds Hover over any point on the graph to view daily build statistics, including total, successful, and failed builds. This helps you identify trends in build frequency and stability. @@ -136,9 +136,9 @@ Hover over any point on the graph to view daily build statistics, including tota This graph tracks how often deployments are triggered and how many of them succeed or fail. -* **Blue line:** Total deployments triggered -* **Green line:** Successful deployments -* **Red line:** Failed deployments +* **Blue line** - Total deployments triggered +* **Green line** - Successful deployments +* **Red line** - Failed deployments Hover over a specific date to see deployment counts and outcomes, helping you understand deployment frequency and reliability trends. @@ -199,9 +199,9 @@ The **Cost Visibility** section provides a comparison of costs across your appli It shows: - * **Top 10 Costly Applications**: It shows which deployed applications consume the most resources (such as CPU, memory, or storage) across your clusters. + * **Top 10 Costly Applications** - It shows which deployed applications consume the most resources (such as CPU, memory, or storage) across your clusters. - * **Top 10 Costly Build Pipelines**: It shows the list of build pipelines that have the highest cost during image builds. + * **Top 10 Costly Build Pipelines** - It shows the list of build pipelines that have the highest cost during image builds. You can use the time range filter (Last 24 Hours, Last 7 Days, Last 30 Days, or Last 90 Days) to select the preferred time range. diff --git a/docs/user-guide/creating-application/infrastructure-overview.md b/docs/user-guide/creating-application/infrastructure-overview.md index 1f28dd9c4..826587613 100644 --- a/docs/user-guide/creating-application/infrastructure-overview.md +++ b/docs/user-guide/creating-application/infrastructure-overview.md @@ -170,7 +170,7 @@ Clicking on any item in this list takes you to its detailed Cost Breakdown page. 3. A pop-up modal will appear, select the target version, and click scan cluster. -4. A Page will open, with the summary of all the API-endpoints that are compatible for upgrading. You can also check **Deprecated Fields** (Against current API version), **Resources with no PDB**, **Resources with 0 Disruption PDB** +4. A page will open, with the summary of all the API-endpoints that are compatible for upgrading. You can also check **Deprecated Fields** (Against current API version), **Resources with no PDB**, **Resources with 0 Disruption PDB** --- From 0eb415b7a5d0f7eff19e6cca559677dbfa353787 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 23 Oct 2025 21:53:33 +0530 Subject: [PATCH 29/34] docs: changes implemented over the call part 2 --- docs/user-guide/cost-visibility/configurations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/cost-visibility/configurations.md b/docs/user-guide/cost-visibility/configurations.md index 886493ea4..8a296b088 100644 --- a/docs/user-guide/cost-visibility/configurations.md +++ b/docs/user-guide/cost-visibility/configurations.md @@ -1,4 +1,4 @@ -# Configurations +# Configurations The **Configurations** page lets you manage configurations for Cost Visibility in Devtron. You can: From 3fc47095142ce8ecc3da7433bf18f8bec10bb13a Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Thu, 23 Oct 2025 21:53:55 +0530 Subject: [PATCH 30/34] docs: changes implemented over the call part 3 --- docs/user-guide/cost-visibility/overview-cost-visibility.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/cost-visibility/overview-cost-visibility.md b/docs/user-guide/cost-visibility/overview-cost-visibility.md index af929c58a..65183d573 100644 --- a/docs/user-guide/cost-visibility/overview-cost-visibility.md +++ b/docs/user-guide/cost-visibility/overview-cost-visibility.md @@ -1,6 +1,6 @@ # Overview -## Introduction +## Introduction [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing) The **Overview** page provides a summary of infrastructure costs across your Applications, Clusters, Environments, Projects, and Infra Components in Devtron. It highlights overall spend, resource-level distribution, and opportunities for optimization (Potential Savings). From dc6b9d7cae7bb770b5749a16f8f081ec62e6e07e Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Fri, 24 Oct 2025 00:23:28 +0530 Subject: [PATCH 31/34] docs: fixed Faqs --- docs/user-guide/cost-visibility/cost-breakdown.md | 4 ++++ docs/user-guide/cost-visibility/overview-cost-visibility.md | 5 +++++ docs/user-guide/creating-application/application-overview.md | 4 ++++ .../creating-application/infrastructure-overview.md | 4 ++++ 4 files changed, 17 insertions(+) diff --git a/docs/user-guide/cost-visibility/cost-breakdown.md b/docs/user-guide/cost-visibility/cost-breakdown.md index 7fb1b0ee7..d951f1f27 100644 --- a/docs/user-guide/cost-visibility/cost-breakdown.md +++ b/docs/user-guide/cost-visibility/cost-breakdown.md @@ -186,6 +186,7 @@ Once applied, a Custom View works just like any other category breakdown in Cost
1. Why does Cost Visibility show data for some clusters but not others? + Cost data appears only for clusters where **Cost Visibility** is enabled. If a cluster doesn’t show cost insights, verify that the **Cost Visibility** module is active for that cluster. @@ -194,6 +195,7 @@ Refer [Configurations](./configurations.md) to learn more.
2. What does **Connection Failed** mean in Cluster Health Status? + **Connection Failed** means Devtron could not reach the cluster’s API server or retrieve data from it. This can happen due to: * Network or firewall restrictions @@ -205,10 +207,12 @@ Try revalidating credentials or redeploying the Devtron agent to restore connect
3. Why does a cluster show **Not Detected** under Autoscaler in Node Counts? + This means Devtron couldn’t identify any predefined autoscaling configuration, it can be a custom autoscaler.
4. How often is the infrastructure data updated? + Infrastructure data (including metrics, cost, and health status) is refreshed automatically every hour.
\ No newline at end of file diff --git a/docs/user-guide/cost-visibility/overview-cost-visibility.md b/docs/user-guide/cost-visibility/overview-cost-visibility.md index 65183d573..6244e1100 100644 --- a/docs/user-guide/cost-visibility/overview-cost-visibility.md +++ b/docs/user-guide/cost-visibility/overview-cost-visibility.md @@ -201,6 +201,7 @@ Clicking on any item in this list takes you to its detailed Cost Breakdown page.
1. Why am I not seeing cost data on the Overview page? + Cost Visibility is only supported for **Devtron** and **Helm** applications. If you’re only using **Argo CD** or **Flux** apps, their cost data won’t appear. Also, ensure that **Cost Visibility** is enabled for your cluster, refer [Configurations](./configurations.md) to learn more. @@ -208,22 +209,26 @@ Also, ensure that **Cost Visibility** is enabled for your cluster, refer [Config
2. What should I do if the graphs look empty or incomplete? + This usually happens when cost tracking is not enabled for certain clusters or when there’s no activity in the selected time range. Try expanding the time range.
3. Can I compare costs across different clusters or applications? + Yes. The **Cost Breakdown**, let you compare spend across **Clusters**, **Applications**, **Environments**, or **Projects**. You can also use filters and sorting options to focus on a specific scope or resource type.
4. What does Potential Savings mean in simple terms? + It shows how much you could save if your resources were right-sized, i.e, it’s the difference between what you’ve **allocated** and what you actually **use**.
5. How often is the cost data updated? + Cost data is refreshed **automatically every hour**, based on the latest metrics from Prometheus.
\ No newline at end of file diff --git a/docs/user-guide/creating-application/application-overview.md b/docs/user-guide/creating-application/application-overview.md index bfe436eed..1233a5b2a 100644 --- a/docs/user-guide/creating-application/application-overview.md +++ b/docs/user-guide/creating-application/application-overview.md @@ -231,6 +231,7 @@ These insights help you ensure that the right governance controls are followed,
1. Why do the counts of Devtron and Helm applications differ from what I see in my dashboards? + The counts displayed in the application overview across **all connected clusters**, which are reachable. If some applications are missing, verify that, the clusters where they are deployed are reachable. Disconnected clusters or standalone Helm releases won’t appear until Devtron syncs them. @@ -240,6 +241,7 @@ If still you cannot see your applications, contact [Devtron Support](mailto:ente
2. Why do my triggers or build time graphs look empty? + Graphs may appear blank if: * No builds or deployments were triggered during the selected **Time Range** * Pipelines were recently created and have no activity yet @@ -248,6 +250,7 @@ Try expanding the time filter (for example, from **This Week** to **Last 30 Days
3. Why do I see cost data for some applications but not others? + Cost data appears only for applications deployed in clusters where **Cost Visibility** is enabled. If a cluster doesn’t have cost visibility enabled, its data won’t appear. You can enable it under **Cost Visibility** → **Configurations** to start tracking cost for those applications. Refer [Configurations](../cost-visibility/configurations.md) to learn more. @@ -255,5 +258,6 @@ You can enable it under **Cost Visibility** → **Configurations** to start trac
4. How frequently are these metrics updated? + Metrics on the **Application Overview** page are refreshed automatically every hour.
\ No newline at end of file diff --git a/docs/user-guide/creating-application/infrastructure-overview.md b/docs/user-guide/creating-application/infrastructure-overview.md index 826587613..4b960fd6d 100644 --- a/docs/user-guide/creating-application/infrastructure-overview.md +++ b/docs/user-guide/creating-application/infrastructure-overview.md @@ -178,6 +178,7 @@ Clicking on any item in this list takes you to its detailed Cost Breakdown page.
1. Why does Cost Visibility show data for some clusters but not others? + Cost data appears only for clusters where **Cost Visibility** is enabled. If a cluster doesn’t show cost insights, verify that the **Cost Visibility** module is active for that cluster. @@ -186,6 +187,7 @@ Refer [Configurations](./configurations.md) to learn more.
2. What does **Connection Failed** mean in Cluster Health Status? + **Connection Failed** means Devtron could not reach the cluster’s API server or retrieve data from it. This can happen due to: * Network or firewall restrictions @@ -197,10 +199,12 @@ Try revalidating credentials or redeploying the Devtron agent to restore connect
3. Why does a cluster show **Not Detected** under Autoscaler in Node Counts? + This means Devtron couldn’t identify any predefined autoscaling configuration, it can be a custom autoscaler.
4. How often is the infrastructure data updated? + Infrastructure data (including metrics, cost, and health status) is refreshed automatically every hour.
\ No newline at end of file From 62263c269831e1bc29524f421ceca7246bacaabf Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Fri, 24 Oct 2025 00:24:26 +0530 Subject: [PATCH 32/34] docs: fixed links --- .../creating-application/infrastructure-overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/creating-application/infrastructure-overview.md b/docs/user-guide/creating-application/infrastructure-overview.md index 4b960fd6d..c1aefb630 100644 --- a/docs/user-guide/creating-application/infrastructure-overview.md +++ b/docs/user-guide/creating-application/infrastructure-overview.md @@ -160,7 +160,7 @@ Each item in the **Top saving opportunities** will show | **Potential Savings (%)** | The percentage of your current spend that could be saved, for the selected time range | | **Estimated Savings** | The estimated cost you could save in that category, based on the difference between provisioned and used resources, for the selected time range| -Clicking on any item in this list takes you to its detailed Cost Breakdown page. Refer [Cost Breakdown](./cost-breakdown.md) to learn more. +Clicking on any item in this list takes you to its detailed Cost Breakdown page. Refer [Cost Breakdown](../cost-visibility/configurations.md) to learn more. ### Checking Upgrade Compatibility @@ -182,7 +182,7 @@ Clicking on any item in this list takes you to its detailed Cost Breakdown page. Cost data appears only for clusters where **Cost Visibility** is enabled. If a cluster doesn’t show cost insights, verify that the **Cost Visibility** module is active for that cluster. -Refer [Configurations](./configurations.md) to learn more. +Refer [Configurations](../cost-visibility/configurations.md) to learn more.
From 10e0a06461dbbcf7de0ae92d78def5188f6d233c Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Fri, 24 Oct 2025 19:17:38 +0530 Subject: [PATCH 33/34] docs: added some hintblocks and fixes --- .../cost-visibility/configurations.md | 33 +++++++-------- .../overview-cost-visibility.md | 9 +++++ .../infrastructure-overview.md | 40 +++++++++++++++++-- 3 files changed, 60 insertions(+), 22 deletions(-) diff --git a/docs/user-guide/cost-visibility/configurations.md b/docs/user-guide/cost-visibility/configurations.md index 8a296b088..1eaef1ea6 100644 --- a/docs/user-guide/cost-visibility/configurations.md +++ b/docs/user-guide/cost-visibility/configurations.md @@ -29,6 +29,8 @@ To enable cost visibility for a cluster, follow the below steps: {% tab title="GCP" %} +### Enable Cost Visibility for GCP + To enable cost visibility for Google Cloud in Devtron, you need to generate an API key and use it to connect Devtron with your GCP account. 1. Generate the API key using standard [Google Cloud API key documentation](https://cloud.google.com/docs/authentication/api-keys#gcloud). @@ -43,6 +45,8 @@ If you face any issues while enabling or configuring the **Cost Visibility** mod {% tab title="Azure" %} +### Enable Cost Visibility for Azure + To enable cost visibility for your Azure clusters in Devtron, you need to allow Devtron to access your billing data securely. This requires two steps: 1. Create a custom role in Azure with billing access. 2. Create a service principal (an identity) that Devtron can use to fetch cost details. @@ -128,6 +132,8 @@ If you face any issues while enabling or configuring the **Cost Visibility** mod {% tab title="AWS" %} +### Enable Cost Visibility for AWS + If you have spot node instances in your AWS cluster, then only you need to do the below additional configurations for your AWS cluster, else you can skip the below configurations ### Step 1: Set up a Spot Instance Data Feed @@ -286,29 +292,20 @@ Ensure [GitOps](../global-configurations/gitops.md) is configured before deployi While deploying `kube-prometheus-stack` chart, the deployment status may show as **Timed out**, and some CustomResourceDefinitions (CRDs) may appear as **Failed**. -To solve it, refer [Troubleshoot Issues](#common-pitfall-prometheus-deployment-timeout-due-to-failed-crds) +![Figure 4a: Deployment Timed Out](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app-metrics-deployment-timed-out-v2.jpg) -{% endhint %} +![Figure 4b: CRDs Failed](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-metrics/app-metrics-crds-failed.jpg) -5. After the chart deployed successfully, you need to make the Prometheus endpoint exposed publicly. +**This behavior is expected and do not require any action from you.** -{% hint style="info" %} -If you face any issues while enabling or configuring the **Cost Visibility** module, please contact the [Devtron Support Team](mailto:support@devtron.ai) for assistance. -{% endhint %} +This occurs because certain Prometheus CRDs are large in size, which can lead to temporary sync issues during deployment, but, this does not impact the functionality of the Prometheus components. - +{% hint style="info" %} +If you face any issues while enabling or configuring the **Cost Visibility** module, please contact the [Devtron Support Team](mailto:enterprise@devtron.ai) for assistance. +{% endhint %} diff --git a/docs/user-guide/cost-visibility/overview-cost-visibility.md b/docs/user-guide/cost-visibility/overview-cost-visibility.md index 6244e1100..719ca225f 100644 --- a/docs/user-guide/cost-visibility/overview-cost-visibility.md +++ b/docs/user-guide/cost-visibility/overview-cost-visibility.md @@ -15,12 +15,21 @@ Cost Overview has the following sections: 3. [Track Performance](#track-performance) 4. [Actions and Insights](#actions-and-insights) +### How is cost calculated? + +Devtron calculates and updates cost data **every hour** based on the resource usage metrics collected from **Prometheus**. + +Prometheus gathers real-time data for **CPU**, **Memory**, **GPU**, **Storage (PV)**, and **Network** from your connected clusters. +Devtron then processes this data every hour to display accurate and up-to-date cost insights across your infrastructure. + {% hint style="info" %} ### Note Cost Visibility is currently supported **only for Devtron and Helm applications**. It is **not available** for applications deployed externally through **Argo CD** or **Flux**. {% endhint %} +--- + ## At a Glance The **At a Glance** summarizes the total cost for the selected period and breaks it down by resource type. Each card shows the cost, its share of the total, and a usage trend graph. diff --git a/docs/user-guide/creating-application/infrastructure-overview.md b/docs/user-guide/creating-application/infrastructure-overview.md index c1aefb630..447b0b73b 100644 --- a/docs/user-guide/creating-application/infrastructure-overview.md +++ b/docs/user-guide/creating-application/infrastructure-overview.md @@ -103,9 +103,41 @@ It provides a quick overview of your cluster node density and helps identify env You can sort the chart data using the dropdown in the top-right corner: * **High to Low** or **Low to High**, to focus on clusters with the most or fewest nodes. -{% hint style="info" %} -If some clusters show **Not Detected** under autoscaler, it means Devtron could not identify their scaling configuration. -You can verify autoscaling settings in your respective cloud console or cluster configuration. +### Troubleshooting Autoscaler Detection + +Devtron currently supports autoscaler detection for the following autoscalers: **EKS Auto Mode**, **Karpenter**, **CAST AI**, and **GKE Autopilot**. +If your cluster uses any other autoscaler, it will be categorized as **Not Detected** under the **By Autoscaler** view. + +Devtron identifies supported autoscalers using the following Kubernetes node labels: + +```bash +# EKS Auto Mode label + +LabelEKSComputeType = "eks.amazonaws.com/compute-type" +LabelEKSComputeAuto = "auto" + +# Karpenter label + +LabelKarpenterInitialized = "karpenter.sh/initialized" +LabelKarpenterTrue = "true" + +# Cast AI label + +LabelCastAIManagedBy = "provisioner.cast.ai/managed-by" +LabelCastAIValue = "cast.ai" + +# GKE label + +LabelGKEProvisioning = "cloud.google.com/gke-provisioning" +LabelGKEAutoPilot = "spot" + +``` + +{% hint style="success" %} +### Need support for another autoscaler? + +[Submit a feature request on GitHub](https://github.com/devtron-labs/devtron/issues). Our team regularly reviews community requests, and your feedback helps us prioritize new integrations in upcoming releases. + {% endhint %} ### Cost Visibility @@ -160,7 +192,7 @@ Each item in the **Top saving opportunities** will show | **Potential Savings (%)** | The percentage of your current spend that could be saved, for the selected time range | | **Estimated Savings** | The estimated cost you could save in that category, based on the difference between provisioned and used resources, for the selected time range| -Clicking on any item in this list takes you to its detailed Cost Breakdown page. Refer [Cost Breakdown](../cost-visibility/configurations.md) to learn more. +Clicking on any item in this list takes you to its detailed Cost Breakdown page. Refer [Cost Breakdown](../cost-visibility/cost-breakdown.md) to learn more. ### Checking Upgrade Compatibility From a685c02b8bc0f4412dbaa23e37ffa692d0d6402d Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Mon, 27 Oct 2025 16:06:09 +0530 Subject: [PATCH 34/34] docs: added enterprise tagging --- docs/user-guide/creating-application/application-overview.md | 4 ++-- .../creating-application/infrastructure-overview.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user-guide/creating-application/application-overview.md b/docs/user-guide/creating-application/application-overview.md index 1233a5b2a..3706d3537 100644 --- a/docs/user-guide/creating-application/application-overview.md +++ b/docs/user-guide/creating-application/application-overview.md @@ -186,7 +186,7 @@ The section provides two tabs, **Build Pipelines** and **Deployment Pipelines**, --- -## Cost Visibility +## Cost Visibility [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing) {% hint style="info" %} This section provides a quick overview of cost insights within the **Application Overview** dashboard. @@ -214,7 +214,7 @@ Enable the **Cost Visibility** module for those clusters to view accurate cost i --- -## Best Practices +## Best Practices [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing) The **Best Practices** section helps shows you the percentage of production pipelines for which you have enabled approval policies. It gives you a quick view of how many pipelines have checks in place before important configuration changes or deployments go live. diff --git a/docs/user-guide/creating-application/infrastructure-overview.md b/docs/user-guide/creating-application/infrastructure-overview.md index 447b0b73b..32a5d7f49 100644 --- a/docs/user-guide/creating-application/infrastructure-overview.md +++ b/docs/user-guide/creating-application/infrastructure-overview.md @@ -140,7 +140,7 @@ LabelGKEAutoPilot = "spot" {% endhint %} -### Cost Visibility +### Cost Visibility [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing) The Cost Breakdown chart helps you see how costs are distributed across different infrastructure components for the selected time period.