starlingx/docs
Code Issues Proposed changes

Merge "Configure Remote Helm v2 Client .. (cont.)"

Browse Source
This commit is contained in:
Zuul 2021-06-11 14:50:06 +00:00 committed by Gerrit Code Review
commit ccb1d63cc2
1 changed files with 28 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
doc/source/system_configuration/kubernetes/system-config-helm-package-manager.rst
View File

@ -6,36 +6,41 @@
Helm Package Manager
====================
|prod-long| supports Helm v2 with Tiller, the Kubernetes package manager
that can be used to manage the lifecycle of end-user hosted applications
within the Kubernetes cluster.
|prod-long| supports Helm v3 package manager for Kubernetes that can be used to
securely manage the lifecycle of applications within the Kubernetes cluster.
.. rubric:: |context|
Helm packages are defined by Helm charts with container information sufficient
for managing a Kubernetes application. You can configure, install, and
upgrade your Kubernetes applications using Helm charts. Helm charts are
defined with a default set of values that describe the behavior of the
service installed within the Kubernetes cluster.
for managing a Kubernetes application. You can configure, install, and upgrade
your Kubernetes applications using Helm charts. Helm charts are defined with a
default set of values that describe the behavior of the service installed
within the Kubernetes cluster.
Upon system installation, the official curated helm chart repository is added
to the local helm repo list, in addition, a number of local repositories
\(containing optional |prod-long| packages\) are created and added to the
helm repo list. For more information,
see `https://github.com/helm/charts <https://github.com/helm/charts>`__.
A Helm v3 client is installed on controllers for local use by admins to manage
end-users' Kubernetes applications. |prod| recommends to install a Helm v3
client on a remote workstation, so that non-admin (and admin) end-users can
manage their Kubernetes applications remotely.
Use the following command to list the helm repositories:
Upon system installation, local Helm repositories \(containing |prod-long|
packages\) are created and added to the Helm repo list.
.. parsed-literal::
Use the following command to list these local Helm repositories:
.. code-block:: none
~(keystone_admin)]$ helm repo list
NAME URL
stable https://kubernetes-charts.storage.googleapis.com
local http://127.0.0.1:8879/charts
starlingx http://127.0.0.1:8080/helm_charts/starlingx
|prefix|-platform |s| http://127.0.0.1:8080/helm_charts/|prefix|-platform
starlingx `http://127.0.0.1:8080/helm_charts/starlingx`
stx-platform `http://127.0.0.1:8080/helm_charts/stx-platform`
For more information on Helm, see the documentation
at `https://helm.sh/docs/ <https://helm.sh/docs/>`__.
Where the `stx-platform` repo holds Helm charts of StarlingX Applications \(see
next section\) of the |prod| platform itself, while the `starlingx` repo holds
Helm charts of optional StarlingX applications, such as Openstack. The admin
user can add charts to these local repos and regenerate the index to use these
charts, and add new remote repositories to the list of known repos.
**Tiller** is a component of Helm. Tiller interacts directly with the
Kubernetes API server to install, upgrade, query, and remove Kubernetes
resources.
For more information on Helm v3, see the documentation at `https://helm.sh/docs/ <https://helm.sh/docs/>`__.
For more information on how to configure and use Helm both locally and remotely, see :ref:`Configure Local CLI Access <configure-local-cli-access>`,
and :ref:`Configure Remote CLI Access <configure-remote-cli-access>`.