Long Term Storage
To enable 90+ days of data retention in Kubecost, we recommend deploying with durable storage enabled. We provide two options for doing this: 1) in your cluster and 2) out of the cluster. This functionality also powers the Enterprise multi-cluster view, where data across clusters can be viewed in aggregate, as well as simple backup & restore capabilities.
Note: This feature today requires an Enterprise license.
Option A: In cluster storage (Postgres) – DEPRECATED
To enable Postgres-based long-term storage, complete the following:
Helm chart configuration – in values.yaml set the
remoteWrite.postgres.enabledattribute to true. The default backing disk is
200gbbut this can also be directly configured in values.yaml.
Verify successful install – Deploy or upgrade via install instructions at http://kubecost.com/install, passing this updated values.yaml file, and verify pods with the prefix
Confirm data is available
Vist this endpoint
Here’s an example use:
Option B: Out of cluster storage (Thanos)
Thanos-based durable storage provides long-term metric retention directly in a user-controlled bucket (e.g. S3 or GCS bucket) and can be enabled with the following steps:
Step 1: Create object-store yaml file
This step creates the object-store.yaml file that contains your durable storage target (e.g. GCS, S3, etc.) configuration and access credentials. The details of this file are documented thoroughly in Thanos documentation.
Step 2: Create object-store secret
The final step prior to installation is to create a secret with the yaml file generated in the previous step:
$ kubectl create secret generic kubecost-thanos -n kubecost --from-file=./object-store.yaml
Step 3: Deploying Kubecost with Thanos
The Thanos subchart includes
thanos-compact, and service discovery for
thanos-sidecar. These components are recommended when deploying Thanos on multiple clusters.
These values can be adjusted under the
thanos block in
values-thanos.yaml - Available options can be observed here: thanos/values.yaml
It’s important to note that when running
helm install, you must provide the base
values.yaml followed by the override values-thanos.yaml. For example:
$ helm install kubecost/cost-analyzer \ --name kubecost \ --namespace kubecost \ -f values.yaml \ -f values-thanos.yaml
Your deployment should now have Thanos enabled!
thanos-storepod is by default configured to request 2 Gb in memory.
In order to verify a correct installation, start by ensuring all pods are running without issue. If the pods mentioned above are not running successfully, then view pod logs for more detail. A common error is as follows, which means you do not have the correct access to the supplied bucket:
email@example.com does not have storage.objects.list access to thanos-bucket., forbidden"
Assuming pods are running, use port forwarding to connect to the
$ kubectl port-forward svc/kubecost-thanos-query-http 8080:10902 --namespace kubecost
Then navigate to http://localhost:8080 in your browser. This page should look very similar to the Prometheus console.
If you navigate to the Stores using the top navigation bar, you should be able to see the status of both the
thanos-sidecar which accompanied prometheus server:
Also note that the sidecar should identify with the unique
cluster_id provided in your values.yaml in the previous step. Default value is
The default retention period for when data is moved into the object storage is currently 2h - This configuration is based on Thanos suggested values. By default, it will be 2 hours before data is written to the provided bucket.
Instead of waiting 2h to ensure that thanos was configured correctly, the default log level for the thanos workloads is
debug (it’s very light logging even on debug). You can get logs for the
thanos-sidecar, which is part of the
prometheus-server pod, and
thanos-store. The logs should give you a clear indication of whether or not there was a problem consuming the secret and what the issue is. For more on Thanos architecture, view this resource.
Cluster not writing data to thanos bucket
If a cluster is not successfully writing data to the bucket, we recommend reviewing
thanos-sidecar logs with the following command:
kubectl logs kubecost-prometheus-server-<your-pod-id> -n kubecost -c thanos-sidecar
Logs in the following format are evidence of a successful bucket write:
level=debug ts=2019-12-20T20:38:32.288251067Z caller=objstore.go:91 msg="uploaded file" from=/data/thanos/upload/01KL5YG9CQYZ81G9BZMTM3GJFH/meta.json dst=debug/metas/01KL5YG9CQYZ81G9BZMTM3GJFH.json bucket=kc-thanos
Stores not listed at the /stores endpoint
If thanos-query can’t connect to both the sidecar and the store, you may want to directly specify the store GRPC service address instead of using DNS discovery (the default).
You can quickly test if this is the issue by running
kubectl edit deployment kubecost-thanos-query -n kubecost
- --store=kubecost-thanos-store-grpc.kubecost:10901 to the container args. This will cause a query restart and you can visit /stores again to see if the store has been added.
If it has, you’ll want to use these addresses instead of DNS more permanently by setting .Values.thanos.query.stores in values-thanos.yaml
... thanos: store: enabled: true grpcSeriesMaxConcurrency: 20 blockSyncConcurrency: 20 extraEnv: - name: GOGC value: "100" resources: requests: memory: "2.5Gi" query: enabled: true timeout: 3m # Maximum number of queries processed concurrently by query node. maxConcurrent: 8 # Maximum number of select requests made concurrently per a query. maxConcurrentSelect: 2 resources: requests: memory: "2.5Gi" autoDownsampling: false extraEnv: - name: GOGC value: "100" <b>stores:</b> <b>- "kubecost-thanos-store-grpc.kubecost:10901"</b>
Edit this doc on Github