Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add part on updating the Helm chart #23739

Merged
merged 1 commit into from
Feb 15, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 35 additions & 0 deletions Documentation/contributing/development/dev_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -601,6 +601,41 @@ Patch version

#. Submit all your changes into a new PR.

Making changes to the Helm chart
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The Helm chart is located in the ``install/kubernetes`` directory. The
``values.yaml.tmpl`` file contains the values for the Helm chart which are being used into the ``values.yaml`` file.

To prepare your changes you need to run the make scripts for the chart:

.. code-block:: shell-session

$ make -C install/kubernetes

This does all needed steps in one command. Your change to the Helm chart is now ready to be submitted!

You can also run them one by one using the individual targets below.

When updating or adding a value they can be synced to the ``values.yaml`` file by running the following command:

.. code-block:: shell-session

$ make -C install/kubernetes cilium/values.yaml

Before submitting the changes the ``README.md`` file needs to be updated, this can be done using the ``docs`` target:

.. code-block:: shell-session
meyskens marked this conversation as resolved.
Show resolved Hide resolved

$ make -C install/kubernetes docs

At last you might want to check the chart using the ``lint`` target:

.. code-block:: shell-session
meyskens marked this conversation as resolved.
Show resolved Hide resolved

$ make -C install/kubernetes lint


Optional: Docker and IPv6
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down