Skip to content

reserved-ai/cost-analyzer-helm-chart

 
 

Repository files navigation

Overview

Archera uses APIs built on top of cost-model agent to fetch cluster data. This data is then combined and enriched with other data sources to create a comprehensive view of their current and historical spending and resource allocation.

Pre-Requisites:

  • Kubernetes cluster v1.18+
  • Helm 3
  • Registry access token from Archera Team

Installation:

For now we are relying on open core Cost Analyzer agent and its recommended installation via helm:

  1. Add Achera helm repo:
helm repo add archera https://helm.archera.ai
helm repo update
  1. Create namespace:
kubectl create namespace cost-analyzer
  1. Obtain registry credentials from Archera team and create a k8s secret to store registry credentials:
kubectl -n cost-analyzer create secret docker-registry regcred \
--docker-server=ghcr.io --docker-username=archera-bot \
--docker-password=<container-registry-access-token>  \
[email protected]
  1. Retrieve archera_org_id from the segment planner page by clicking on any Add action and switch to option via API

Screen Shot 2022-01-19 at 9 21 54 AM

  1. Retrieve archera_cluster_id by registering your cluster using the following endpoint. Use id field from response:
curl -X POST https://api.archera.ai/v2/org/<archera-org-id>/kubernetes/cluster/register \
   -H "Content-Type: application/json" \
   -d '{"name":"my-cluster"}' \
   --user "<archera-api-key>:"

Example Response:

{"created_at":"2022-01-19T17:12:41.346927+00:00","endpoint":null,"id":"0445ad80-bd6c-46f5-8504-347a5c8df345","is_active":true,"name":"my-cluster","org_id":"20bf728e-579f-4484-bbe2-6558aa954685"}

Note: You can obtain archera-api-key from the Archera Dashboard

  1. Install cost-analyzer helm chart
helm install cost-analyzer archera/cost-analyzer \
--set telemetry.archeraOrgId=<archera-org-id> \
--set telemetry.archeraClusterId=<archera-cluster-id> \
--set telemetry.archeraAPIKey=<archera-api-key> \
--namespace=cost-analyzer
  1. Check the status of pods if they are all up and running in the cost-analyzer namespace:
kubectl get pods --namespace=cost-analyzer

Note: Once the setup is complete, allow some time for agent to post and process data.

  1. You can now go to Archera Dashboard and view your kubernetes data.

Configuration:

The following table lists commonly used configuration parameters for the Kubecost Helm chart and their default values.

Parameter Description Default
global.prometheus.enabled If false, use an existing Prometheus install. More info. true
prometheus.kube-state-metrics.disabled If false, deploy kube-state-metrics for Kubernetes metrics false
prometheus.kube-state-metrics.resources Set kube-state-metrics resource requests and limits. {}
prometheus.server.persistentVolume.enabled If true, Prometheus server will create a Persistent Volume Claim. true
prometheus.server.persistentVolume.size Prometheus server data Persistent Volume size. Default set to retain ~6000 samples per second for 15 days. 32Gi
prometheus.server.persistentVolume.storageClass Define storage class for Prometheus persistent volume -
prometheus.server.retention Determines when to remove old data. 15d
prometheus.server.resources Prometheus server resource requests and limits. {}
prometheus.nodeExporter.resources Node exporter resource requests and limits. {}
prometheus.nodeExporter.enabled prometheus.serviceAccounts.nodeExporter.create If false, do not crate NodeExporter daemonset. true
prometheus.alertmanager.persistentVolume.enabled If true, Alertmanager will create a Persistent Volume Claim. true
prometheus.pushgateway.persistentVolume.enabled If true, Prometheus Pushgateway will create a Persistent Volume Claim. true
persistentVolume.enabled If true, Kubecost will create a Persistent Volume Claim for product config data. true
persistentVolume.size Define PVC size for cost-analyzer 0.2Gi
persistentVolume.dbSize Define PVC size for cost-analyzer's flat file database 32.0Gi
persistentVolume.storageClass Define storage class for cost-analyzer's persistent volume -
ingress.enabled If true, Ingress will be created false
ingress.annotations Ingress annotations {}
ingress.paths Ingress paths ["/"]
ingress.hosts Ingress hostnames [cost-analyzer.local]
ingress.tls Ingress TLS configuration (YAML) []
networkPolicy.enabled If true, create a NetworkPolicy to deny egress false
networkCosts.enabled If true, collect network allocation metrics More info false
networkCosts.podMonitor.enabled If true, a PodMonitor for the network-cost daemonset is created false
serviceMonitor.enabled Set this to true to create ServiceMonitor for Prometheus operator false
serviceMonitor.additionalLabels Additional labels that can be used so ServiceMonitor will be discovered by Prometheus {}
prometheusRule.enabled Set this to true to create PrometheusRule for Prometheus operator false
prometheusRule.additionalLabels Additional labels that can be used so PrometheusRule will be discovered by Prometheus {}
grafana.resources Grafana resource requests and limits. {}
grafana.sidecar.datasources.defaultDatasourceEnabled Set this to false to disable creation of Prometheus datasource in Grafana true
serviceAccount.create Set this to false if you want to create the service account kubecost-cost-analyzer on your own true
telemetry.enabled Enables the telemetry component true
telemetry.schedule Cron Schedule for running telemetry */15 * * * *
telemetry.archeraOrgId Archera org_id {}
telemetry.archeraClusterId Archera cluster_id {}
telemetry.archeraAPIKey Archera api key {}
tolerations node taints to tolerate []
affinity pod affinity {}
extraVolumes A list of volumes to be added to the pod []
extraVolumeMounts A list of volume mounts to be added to the pod []

About

Archera cost-analyzer helm chart.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Mustache 100.0%