From a4a2c38c5fe1581fea187c2f8a8046c0f6c0d7e5 Mon Sep 17 00:00:00 2001 From: Yee Hing Tong Date: Thu, 5 Sep 2024 23:22:57 -0700 Subject: [PATCH] update for image spec Signed-off-by: Yee Hing Tong --- docs/user_guide/customizing_dependencies/imagespec.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/user_guide/customizing_dependencies/imagespec.md b/docs/user_guide/customizing_dependencies/imagespec.md index ccdd52fe28..bf5d6fc32e 100644 --- a/docs/user_guide/customizing_dependencies/imagespec.md +++ b/docs/user_guide/customizing_dependencies/imagespec.md @@ -103,3 +103,9 @@ or image = ImageSpec(registry="ghcr.io/flyteorg", packages=["pandas"]).force_push() ``` [flytesnacks]: https://github.com/flyteorg/flytesnacks/tree/master/examples/customizing_dependencies/ + +## Getting source files into ImageSpec +Typically, getting source code files into a task's image at run time on a live Flyte backend is done through the fast registration mechanism. +If the `source_root` and `copy` fields to an `ImageSpec` are left blank, then whether or not your source files are copied into the built `ImageSpec` image is basically the inverse of whether fast register is used. Please see [registering workflows](https://docs.flyte.org/en/latest/flyte_fundamentals/registering_workflows.html#containerizing-your-project) for the full explanation. + +Keep in mind that because files are sometimes copied into the built image, the tag that is published for an ImageSpec will change based on whether fast register is enabled, and the contents of any files copied.