Skip to content

Commit

Permalink
docs: add helm doc updates (#9122)
Browse files Browse the repository at this point in the history
  • Loading branch information
NicholasBlaskey authored Apr 8, 2024
1 parent cf2f2be commit 3028efb
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/reference/deploy/helm-config-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -251,4 +251,26 @@
namespaces. Maps to the ``resource_pools`` section from the :ref:`master configuration
<master-config-reference>`.

- ``additional_resource_managers``: This section includes additional resource managers for
launching jobs across multiple Kubernetes clusters. Maps to :ref:`additional_resource_managers
<master-config-additional-resource-managers>` in the master configuration. An example
configuration is provided in the ``values.yaml`` file.

- ``resource_manager``: Describes the configuration settings for the resource manager. Maps to
:ref:`resource_manager <master-config-resource-manager>` in the master configuration.

- ``kubeconfig_secret_name``: Specifies the name of the secret containing the kubeconfig for
the resource manager. This kubeconfig is used to connect to the Kubernetes cluster and
launch tasks. Note that some kubeconfigs may require additional adjustments or
modifications. For example some kubeconfigs reference file paths, which may need to be
bind-mounted into the container or have their data paths encoded into the kubeconfig. Other
kubeconfigs, like those for GKE, may require installing plugins into the Determined master
container and binding certain credential files. (*Required*)

- ``kubeconfig_secret_value``: The name of the secret that contains the resource manager's
kubeconfig. (*Required*)

- ``resource_pools``: The resource pool configuration. See :ref:`resource_pools
<cluster-resource-pools>` for available configuration options.

.. include:: ../../_shared/note-dtrain-learn-more.txt
4 changes: 4 additions & 0 deletions docs/reference/deploy/master-config-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,8 @@ notebook instance is considered to be idle if it is not receiving any HTTP traff
otherwise active (as defined by the ``notebook_idle_type`` option in the :ref:`task configuration
<command-notebook-configuration>`). Defaults to ``null``, i.e. disabled.

.. _master-config-resource-manager:

**********************
``resource_manager``
**********************
Expand Down Expand Up @@ -1187,6 +1189,8 @@ those partitions/queues.
the HPC partition named ``defq_GPU`` with the ``gpu_type`` property set, and Slurm constraint
associated with the feature ``XL675d`` used to identify the model type of the compute node.

.. _master-config-additional-resource-managers:

**********************************
``additional_resource_managers``
**********************************
Expand Down
13 changes: 13 additions & 0 deletions helm/charts/determined/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -351,3 +351,16 @@ resourcePools:

## Configure the initial user password for the cluster
# initialUserPassword

# additional_resource_managers:
# - resource_manager:
# type: kubernetes
# max_slots_per_pod: 1
# name: carolina-multirm-1
# namespace: default
# kubeconfig_secret_name: additionalrm
# kubeconfig_secret_value: config
# determined_master_ip: 10.11.12.13
# determined_master_port: 8080
# resource_pools:
# - pool_name: additional_pool

0 comments on commit 3028efb

Please sign in to comment.