chore: Update some documentation (#48)

opencost · Mar 28, 2023 · bcee780 · bcee780
1 parent cf15d1f
commit bcee780
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,5 @@
-
-# opencost
-
-OpenCost and OpenCost UI
-
-![Version: 1.3.1](https://img.shields.io/badge/Version-1.3.1-informational?style=flat-square) ![AppVersion: 1.9.8](https://img.shields.io/badge/AppVersion-1.9.8-informational?style=flat-square)
+# OpenCost Helm Chart
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Chart Publish](https://github.com/opencost/opencost-helm-chart/workflows/chart-publish/badge.svg?branch=main) [![Releases downloads](https://img.shields.io/github/downloads/opencost/opencost-helm-chart/total.svg)](https://github.com/opencost/opencost-helm-charts/releases)
 
 ## Maintainers
 
@@ -22,8 +18,8 @@ Once Helm is set up properly, add the repo as follows:
 helm repo add opencost https://opencost.github.io/opencost-helm-chart
 ```
 
-You can then run `helm search repo opencost` to see the charts.
+See the [Chart Documentation](https://github.com/opencost/opencost-helm-charts/charts/opencost/README.md) for chart install instructions.
 
 ## OpenCost Links
-* https://github.com/opencost/opencost/tree/develop/kubernetes
-* https://www.opencost.io/docs/
+* [OpenCost](https://github.com/opencost/opencost)
+* [Documentation](https://www.opencost.io/docs/)
diff --git a/charts/opencost/Chart.yaml b/charts/opencost/Chart.yaml
@@ -9,7 +9,8 @@ keywords:
   - kubecost
   - opencost
   - monitoring
-version: 1.9.0
+version: 1.9.1
 maintainers:
   - name: mattray
     url: https://mattray.dev
+  - name: toscott
diff --git a/charts/opencost/README.md b/charts/opencost/README.md
@@ -2,7 +2,7 @@
 
 OpenCost and OpenCost UI
 
-![Version: 1.7.0](https://img.shields.io/badge/Version-1.7.0-informational?style=flat-square)
+![Version: 1.9.1](https://img.shields.io/badge/Version-1.9.1-informational?style=flat-square)
 ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
 ![AppVersion: 1.101.2](https://img.shields.io/badge/AppVersion-1.101.2-informational?style=flat-square)
 
@@ -11,6 +11,7 @@ OpenCost and OpenCost UI
 | Name | Email | Url |
 | ---- | ------ | --- |
 | mattray |  | <https://mattray.dev> |
+| toscott |  |  |
 
 ## Installing the Chart
 
@@ -62,11 +63,18 @@ $ helm install opencost opencost/opencost
 | opencost.ui.image.registry | string | `"quay.io"` | UI container image registry |
 | opencost.ui.image.repository | string | `"kubecost1/opencost-ui"` | UI container image name |
 | opencost.ui.image.tag | string | `""` (use appVersion in Chart.yaml) | UI container image tag |
+| opencost.ui.ingress.annotations | object | `{}` | Annotations for Ingress resource |
+| opencost.ui.ingress.enabled | bool | `false` | Ingress for OpenCost UI |
+| opencost.ui.ingress.hosts | list | See [values.yaml](values.yaml) | A list of host rules used to configure the Ingress |
+| opencost.ui.ingress.ingressClassName | string | `""` | Ingress controller which implements the resource |
+| opencost.ui.ingress.tls | list | `[]` | Ingress TLS configuration |
 | opencost.ui.resources.limits | object | `{"cpu":"999m","memory":"1Gi"}` | CPU/Memory resource limits |
 | opencost.ui.resources.requests | object | `{"cpu":"10m","memory":"55Mi"}` | CPU/Memory resource requests |
 | opencost.ui.securityContext | object | `{}` | The security options the container should be run with |
 | podAnnotations | object | `{}` | Annotations to add to the OpenCost Pod |
+| podLabels | object | `{}` | Labels to add to the OpenCost Pod |
 | podSecurityContext | object | `{}` | Holds pod-level security attributes and common container settings |
+| secretAnnotations | object | `{}` | Annotations to add to the Secret |
 | service.annotations | object | `{}` | Annotations to add to the service |
 | service.labels | object | `{}` | Labels to add to the service account |
 | service.type | string | `"ClusterIP"` | Kubernetes Service type |
@@ -77,4 +85,4 @@ $ helm install opencost opencost/opencost
 ----------------------------------------------
 Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
 ## Docs Generated by [helm-docs](https://github.com/norwoodj/helm-docs)
-`helm-docs -t .README.md.gotmpl`
+`helm-docs -t ./README.md.gotmpl`
diff --git a/charts/opencost/README.md.gotmpl b/charts/opencost/README.md.gotmpl
@@ -22,4 +22,4 @@ $ helm install opencost opencost/{{ template "chart.name" . }}
 
 {{ template "helm-docs.versionFooter" . }}
 ## Docs Generated by [helm-docs](https://github.com/norwoodj/helm-docs)
-`helm-docs -t .README.md.gotmpl`
+`helm-docs -t ./README.md.gotmpl`