Skip to content

Commit

Permalink
docs: Update readme to document useExternalWandbSecret
Browse files Browse the repository at this point in the history
  • Loading branch information
@zacharyblasczyk
zacharyblasczyk committed Oct 5, 2023
1 parent 8d1ee52 commit 7cc55ed
Showing 1 changed file with 20 additions and 16 deletions.
36 changes: 20 additions & 16 deletions charts/launch-agent/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

This chart deploys the W&B Launch Agent to your Kubernetes cluster.

If you have not added `wandb` as a helm repo, please run:
If you have not added `wandb` as a helm repo, please run:

```bash
helm repo add wandb https://wandb.github.io/helm-charts
```
Expand All @@ -12,11 +13,13 @@ The launch agent is a Kubernetes Deployment that runs a container that connects
To deploy an agent, you will need to specify the following values in [`values.yaml`](values.yaml):

- `agent.apiKey`: Your W&B API key
- Note: `agent.useExternalWandbSecret` can be set to `true` if you would like to provide your api key external to this helm chart.
- `launchConfig`: The literal contents of a launch agent config file that will be used to configure the agent. See the [launch agent docs](https://docs.wandb.ai/guides/launch/run-agent) for more information.

You will likely want to modify the variable `agent.resources.limits.{cpu,mem}`, which default to `1000m`, and `1Gi` respectively.

By default, this chart will also install [volcano](https://volcano.sh)

- `volcano`: Set to `false` to disable volcano install (default: `true`)

You can modify the values directly in the `values.yaml` file or provide them as command line arguments when running `helm install`, for example:
Expand All @@ -32,20 +35,21 @@ helm upgrade --namespace=wandb --create-namespace --install wandb-launch wandb/l
```

## Chart variables

The table below describes all the available variables in the chart:

| Variable | Type | Required | Default | Description |
| ----------------------------- | -------------- | -------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `agent.labels` | object | No | {} | Labels that will be added to the agent deployment. |
| `agent.apiKey` | string | **Yes** | "" | W&B API key to be used by the agent. |
| `agent.image` | string | No | `wandb/launch-agent-dev:latest` | Container image for the agent. |
| `agent.imagePullPolicy` | string | No | `Always` | Pull policy for the agent container image. |
| `agent.resources` | object | No | Limit to 1 CPU, 1Gi RAM | Pod spec resources block for the agent. |
| `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. |
| `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. |
| `azureStorageAccessKey` | string | No | "" | Azure storage access key required for kaniko to acces build contexts in azure blob storage. |
| Variable | Type | Required | Default | Description |
| ---------------------------- | --------------- | -------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `agent.labels` | object | No | {} | Labels that will be added to the agent deployment. |
| `agent.apiKey` | string | **Yes** | "" | W&B API key to be used by the agent. |
| `agent.image` | string | No | `wandb/launch-agent-dev:latest` | Container image for the agent. |
| `agent.imagePullPolicy` | string | No | `Always` | Pull policy for the agent container image. |
| `agent.resources` | object | No | Limit to 1 CPU, 1Gi RAM | Pod spec resources block for the agent. |
| `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. |
| `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. |
| `azureStorageAccessKey` | string | No | "" | Azure storage access key required for kaniko to acces build contexts in azure blob storage. |

0 comments on commit 7cc55ed

Please sign in to comment.