Skip to content

Commit

Permalink
add basic auth docs
Browse files Browse the repository at this point in the history
  • Loading branch information
michaeljguarino committed Dec 18, 2023
1 parent 29ad076 commit e09dfcc
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions dagster/plural/docs/basic-auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Configuring Basic Auth

Dagster's api and web interface is not authenticated by default. We provide an oauth proxy by default to grant some security to your dagster install, but in order to integrate with tools like airflow, you'll likely want a means to authenticate with static creds. That's where basic auth can be very useful. The process is very simple.

### modify context.yaml

in the `context.yaml` file at the root of your repo, simply add:

```yaml
configuration:
dagster:
users:
<name>: <password>
<name2>: <password2>
```
you can use `plural crypto random` to generate a high-entropy password if that is helpful as well.

### redeploy

Simply run `plural build --only dagster && plural deploy --commit "enabling basic auth"` to wire in the credentials to our oauth proxy. Occasionally you need to restart the web pods to get it to take, you can find them with:

```sh
kubectl get pods -n dagster | grep dagster-webserver
```

then delete them (allowing k8s to restart) with:

```sh
kubectl delete pod <name> -n dagster
```

0 comments on commit e09dfcc

Please sign in to comment.