From 58b9172b8fb6b52008c43577f3b21e073e08c674 Mon Sep 17 00:00:00 2001 From: Roi Kramer Date: Wed, 21 Feb 2024 19:04:56 +0200 Subject: [PATCH 01/10] fixed tolerations --- charts/ocean-kubernetes-controller/templates/deployment.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/charts/ocean-kubernetes-controller/templates/deployment.yaml b/charts/ocean-kubernetes-controller/templates/deployment.yaml index cb03d2e..a5bc99f 100644 --- a/charts/ocean-kubernetes-controller/templates/deployment.yaml +++ b/charts/ocean-kubernetes-controller/templates/deployment.yaml @@ -204,8 +204,8 @@ spec: operator: Exists {{- else }} {{- with .Values.tolerations }} - tolerations: - {{- toYaml . | nindent 8 }} + tolerations: + {{- toYaml . | nindent 6 }} {{- end }} {{- end }} {{- if kindIs "invalid" .Values.topologySpreadConstraints }} From e974427729a62d4026ed5daaa3ed11ba75ea3a74 Mon Sep 17 00:00:00 2001 From: Roi Kramer Date: Wed, 21 Feb 2024 19:05:18 +0200 Subject: [PATCH 02/10] bump --- charts/ocean-kubernetes-controller/Chart.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/ocean-kubernetes-controller/Chart.yaml b/charts/ocean-kubernetes-controller/Chart.yaml index 5aacc8c..45a9eb5 100644 --- a/charts/ocean-kubernetes-controller/Chart.yaml +++ b/charts/ocean-kubernetes-controller/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: ocean-kubernetes-controller description: A Helm chart for Ocean Kubernetes Controller type: application -version: 0.1.22 +version: 0.1.23 appVersion: 2.0.48 kubeVersion: ">=1.20.0-0" maintainers: From 370df97a4560f46726739773b6d97f916d7cbbc3 Mon Sep 17 00:00:00 2001 From: Roi Kramer Date: Thu, 22 Feb 2024 08:58:02 +0200 Subject: [PATCH 03/10] adding docs to lint action --- .github/workflows/lint.yaml | 4 ++++ Makefile.devel.mk | 15 +++++++++++++++ 2 files changed, 19 insertions(+) diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index a441c97..828b125 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -33,3 +33,7 @@ jobs: - name: Run chart-testing (lint) id: lint run: ct lint --config .github/ct.yaml + + - uses: gabe565/setup-helm-docs-action@v1.0.3 + - run: helm-docs + - run: git diff --exit-code || (echo "Docs are out of date. Please run 'helm-docs' and commit the changes." && exit 1) \ No newline at end of file diff --git a/Makefile.devel.mk b/Makefile.devel.mk index 10c2fc3..fbd904b 100644 --- a/Makefile.devel.mk +++ b/Makefile.devel.mk @@ -59,3 +59,18 @@ lint: ## Lint charts -type d \ -exec $(HELM) lint {} \; endif + +define HELP_DOCS +# Generates documentation for the charts. +# +# Example: +# make docs +endef +.PHONY: docs +ifeq ($(HELP),y) +docs: + $(Q) echo "$$HELP_DOCS" +else +docs: ## Document the charts + @docker run --rm --volume "$(shell pwd):/helm-docs" -u $(shell id -u) jnorwood/helm-docs:v1.12.0 +endif From 20cb5b0d4ce4912326be6b6bd8919be5230d9103 Mon Sep 17 00:00:00 2001 From: Roi Kramer Date: Thu, 22 Feb 2024 08:58:13 +0200 Subject: [PATCH 04/10] adding docs to lint action --- .github/workflows/lint.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 828b125..7bc1947 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -36,4 +36,4 @@ jobs: - uses: gabe565/setup-helm-docs-action@v1.0.3 - run: helm-docs - - run: git diff --exit-code || (echo "Docs are out of date. Please run 'helm-docs' and commit the changes." && exit 1) \ No newline at end of file + - run: git diff --exit-code || (echo "Docs are out of date. Please run 'make docs' and commit the changes." && exit 1) \ No newline at end of file From 0a4b1845155bb52098a88ad931b02e0ec92d6784 Mon Sep 17 00:00:00 2001 From: Roi Kramer Date: Thu, 22 Feb 2024 09:00:12 +0200 Subject: [PATCH 05/10] adding docs to lint action --- .github/workflows/lint.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 7bc1947..32a4bcc 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -36,4 +36,5 @@ jobs: - uses: gabe565/setup-helm-docs-action@v1.0.3 - run: helm-docs - - run: git diff --exit-code || (echo "Docs are out of date. Please run 'make docs' and commit the changes." && exit 1) \ No newline at end of file + - name: Check for changes in docs + run: git diff --exit-code || (echo "***\nDocs are out of date. Please run 'make docs' and commit the changes.\n***" && exit 1) \ No newline at end of file From 033c12ec5f487ea0e41fb6a213e5ac2178e5c528 Mon Sep 17 00:00:00 2001 From: Roi Kramer Date: Thu, 22 Feb 2024 09:01:12 +0200 Subject: [PATCH 06/10] adding docs to lint action --- .github/workflows/lint.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 32a4bcc..3c8cc9f 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -37,4 +37,4 @@ jobs: - uses: gabe565/setup-helm-docs-action@v1.0.3 - run: helm-docs - name: Check for changes in docs - run: git diff --exit-code || (echo "***\nDocs are out of date. Please run 'make docs' and commit the changes.\n***" && exit 1) \ No newline at end of file + run: git diff --exit-code || (echo "Docs are out of date. Please run 'make docs' and commit the changes." && exit 1) \ No newline at end of file From f357fe6c11c706dd75f827da7a4cd74fb6a953ed Mon Sep 17 00:00:00 2001 From: Roi Kramer Date: Thu, 22 Feb 2024 09:01:50 +0200 Subject: [PATCH 07/10] 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) From f5ab7dd7f19bb17eafb8d638d3ce069556a222a2 Mon Sep 17 00:00:00 2001 From: Roi Kramer Date: Thu, 22 Feb 2024 09:09:58 +0200 Subject: [PATCH 08/10] wip --- charts/ocean-metric-exporter/Chart.yaml | 2 +- charts/ocean-network-client/Chart.yaml | 2 +- charts/ocean-network-client/README.md | 28 +++++++++++----- charts/ocean-network-client/README.md.gotmpl | 35 ++++++++++++++++++++ 4 files changed, 56 insertions(+), 11 deletions(-) create mode 100644 charts/ocean-network-client/README.md.gotmpl diff --git a/charts/ocean-metric-exporter/Chart.yaml b/charts/ocean-metric-exporter/Chart.yaml index e1747ea..35658f6 100644 --- a/charts/ocean-metric-exporter/Chart.yaml +++ b/charts/ocean-metric-exporter/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: ocean-metric-exporter description: A Helm chart for Ocean Metric Exporter type: application -version: 1.0.5 +version: 1.0.6 appVersion: 1.0.3 home: https://github.com/spotinst/charts/tree/main/charts/ocean-metric-exporter icon: https://docs.spot.io/_media/images/spot_mark.png diff --git a/charts/ocean-network-client/Chart.yaml b/charts/ocean-network-client/Chart.yaml index 82518bb..553a1df 100644 --- a/charts/ocean-network-client/Chart.yaml +++ b/charts/ocean-network-client/Chart.yaml @@ -17,7 +17,7 @@ maintainers: # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 1.0.16 +version: 1.0.17 # This is the version number of the application being deployed. This version number should be # incremented each time you make changes to the application. Versions are not expected to diff --git a/charts/ocean-network-client/README.md b/charts/ocean-network-client/README.md index 8bba92a..037e24a 100644 --- a/charts/ocean-network-client/README.md +++ b/charts/ocean-network-client/README.md @@ -1,20 +1,30 @@ # ocean-network-client -![Version: 1.0.16](https://img.shields.io/badge/Version-1.0.16-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.6](https://img.shields.io/badge/AppVersion-1.0.6-informational?style=flat-square) +![Version: 1.0.17](https://img.shields.io/badge/Version-1.0.17-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.6](https://img.shields.io/badge/AppVersion-1.0.6-informational?style=flat-square) -A Helm chart for Ocean Network Client +A Helm chart for Ocean Network Client. -**Homepage:** +## Installation -## Maintainers +1. Add the Spot Helm chart repository: -| Name | Email | Url | -| ---- | ------ | --- | -| spotinst | | | +```sh +helm repo add spot https://charts.spot.io +``` -## Source Code +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 diff --git a/charts/ocean-network-client/README.md.gotmpl b/charts/ocean-network-client/README.md.gotmpl new file mode 100644 index 0000000..cf7d1ae --- /dev/null +++ b/charts/ocean-network-client/README.md.gotmpl @@ -0,0 +1,35 @@ +{{ template "chart.header" . }} + +{{ template "chart.deprecationWarning" . }} + +{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} + +{{ template "chart.description" . }}. + +## 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 `{{ template "chart.name" . }}`: + +```sh +helm install my-release spot/{{ template "chart.name" . }} +``` + +> NOTE: Please configure all required chart values using the `set` command line argument or a `values.yaml` file. + +{{ template "chart.requirementsSection" . }} + +{{ template "chart.valuesSection" . }} + +{{ template "helm-docs.versionFooter" . }} From ce62120238eb0841b83029bdebc8f5ae43a0e43d Mon Sep 17 00:00:00 2001 From: Roi Kramer Date: Thu, 22 Feb 2024 09:11:52 +0200 Subject: [PATCH 09/10] fix --- charts/ocean-metric-exporter/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/ocean-metric-exporter/README.md b/charts/ocean-metric-exporter/README.md index 134e8b2..9aa0c67 100644 --- a/charts/ocean-metric-exporter/README.md +++ b/charts/ocean-metric-exporter/README.md @@ -1,6 +1,6 @@ # ocean-metric-exporter -![Version: 1.0.5](https://img.shields.io/badge/Version-1.0.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.3](https://img.shields.io/badge/AppVersion-1.0.3-informational?style=flat-square) +![Version: 1.0.6](https://img.shields.io/badge/Version-1.0.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.3](https://img.shields.io/badge/AppVersion-1.0.3-informational?style=flat-square) A Helm chart for Ocean Metric Exporter. From a2fb965429e01e4d6bbfc96104da10cdbbfc5d61 Mon Sep 17 00:00:00 2001 From: Roi Kramer Date: Thu, 22 Feb 2024 12:48:12 +0200 Subject: [PATCH 10/10] fix docs --- charts/ocean-network-client/README.md | 2 +- charts/ocean-network-client/values.yaml | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/charts/ocean-network-client/README.md b/charts/ocean-network-client/README.md index 037e24a..dae86d2 100644 --- a/charts/ocean-network-client/README.md +++ b/charts/ocean-network-client/README.md @@ -34,7 +34,7 @@ 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 | string | `"kube-system"` | | +| namespace | Optional | `"kube-system"` | Namespace where components should be installed. | | 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/ | diff --git a/charts/ocean-network-client/values.yaml b/charts/ocean-network-client/values.yaml index 8a030e9..d41dfee 100644 --- a/charts/ocean-network-client/values.yaml +++ b/charts/ocean-network-client/values.yaml @@ -1,3 +1,4 @@ +# -- (Optional) Namespace where components should be installed. namespace: kube-system oceanController: