docs: clarify how User Code images are created in Docker
ClosedPublic
Actions

Authored by • rexledesma on Jul 7 2021, 2:47 PM.

Details

Reviewers

• jordansanders
• dgibson
• catherinewu

Commits

R1:4269f7a3a2fa: docs: clarify how User Code images are created in Docker

Summary

Resolves https://github.com/dagster-io/dagster/issues/3590.

We now explicitly mention what the Dockerfile should do - it should contain the
Dagster repository and any dependencies that it relies on.

However, in production scenarios, rather than copying user code and install dependencies individually,
the user is most likely to just install a python package containing all of their code. Here, we add
further clarification on that, mentioning that dagsterApiGrpcArgs can support this out of the box.

Test Plan

make dev

Diff Detail

Repository

R1 dagster

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

• rexledesma created this revision.Jul 7 2021, 2:47 PM

• rexledesma published this revision for review.Jul 7 2021, 3:24 PM

Harbormaster completed remote builds in B33309: Diff 41073.Jul 7 2021, 3:32 PM

Harbormaster failed remote builds in B33316: Diff 41086!Jul 7 2021, 3:50 PM

see suggestions inline, thanks for doing this

docs/content/deployment/guides/kubernetes/deploying-with-helm.mdx
158–162	this sentence doesn't quite parse maybe "Build a Docker image containing your repository and any dependencies needed to execute the business logic in your pipelines"?
160	s/Dagster related/Dagster-related/g? side note can we remove cron from this Dockerfile? Dagster doesn't need cron anymore. Generally I think it's kind of a strange / crufty example to link to, not directly related to this diff though. "copy over the Dagster implementation" reads a little weird. Maybe "copy over the Dagster libraries"? What is the this in "We'll need to remember this"? Is it "We'll need to reference this Docker image later in a [subsequent step]"?
162	is 'package your Python project' better than 'publish your Python project as a package?
178	Link to https://docs.dagster.io/concepts/repositories-workspaces/workspaces#running-your-own-grpc-server here to explain what 'dagster api grpc' is?
197	s/through/from a?