From b56b5dfa7339a79a415f019d986a0a9330ecb703 Mon Sep 17 00:00:00 2001 From: Peter Wilcsinszky Date: Mon, 7 Aug 2023 19:50:58 +0200 Subject: [PATCH] chore(docs): adapt helm install docs to new release artifacts Signed-off-by: Peter Wilcsinszky --- README.md | 11 +---------- charts-docs/templates/overrides.gotmpl | 15 +-------------- charts/log-generator/README.md | 3 +-- 3 files changed, 3 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 7f66281..13c4449 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,11 @@ _API managed testing tool for logging-operator_ ## Deploy log-generator with Helm -Add the chart repository of the Log-generator using the following commands: ```sh -helm repo add kube-logging https://kube-logging.github.io/helm-charts -helm repo update +helm install --wait --generate-name oci://ghcr.io/kube-logging/helm-charts/log-generator ``` -### Install the Log-generator. - -```sh -helm install log-generator kube-logging/log-generator -``` - - ## Usage You can start the daemon serving the API on e.g. port 11000 by running the following command: diff --git a/charts-docs/templates/overrides.gotmpl b/charts-docs/templates/overrides.gotmpl index 69d7a98..42e3339 100644 --- a/charts-docs/templates/overrides.gotmpl +++ b/charts-docs/templates/overrides.gotmpl @@ -1,19 +1,7 @@ -{{- define "chart.versionBadge" -}} -![version: {{ .Version }}](https://img.shields.io/badge/version-{{ .Version | replace "-" "--" }}-informational?style=flat-square) -{{- end -}} - {{- define "chart.typeBadge" -}} {{- if .Type -}}![type: {{ .Type }}](https://img.shields.io/badge/type-{{ .Type }}-informational?style=flat-square){{- end -}} {{- end -}} -{{- define "chart.appVersionBadge" -}} -{{- if .AppVersion -}}![app version: {{ .AppVersion }}](https://img.shields.io/badge/app%20version-{{ .AppVersion | replace "-" "--" }}-informational?style=flat-square){{- end -}} -{{- end -}} - -{{- define "chart.kubeVersionBadge" -}} -{{- if .KubeVersion -}}![kube version: {{ .KubeVersion }}](https://img.shields.io/badge/kube%20version-{{ .KubeVersion | replace "-" "--" }}-informational?style=flat-square){{- end -}} -{{- end -}} - {{- define "chart.artifactHubBadge" -}} [![artifact hub](https://img.shields.io/badge/artifact%20hub-{{ .Name | replace "-" "--" }}-informational?style=flat-square)](https://artifacthub.io/packages/helm/kube-logging/{{ .Name }}) {{- end -}} @@ -22,8 +10,7 @@ ## TL;DR; ```bash -helm repo add kube-logging https://kube-logging.github.io/helm-charts -helm install --generate-name --wait kube-logging/{{ .Name }} +helm install --wait --generate-name oci://ghcr.io/kube-logging/helm-charts/{{ .Name }} ``` {{- end -}} diff --git a/charts/log-generator/README.md b/charts/log-generator/README.md index 36e1cb8..19f6d48 100644 --- a/charts/log-generator/README.md +++ b/charts/log-generator/README.md @@ -7,8 +7,7 @@ A Helm chart for Log-generator ## TL;DR; ```bash -helm repo add kube-logging https://kube-logging.github.io/helm-charts -helm install --generate-name --wait kube-logging/log-generator +helm install --wait --generate-name oci://ghcr.io/kube-logging/helm-charts/log-generator ``` ## Values