From 11ea6f46a52baa397778eb5c5ce06cf1109909e2 Mon Sep 17 00:00:00 2001 From: Amanda Vialva <144278621+amandavialva01@users.noreply.github.com> Date: Thu, 24 Oct 2024 12:31:51 -0400 Subject: [PATCH] chore: clarify version overrides during helm installs (#10094) --- docs/reference/deploy/helm-config-reference.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/reference/deploy/helm-config-reference.rst b/docs/reference/deploy/helm-config-reference.rst index cf0a332ce95..bede49d2f1b 100644 --- a/docs/reference/deploy/helm-config-reference.rst +++ b/docs/reference/deploy/helm-config-reference.rst @@ -19,6 +19,10 @@ `_ (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 `. + .. note:: If using a non-release branch of the Determined repository, ``appVersion`` is going to be set to @@ -26,10 +30,23 @@ ``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 + `_. 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 ... --version + `` 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