From f357fe6c11c706dd75f827da7a4cd74fb6a953ed Mon Sep 17 00:00:00 2001 From: Roi Kramer Date: Thu, 22 Feb 2024 09:01:50 +0200 Subject: [PATCH] updated docs --- charts/ocean-kubernetes-controller/README.md | 2 +- charts/ocean-metric-exporter/README.md | 2 +- charts/ocean-network-client/README.md | 28 ++------------------ 3 files changed, 4 insertions(+), 28 deletions(-) diff --git a/charts/ocean-kubernetes-controller/README.md b/charts/ocean-kubernetes-controller/README.md index 92f1d32..de9e9d0 100644 --- a/charts/ocean-kubernetes-controller/README.md +++ b/charts/ocean-kubernetes-controller/README.md @@ -1,6 +1,6 @@ # ocean-kubernetes-controller -![Version: 0.1.22](https://img.shields.io/badge/Version-0.1.22-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.0.48](https://img.shields.io/badge/AppVersion-2.0.48-informational?style=flat-square) +![Version: 0.1.23](https://img.shields.io/badge/Version-0.1.23-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.0.48](https://img.shields.io/badge/AppVersion-2.0.48-informational?style=flat-square) A Helm chart for Ocean Kubernetes Controller. diff --git a/charts/ocean-metric-exporter/README.md b/charts/ocean-metric-exporter/README.md index e4f10fc..134e8b2 100644 --- a/charts/ocean-metric-exporter/README.md +++ b/charts/ocean-metric-exporter/README.md @@ -54,4 +54,4 @@ helm install my-release spot/ocean-metric-exporter | tolerations | Optional | `[{"key":"node-role.kubernetes.io/master","operator":"Exists"},{"key":"node-role.kubernetes.io/control-plane","operator":"Exists"}]` | Tolerations for nodes that have taints on them. Ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ | ---------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0) +Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0) diff --git a/charts/ocean-network-client/README.md b/charts/ocean-network-client/README.md index f941b3d..8bba92a 100644 --- a/charts/ocean-network-client/README.md +++ b/charts/ocean-network-client/README.md @@ -16,30 +16,6 @@ A Helm chart for Ocean Network Client * -A Helm chart for Ocean Network Client. - -## Installation - -1. Add the Spot Helm chart repository: - -```sh -helm repo add spot https://charts.spot.io -``` - -2. Update your local Helm chart repository cache: - -```sh -helm repo update -``` - -3. Install `ocean-network-client`: - -```sh -helm install my-release spot/ocean-network-client -``` - -> NOTE: Please configure all required chart values using the `set` command line argument or a `values.yaml` file. - ## Values | Key | Type | Default | Description | @@ -48,11 +24,11 @@ helm install my-release spot/ocean-network-client | image.pullSecrets | Optional | `[]` | Image pull secrets. | | image.repository | Optional | `"public.ecr.aws/spotinst/spot-network-client"` | Image repository. | | image.tag | Optional | `""` | Image tag. Defaults to `.Chart.AppVersion`. | -| namespace | Optional | `"kube-system"` | Namespace where components should be installed. | +| namespace | string | `"kube-system"` | | | oceanController.configMapName | Optional | `"spotinst-kubernetes-cluster-controller-config"` | ConfigMap name. | | oceanController.secretName | Optional | `"spotinst-kubernetes-cluster-controller"` | Secret name. | | resources | Optional | `{"requests":{"cpu":"30m","memory":"150Mi"}}` | Resource requests and limits. Ref: http://kubernetes.io/docs/user-guide/compute-resources/ | | tolerations | Optional | `[{"operator":"Exists"}]` | Tolerations - Enable pods to run an all nodes in cluster Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ | ---------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0) +Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)