kubecost / cost-analyzer-helm-chart

Kubecost helm chart
http://kubecost.com/install
Apache License 2.0
458 stars 410 forks source link

2.3.1 notice for values change #3509

Closed jessegoodier closed 1 week ago

jessegoodier commented 1 week ago

What does this PR change?

Displays a notice for users that have legacy kubecostAggergator.env values

Does this PR rely on any other PRs?

No

How does this PR impact users? (This is the kind of thing that goes in release notes!)

Displays a notice for users that have legacy kubecostAggergator.env values This will default all users to 91d data ingestion. To increase the history, it is recommended to first let aggregator build 91d and verify Kubecost is working as expected.

Then upgrade the values to add:

kubecostAggergator:
  etlDailyStoreDurationDays: 365

What risks are associated with merging this PR? What is required to fully test this PR?

Fixes issue where users were not informed of a change to default behavior.

How was this PR tested?

Both with and without env to verify the message is output.

The message:

Kubecost 2.x is a major upgrade from previous versions and includes major new features including a brand new API Backend. Please review the following documentation to ensure a smooth transition: https://docs.kubecost.com/install-and-configure/install/kubecostv2

When pods are Ready, you can enable port-forwarding with the following command:

    kubectl port-forward --namespace kubecost deployment/kubecost-cost-analyzer 9090

Then, navigate to http://localhost:9090 in a web browser.

Please allow 25 minutes for Kubecost to gather metrics. A progress indicator will appear at the top of the UI.

Having installation issues? View our Troubleshooting Guide at http://docs.kubecost.com/troubleshoot-install

Notice: Issue in values detected.
Kubecost 2.3 has updated the aggregator's environment variables. Please update your Helm values to use the new key pairs.
For more information, see: https://docs.kubecost.com/install-and-configure/install/multi-cluster/federated-etl/aggregator#aggregator-optimizations
In Kubecost 2.3, kubecostAggregator.env is no longer used in favor of the new key pairs. This was done to prevent unexpected behavior and to simplify the aggregator's configuration.

Have you made an update to documentation? If so, please provide the corresponding PR.

Already complete

jessegoodier commented 1 week ago

/cherry-pick v2.3