fixes (kubecost#2576)

Signed-off-by: chipzoller <[email protected]>

README.md

@@ -1,26 +1,42 @@
-# Kubecost helm chart
+# Kubecost Helm chart
 
-Helm chart for the Kubecost project, which is created to monitor and manage Kubernetes spend. Please contact team@kubecost.com or visit [kubecost.com](http://kubecost.com) for more info.
+This is the official Helm chart for [Kubecost](https://www.kubecost.com/), an enterprise-grade application to monitor and manage Kubernetes spend. Please see the [website](https://www.kubecost.com/) for more details on what Kubecost can do for you and the official documentation [here](https://docs.kubecost.com/), or contact [team@kubecost.com](mailto:team@kubecost.com) for assistance.
 
-To install via Helm, run the following command:
+To install via Helm, run the following command.
 
 ```sh
-helm upgrade --install kubecost --namespace kubecost --create-namespace \
+helm upgrade --install kubecost -n kubecost --create-namespace \
   --repo https://kubecost.github.io/cost-analyzer/ cost-analyzer \
   --set kubecostToken="aGVsbUBrdWJlY29zdC5jb20=xm343yadf98"
 ```
 
-While Helm is the [recommended install path](http://kubecost.com/install) for Kubecost, these resources can alternatively be deployed with a single-file manifest using the following command:
+Alternatively, add the Helm repository first and scan for updates.
+
+```sh
+helm repo add kubecost https://kubecost.github.io/cost-analyzer/
+helm repo update
+```
+
+Next, install the chart.
+
+```sh
+helm install kubecost kubecost/cost-analyzer -n kubecost --create-namespace \
+  --set kubecostToken="aGVsbUBrdWJlY29zdC5jb20=xm343yadf98"
+```
+
+While Helm is the [recommended install path](http://kubecost.com/install) for Kubecost especially in production, Kubecost can alternatively be deployed with a single-file manifest using the following command. Keep in mind when choosing this method, Kubecost will be installed from a development branch and may include unreleased changes.
 
 ```sh
 kubectl apply -f https://raw.githubusercontent.com/kubecost/cost-analyzer-helm-chart/develop/kubecost.yaml
 ```
 
+## Common Parameters
+
 The following table lists commonly used configuration parameters for the Kubecost Helm chart and their default values. Please see the [values file](/cost-analyzer/values.yaml) for the complete set of definable values.
 
 Parameter | Description | Default
 --------- | ----------- | -------
-`global.prometheus.enabled` | If false, use an existing Prometheus install. [More info](http://docs.kubecost.com/custom-prom). | `true`
+`global.prometheus.enabled` | If false, use an existing Prometheus install. [More info](https://docs.kubecost.com/install-and-configure/install/custom-prom). | `true`
 `prometheus.kube-state-metrics.disabled` | If false, deploy [kube-state-metrics](https://github.com/kubernetes/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`
@@ -43,8 +59,8 @@ Parameter | Description | Default
 `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](http://docs.kubecost.com/network-allocation) | `false`
-`networkCosts.podMonitor.enabled` | If true, a [PodMonitor](https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#podmonitor) for the network-cost daemonset is created | `false`
+`networkCosts.enabled` | If true, collect network allocation metrics [More info](https://docs.kubecost.com/using-kubecost/navigating-the-kubecost-ui/cost-allocation/network-allocation) | `false`
+`networkCosts.podMonitor.enabled` | If true, a [PodMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#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`
@@ -60,16 +76,21 @@ Parameter | Description | Default
 
 ## Adjusting Log Output
 
-The log output can be adjusted while deploying through Helm by using the `LOG_LEVEL` and/or `LOG_FORMAT` environment variables.
+The log output can be customized during deployment by using the `LOG_LEVEL` and/or `LOG_FORMAT` environment variables.
+
+### Adjusting Log Level
 
-For example, to set the log level to `trace` the following flag can be added to the helm command:
+Adjusting the log level increases or decreases the level of verbosity written to the logs. To set the log level to `trace`, the following flag can be added to the `helm` command.
 
 ```sh
 --set 'kubecostModel.extraEnv[0].name=LOG_LEVEL,kubecostModel.extraEnv[0].value=trace'
 ```
 
-`LOG_FORMAT` options:
+### Adjusting Log Format
 
-`JSON` - A structured logging output: `{"level":"info","time":"2006-01-02T15:04:05.999999999Z07:00","message":"Starting cost-model (git commit \"1.91.0-rc.0\")"}`
+Adjusting the log format changes the format in which the logs are output making it easier for log aggregators to parse and display logged messages. The `LOG_FORMAT` environment variable accepts the values `JSON`, for a structured output, and `pretty` for a nice, human-readable output.
 
-`pretty` - A nice human readable output: `2006-01-02T15:04:05.999999999Z07:00 INF Starting cost-model (git commit "1.91.0-rc.0")`
+| Value  | Output                                                                                                                     |
+|--------|----------------------------------------------------------------------------------------------------------------------------|
+| `JSON`   | `{"level":"info","time":"2006-01-02T15:04:05.999999999Z07:00","message":"Starting cost-model (git commit \"1.91.0-rc.0\")"}` |
+| `pretty` | `2006-01-02T15:04:05.999999999Z07:00 INF Starting cost-model (git commit "1.91.0-rc.0")`                                     |