From e85a1dc96a7d3a02fa2ebcaedb05a900f9c7fb43 Mon Sep 17 00:00:00 2001 From: Dirk Mueller Date: Fri, 14 Jun 2024 13:21:55 +0000 Subject: [PATCH] Test build for #1286 --- helm-image/README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/helm-image/README.md b/helm-image/README.md index f0f60aeb0..e943319d2 100644 --- a/helm-image/README.md +++ b/helm-image/README.md @@ -1,7 +1,34 @@ -# The openSUSE Tumbleweed Kubernetes Package Manager Container Image +# Kubernetes Package Manager container image + ![Redistributable](https://img.shields.io/badge/Redistributable-Yes-green) -Kubernetes Package Manager container based on the openSUSE Tumbleweed Base Container Image. + +## Description + +[Helm](https://helm.sh/) is a tool for managing [Kubernetes](https://kubernetes.io/) charts, which are packages of pre-configured Kubernetes resources. This container image simplifies the deployment and use of Helm by packaging it into a ready-to-use container. + + +## Usage + +To run Helm, use the following comamand: + +```ShellSession +# podman run --rm -it registry.opensuse.org/opensuse/helm:%%helm_version%% + +podman run --rm -it registry.opensuse.org/opensuse/helm:%%helm_version%% version +``` + +Refer to the full list of Helm commands, flags and environment variables, in the [official Helm documentation](https://helm.sh/docs/helm/helm/). + +For a comprehensive guide on getting started with Helm, refer to the [official Helm tutorial](https://helm.sh/docs/chart_template_guide/getting_started/). + +### Connecting Helm container to the Host's Kubernetes Cluster + +To interact with a Kubernetes cluster running on the host, mount the Kubernetes configuration file (`kubeconfig`) into the container (use `--net=host` flag to allow container to use host’s network): + +```ShellSession +podman run --rm -it --net=host -v /path/to/kubeconfig:/root/.kube/config registry.opensuse.org/opensuse/helm:%%helm_version%% +``` ## Licensing