Skip to content

Commit

Permalink
📝 Document minimal Helm installation steps
Browse files Browse the repository at this point in the history
  • Loading branch information
sergei-maertens committed Dec 18, 2024
1 parent 83d3cd3 commit bbb23e9
Showing 1 changed file with 36 additions and 3 deletions.
39 changes: 36 additions & 3 deletions docs/installation/helm.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,39 @@
.. _installation_helm:

Helm (TODO)
===========
Helm
====

TODO
Deploying to Kubernetes is possible with Helm_. The GPP-Woo maintainers publish
`charts <https://github.com/GPP-Woo/charts>`_ for the full stack (umbrella chart) and
the invidual components. You can use the former as-is, or use it as inspiration to build
your own umbrella chart.

The remainder of the documentation assumes you're deploying the full stack.

Add the repositories
--------------------

To deploy the charts, first add the necessary repositories:

.. code-block:: bash
helm repo add gpp-woo https://GPP-Woo.github.io/charts
Deploy the stack
----------------

To deploy the stack, ensure you have your own ``values.yml`` file overriding the relevant
settings/defaults from the chart itself - see
`GitHub <https://github.com/GPP-Woo/charts/tree/main/charts/GPP-stack>`_ for a reference.

.. code-block:: bash
helm repo update
helm install \
-f myvalues.yml \
my-gpp-woo \
gpp-woo/gpp-stack
Adapt the name ``my-gpp-woo`` to your liking.

.. _Helm: https://helm.sh/

0 comments on commit bbb23e9

Please sign in to comment.