Launch agent: Link agent setup docs for launchConfig (#121)

wandb · Apr 25, 2024 · e1a0836 · e1a0836
1 parent 4896734
commit e1a0836
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/charts/launch-agent/Chart.yaml b/charts/launch-agent/Chart.yaml
@@ -3,7 +3,7 @@ name: launch-agent
 icon: https://em-content.zobj.net/thumbs/240/apple/354/rocket_1f680.png
 description: A Helm chart for running the W&B Launch Agent in Kubernetes
 type: application
-version: 0.13.2
+version: 0.13.3
 maintainers:
   - name: wandb
     email: [email protected]

diff --git a/charts/launch-agent/README.md b/charts/launch-agent/README.md
@@ -54,7 +54,7 @@ The table below describes all the available variables in the chart:
 | `namespace`                    | string          | No                   | `wandb`                         | The namespace to deploy the agent into.                                                                                                          |
 | `additionalTargetNamespaces`   | list(string)    | No                   | [`wandb`,`default`]             | A list of namespaces the agent can run jobs in.                                                                                                  |
 | `baseUrl`                      | string          | No                   | `https://api.wandb.ai`          | URL of your W&B server api.                                                                                                                      |
-| `launchConfig`                 | mutiline string | **Yes**              | `null`                          | his should be set to the literal contents of your launch agent config.                                                                           |
+| `launchConfig`                 | mutiline string | **Yes**              | `null`                          | This should be set to the literal contents of your launch agent config. See the agent setup docs for details: https://docs.wandb.ai/guides/launch/setup-agent-advanced                                                                          |
 | `volcano`                      | bool            | No                   | `true`                          | Controls whether the volcano scheduler should be installed in your cluster along with the agent. Set to `false` to disable volcano installation. |
 | `gitCreds`                     | mutiline string | No                   | `null`                          | Contents of a git credentials file.                                                                                                              |
 | `serviceAccount.annotations`   | object          | No                   | `null`                          | Annotations for the wandb service account.                                                                                                       |

diff --git a/charts/launch-agent/values.yaml b/charts/launch-agent/values.yaml
@@ -34,6 +34,7 @@ additionalTargetNamespaces:
   - wandb
 
 # This should be set to the literal contents of your launch agent config.
+# See the agent setup docs for details: https://docs.wandb.ai/guides/launch/setup-agent-advanced
 launchConfig: |
   queues:  # List of queues to poll for jobs.
   - <YOUR QUEUE NAME>