Configuration

coiled uses Dask’s built in configuration system to manage configuration options. Namely, configuration settings can be set:

  • In the configuration file ~/.config/dask/coiled.yaml

  • Using environment variables like DASK_COILED__ACCOUNT="alice"

  • Configured directly in Python code using dask.config.set

Configuration reference

The YAML snippet below shows the possible configuration options, along with their default values:

coiled:
  account: null                      # Default account
  backend-options: null              # Default backend_options
  server: https://cloud.coiled.io    # Default server
  token: ""                          # Default token
  user: ""                           # Default username

The account option

If you are part of a teams account, and you know that you will launch clusters, jobs or notebooks mostly in your team account, you can set the account option to point to to your team slug. By setting this option, the default behavior of launching clusters or any other service in your account is overwritten and will use the team account instead.

The account keyword argument is accepted in most of our API, this keyword argument gives you the flexibility of switching between your team and personal accounts when using the Coiled API.

Note

You don’t need a distinct token to use your team account – please continue to use your personal token

The backend-options option

There are several backend specific options that you can specify to customize Coiled’s behaviour. For example, if you are using a specific region to keep your assets and you want always to use this region when using Coiled, then you could add it to this configuration file to overwrite Coiled’s default region choice.

Note

Make sure to check if your region is supported in the backends documentation. If your region is not supported you can contact us.