starlingx/docs
Code Issues Proposed changes
852f8743e2
docs/doc/source/usertasks/kubernetes/kubernetes-user-tutorials-helm-package-manager.rst
Caio Fazio 68a49a940f Improve documentations for Helm and FluxCD 
In the current Helm documentation more details were added,
showing how to deploy an application using Helm.

Created a documentation to FluxCD showing how to deploy
an application using FluxCD resources.

Created a link in usertasks index to the new FluxCD documentation.

Fix merge conflict
Fix editorial issues

Closes-bug: 2068023

Change-Id: I20307dc98da4a9872ba441200499d4b3173d5f10
2024-07-02 19:32:16 +00:00

3.0 KiB
Raw Blame History

Helm Package Manager

supports Helm v3 package manager for Kubernetes that can be used to securely manage the lifecycle of applications within the Kubernetes cluster.

Helm packages are defined by Helm charts which contain all of the Kubernetes resource definitions necessary to run an application inside of a Kubernetes cluster. In , you can configure, install, and upgrade your Kubernetes applications using Helm charts.

The Helm v3 client can be installed on a remote workstation and used to remotely manage your Kubernetes application on , see Security - Access the System <index-security-kub-81153c1254c3> and Remote CLI access <index-usertasks-kub-1291759aa985>.

For more information on Helm, see the documentation at https://helm.sh/docs/.

For more information on how to configure and use Helm both locally and remotely, see Configure Local CLI Access <configure-local-cli-access>, and Configure Remote CLI Access <configure-remote-cli-access>.

Deploy via Helm

Use Helm Package File

You can use the packaged Helm chart from your development environment, and use the Helm CLI to install the package.

  1. Install your Helm package on

    The command below, executed remotely or locally, will deploy the application to the StarlingX-managed Kubernetes cluster:

    $ helm install [ -f <myvalues.yaml-file> | --set <attribute-name>=<attribute-value> ] <appName> <package>.tgz

    where:

    The helm chart/application will be deployed with a default set of values; unless those values are overridden with -f and/or --set options.

Use Helm Repository

Helm charts are defined with a default set of values that describe the behavior of the service installed within the Kubernetes cluster.

You can install the helm application from a Helm charts repository <https://helm.sh/docs/helm/helm_repo/>.

  1. Add the URL for the Helm chart repository (containing the helm chart you want to install) to the list of Helm chart repositories configured for your helm client.

    $ helm repo add <name> <helm-charts-repo-url>
    $ helm repo update

  2. Install the Helm application with the following command which will search for the specified Helm chart in the configured Helm chart repositories, and install it.

    $ helm install [ -f <myvalues.yaml-file> | --set <attribute-name>=<attribute-value> ] <appName> <name>/<chart-name>

    where:

    The helm chart/application will be deployed with a default set of values; unless those values are overridden with -f and/or --set options.