Page MenuHomeElementl

Update Kubernetes deployment docs
ClosedPublic

Authored by rexledesma on Mar 16 2021, 11:54 PM.

Details

Reviewers
catherinewu
nate
Group Reviewers
Restricted Project
Commits
R1:09578d3dd0a0: Update Kubernetes deployment docs
Summary

We split the kubernetes deployment guide into three sections:

  1. Deploying Dagster with Helm (default settings)
  2. Deploying Dagster with Helm, Advanced (deploy using Celery)
  3. Customizing your Kubernetes Deployment (walkthrough on common ways to customize your Helm deployment)
Test Plan

make dev

Diff Detail

Repository
R1 dagster
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

Harbormaster returned this revision to the author for changes because remote builds failed.Mar 17 2021, 12:38 AM
Harbormaster failed remote builds in B27565: Diff 33715!

i like the structure A LOT!! Thanks for putting this together <3

Will defer the content to @catherinewu and @sashank

On a side note, can you compress these images a bit - 1-2 MB is pretty large - any online* compression tool works

a few non-blocking comments. looks good!

docs/content/_navigation.json
280

I feel like "Kubernetes Deployment Guides" should be a child of the "Deployment Guides" section since the former is an instance of the latter.

We could rename the section titles to be non intersecting:

  • "Kubernetes Deployment Guides" vs "Other Deployment Guides"?
  • "Recommended Deployment Guides" vs "Other Deployment Guides"?

Separately, it would be nice to plainly state that the Kubernetes option is our recommended deployment (most actively developed, production usage w/ design partners, active community, etc)

docs/content/deployment.mdx
12

not a problem with your diff, but this description seems unintentionally copied

docs/content/deployment/guides/kubernetes/customizing-your-deployment.mdx
7
12

half of these customizations also apply to the default guide

docs/content/deployment/guides/kubernetes/deploying-with-helm-advanced.mdx
168

I thought we decided to duplicate the information instead of linking back to the default guide? cc @yuhan

This revision is now accepted and ready to land.Mar 17 2021, 11:13 PM
docs/content/deployment/guides/kubernetes/deploying-with-helm-advanced.mdx
168

i think either works:

  • this way makes it clear to users which parts stay the same as the basic set up.
  • duplicating is good for readers to entirely rely on this one pager without jumping back and forth.

i dont feel strongly either way :)

This revision was automatically updated to reflect the committed changes.