Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve documentation surrounding slot caps helm configuration #10090

Merged
merged 2 commits into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/reference/deploy/helm-config-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <k8s-resource-caps>`.
Maps to :ref:`resource_manager.default_namespace <master-config-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
<master-config-rm-cluster-name>` in the master configuration.

.. 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 @@ -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``
================

Expand Down Expand Up @@ -386,6 +388,8 @@ on using Determined with Kubernetes, see the :ref:`documentation <determined-on-

This field is no longer supported, use ``default_namespace`` instead.

.. _master-config-default-namespace:

``default_namespace``
---------------------

Expand Down
17 changes: 17 additions & 0 deletions docs/setup-cluster/k8s/resource-caps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,23 @@ bindings and resource quotas using either the WebUI or the CLI.
otherwise bound to the release namespace. For non-helm Determined deployments, it falls back to
the default Kubernetes namespace, ``default``.

To ensure that this field is set during a helm install or update, make sure to specify the
following in your values.yaml:

.. code:: yaml

resourceManager:
defaultNamespace: <workload_namespace>

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
<master-config-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.
Expand Down
12 changes: 7 additions & 5 deletions docs/setup-cluster/k8s/setup-multiple-resource-managers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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: <whatever-path-your-rm-config-is-like ~/.kubeconfig>
... add whatever other specs you might need ...
resource_pools:
Expand Down Expand Up @@ -133,7 +133,9 @@ the same as the “cluster name” for a given cluster.

additional_resource_managers:
- resource_manager:
type: kubernetes name: <rm-name> namespace: default
type: kubernetes
cluster_name: <rm-name>
default_namespace: default
# or whatever other namespace you want to use
kubeconfig_secret_name: <The secret name, from ``kubectl describe secret <rm-name>``>
kubeconfig_secret_value: <The data value, from ``kubectl describe secret <rm-name>``>
Expand Down
Loading