diff --git a/docs/reference/deploy/helm-config-reference.rst b/docs/reference/deploy/helm-config-reference.rst index e1f9355383f..cf0a332ce95 100644 --- a/docs/reference/deploy/helm-config-reference.rst +++ b/docs/reference/deploy/helm-config-reference.rst @@ -318,4 +318,17 @@ - ``schedule``: Specifies the schedule for cleaning up logs. Can be provided as a cron expression or a duration string. +- ``resourceManager``: Specifies some configuration options for the (default) Determined resource + manager. A default configuration is provided in the ``values.yaml`` file. + + - ``defaultNamespace``: The namespace to which a workspace's workloads get sent by default if + the workload does not have an explicit :ref:`workspace-namespace binding `. + Maps to :ref:`resource_manager.default_namespace ` in the + master configuration. If left unspecified, ``resource_manager.default_namespace`` defaults to + the Kubernetes ``default`` namespace. + + - ``clusterName``: The name associated with the (default) resource manager/cluster. (*Required + when using multiple resource managers*). Maps to :ref:`resource_manager.cluster_name + ` in the master configuration. + .. include:: ../../_shared/note-dtrain-learn-more.txt diff --git a/docs/reference/deploy/master-config-reference.rst b/docs/reference/deploy/master-config-reference.rst index dc474b3df4d..ce21241f256 100644 --- a/docs/reference/deploy/master-config-reference.rst +++ b/docs/reference/deploy/master-config-reference.rst @@ -268,6 +268,8 @@ The resource manager used to acquire resources. Defaults to ``agent``. For Kubernetes installations, if you define additional resource managers, the resource manager specified under the primary resource_manager key here is considered the default. +.. _master-config-rm-cluster-name: + ``cluster_name`` ================ @@ -386,6 +388,8 @@ on using Determined with Kubernetes, see the :ref:`documentation + + Where ``workload_namespace`` as specified above can be the release namespace or can be any + namespace in which you wish to launch workloads for the given resource manager. + + When using multiple resource managers, this corresponding ``defaultNamespace`` field in the + additional resource managers can be configured in the :ref:`additional_resource_managers + ` config by specifying + ``additional_resource_manager.default_namespace``. An example configuration is provided in the + ``values.yaml`` file. + #. Toggle the "Auto Create Namespace" option on or off. When enabled, the system automatically creates a namespace in the cluster, allowing you to edit the resource quota directly in Determined. diff --git a/docs/setup-cluster/k8s/setup-multiple-resource-managers.rst b/docs/setup-cluster/k8s/setup-multiple-resource-managers.rst index a514bdcf977..1032624d44e 100644 --- a/docs/setup-cluster/k8s/setup-multiple-resource-managers.rst +++ b/docs/setup-cluster/k8s/setup-multiple-resource-managers.rst @@ -73,14 +73,14 @@ Follow this example to create as many resource managers (clusters) as needed. .. code:: yaml - resource_manager: - type: kubernetes - name: default-rm # optional, should match the name of your default RM/cluster + resource_manager: + type: kubernetes + cluster_name: default-rm # optional, should match the name of your default RM/cluster ... add any other specs you might need ... additional_resource_managers: - resource_manager: type: kubernetes - name: additional-rm # should match the name of your other RM(s) + cluster_name: additional-rm # should match the name of your other RM(s) kubeconfig_path: ... add whatever other specs you might need ... resource_pools: @@ -133,7 +133,9 @@ the same as the “cluster name” for a given cluster. additional_resource_managers: - resource_manager: - type: kubernetes name: namespace: default + type: kubernetes + cluster_name: + default_namespace: default # or whatever other namespace you want to use kubeconfig_secret_name: ``> kubeconfig_secret_value: ``>