Skip to content

Commit

Permalink
chore: clarify version overrides during helm installs (#10094)
Browse files Browse the repository at this point in the history
  • Loading branch information
amandavialva01 authored Oct 24, 2024
1 parent 4394f29 commit 11ea6f4
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/reference/deploy/helm-config-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,34 @@
<https://github.com/determined-ai/determined>`_ (e.g.,
``b13461ed06f2fad339e179af8028d4575db71a81``). Users are encouraged to use a released version.

- The version specified in the ``detVersion`` field of your ``values.yaml`` overrides the
version specified in ``appVersion``. For more information, see ``detVersion`` in the
:ref:`values.yaml config reference <values-yaml-settings>`.

.. note::

If using a non-release branch of the Determined repository, ``appVersion`` is going to be set to
``X.Y.Z.dev0``. This is not an official release version and deploying this version result in a
``ImagePullBackOff`` error. Users should remove ``.dev0`` to get the latest released version, or
they can specify a specific commit hash instead.

.. _values-yaml-settings:

**************************
``values.yaml`` Settings
**************************

- ``detVersion``: The Determined version to install. This can be a release version (e.g.,
``0.13.0``) or a commit hash from the `upstream Determined repo
<https://github.com/determined-ai/determined>`_. Release versions are encouraged.

- **NOTE:** This version overrides the version specified in ``appVersion`` of your
``Chart.yaml`` *and* any version specified in your ``helm install`` or ``helm upgrade``
command.

- For example, if you install Determined with ``helm install <release_name> ... --version
<X.Y.Z>`` but set ``detVersion: A.B.C``, the Determined version ``A.B.C`` is installed.

- ``masterPort``: The port at which the Determined master listens for connections on. (*Required*)

- ``useNodePortForMaster``: When set to false (default), a LoadBalancer service is deployed to make
Expand Down

0 comments on commit 11ea6f4

Please sign in to comment.