chore: add config policies to CLI reference docs (#10118)

determined-ai · Oct 28, 2024 · e0e6a3e · e0e6a3e
1 parent 9ba90ad
commit e0e6a3e
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 28 deletions.
diff --git a/docs/manage/config-policies.rst b/docs/manage/config-policies.rst
@@ -56,6 +56,11 @@ or CLI.
    both the invariant config and constraints for a given scope are updated together. It is not
    possible to update only one of these components independently.
 
+.. note::
+
+   It is recommended that administrators save their configuration policies for each scope in
+   separate YAML or JSON files. This provides an easy way to back up and restore policies if needed.
+
 WebUI
 =====
 
@@ -90,7 +95,7 @@ Administrators can set Config Policies at both the cluster and workspace levels.
 CLI
 ===
 
-Use the following command to manage workspace-level Config Policies via CLI:
+Use the following command to manage Config Policies via CLI:
 
 .. code:: bash
 

diff --git a/docs/reference/cli-reference.rst b/docs/reference/cli-reference.rst
@@ -27,29 +27,30 @@ help documentation. For example, to learn more about individual experiment comma
 
    positional arguments:
      command
-       help                show help for this command
-       auth                manage auth
-       agent (a)           manage agents
-       command (cmd)       manage commands
-       checkpoint (c)      manage checkpoints
-       deploy (d)          manage deployments
-       experiment (e)      manage experiments
-       job (j)             manage job
-       master (m)          manage master
-       model (m)           manage models
-       notebook            manage notebooks
-       oauth               manage OAuth
-       preview-search      preview search
-       resources (res)     query historical resource allocation
-       shell               manage shells
-       slot (s)            manage slots
-       task                manage tasks (commands, experiments, notebooks,
-                           shells, tensorboards)
-       template (tpl)      manage config templates
-       tensorboard         manage TensorBoard instances
-       trial (t)           manage trials
-       user (u)            manage users
-       version             show version information
+       help                   show help for this command
+       auth                   manage auth
+       agent (a)              manage agents
+       command (cmd)          manage commands
+       checkpoint (c)         manage checkpoints
+       deploy (d)             manage deployments
+       experiment (e)         manage experiments
+       job (j)                manage job
+       master (m)             manage master
+       model (m)              manage models
+       notebook               manage notebooks
+       oauth                  manage OAuth
+       preview-search         preview search
+       resources (res)        query historical resource allocation
+       shell                  manage shells
+       slot (s)               manage slots
+       task                   manage tasks (commands, experiments, notebooks,
+                              shells, tensorboards)
+       template (tpl)         manage config templates
+       config-policies (cp)   manage config policies
+       tensorboard            manage TensorBoard instances
+       trial (t)              manage trials
+       user (u)               manage users
+       version                show version information
 
    optional arguments:
      -h, --help            show this help message and exit

diff --git a/harness/determined/cli/config_policies.py b/harness/determined/cli/config_policies.py
@@ -90,7 +90,7 @@ def delete_config_policies(args: argparse.Namespace) -> None:
 
 args_description: cli.ArgsDescription = [
     cli.Cmd(
-        "config-policies",
+        "config-policies cp",
         None,
         "manage config policies",
         [
@@ -110,7 +110,8 @@ def delete_config_policies(args: argparse.Namespace) -> None:
                         "--workspace-name",
                         type=str,
                         required=False,
-                        help="apply config policies to workspace",
+                        help="get config policies from this workspace. When not specified, get "
+                        "global config policies",
                     ),
                     cli.Group(cli.output_format_args["json"], cli.output_format_args["yaml"]),
                 ],
@@ -138,7 +139,8 @@ def delete_config_policies(args: argparse.Namespace) -> None:
                         "--workspace-name",
                         type=str,
                         required=False,
-                        help="apply config policies to this workspace",
+                        help="apply config policies to this workspace. When not specified, apply "
+                        "global config policies",
                     ),
                 ],
             ),
@@ -158,7 +160,8 @@ def delete_config_policies(args: argparse.Namespace) -> None:
                         "--workspace-name",
                         type=str,
                         required=False,
-                        help="apply config policies to workspace",
+                        help="delete config policies from this workspace. When not specified, "
+                        "delete global config policies",
                     ),
                 ],
             ),