From 9916e1219f5b81b9dc660a2f25bc4bfb626247dd Mon Sep 17 00:00:00 2001 From: Amanda Vialva Date: Mon, 21 Oct 2024 10:56:58 -0400 Subject: [PATCH 1/2] chore: improve documentation surrounding slot caps helm setup CM-579: in-review --- docs/reference/deploy/helm-config-reference.rst | 13 +++++++++++++ docs/reference/deploy/master-config-reference.rst | 4 ++++ docs/setup-cluster/k8s/resource-caps.rst | 14 ++++++++++++++ .../k8s/setup-multiple-resource-managers.rst | 12 +++++++----- 4 files changed, 38 insertions(+), 5 deletions(-) diff --git a/docs/reference/deploy/helm-config-reference.rst b/docs/reference/deploy/helm-config-reference.rst index e1f9355383f..f1b5a48bd7a 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 `. + If left unspecified, ``resource_manager.default_namespace`` defaults to the Kubernetes + ``default`` namespace. Maps to :ref:`resource_manager.default_namespace + ` in the master configuration. + + - ``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 defaultNamespace field can be configured in the +additional_resource_manager config by specifying additional_resource_manager.default_namespace + #. 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: ``> From 51daec62753bce213e449348780d9683ba8bea66 Mon Sep 17 00:00:00 2001 From: Amanda Vialva Date: Wed, 23 Oct 2024 14:42:41 -0400 Subject: [PATCH 2/2] small style improvements --- docs/reference/deploy/helm-config-reference.rst | 6 +++--- docs/setup-cluster/k8s/resource-caps.rst | 7 +++++-- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/reference/deploy/helm-config-reference.rst b/docs/reference/deploy/helm-config-reference.rst index f1b5a48bd7a..cf0a332ce95 100644 --- a/docs/reference/deploy/helm-config-reference.rst +++ b/docs/reference/deploy/helm-config-reference.rst @@ -323,9 +323,9 @@ - ``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 `. - If left unspecified, ``resource_manager.default_namespace`` defaults to the Kubernetes - ``default`` namespace. Maps to :ref:`resource_manager.default_namespace - ` in the master configuration. + 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 diff --git a/docs/setup-cluster/k8s/resource-caps.rst b/docs/setup-cluster/k8s/resource-caps.rst index 5b2b703f3b4..6d6907e82b5 100644 --- a/docs/setup-cluster/k8s/resource-caps.rst +++ b/docs/setup-cluster/k8s/resource-caps.rst @@ -37,8 +37,11 @@ bindings and resource quotas using either the WebUI or the CLI. 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 defaultNamespace field can be configured in the -additional_resource_manager config by specifying additional_resource_manager.default_namespace + 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