Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update imageSpec doc #4875

Merged
merged 2 commits into from
Feb 14, 2024
Merged

Update imageSpec doc #4875

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6da5e1
update imageSpec doc
pingsutw Feb 9, 2024
0a7f3b0
nit
pingsutw Feb 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions docs/getting_started_with_workflow_development/flyte_project_components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,13 @@ The workflow directory also contains an `__init__.py` file to indicate that the
The workflow code file in the basic template includes an optional ImageSpec configuration. ImageSpec is a Flyte feature that enables you to build a custom container image without having to write a Dockerfile. To learn more, see the [ImageSpec documentation](https://docs.flyte.org/projects/cookbook/en/latest/auto_examples/customizing_dependencies/image_spec.html#image-spec-example)

```python
# basic_image = ImageSpec(
# name="flytekit", # rename this to your docker image name
# base_image="ghcr.io/flyteorg/flytekit:py3.11-1.10.2",
# # the base image that flytekit will use to build your image
# packages=["example-package"], # packages to add to the base image
# # remove "example-package" before using.
# registry="ghcr.io/unionai-oss",
# # the registry your image will be pushed to
# python_version="3.11"
# # the python version; optional if not different from the base image
# )
basic_image = ImageSpec(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is slightly different from the ImageSpec here: https://github.com/flyteorg/flytekit-python-template/blob/main/basic-template-imagespec/%7B%7Bcookiecutter.project_name%7D%7D/workflows/example.py#L22

Can you update the ImageSpec here to match the template, or if the template should be updated, can you change the template to match what you have here? Thanks!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated it here. flyteorg/flytekit-python-template#47

name="flytekit", # default docker image name.
base_image="ghcr.io/flyteorg/flytekit:py3.11-1.10.2", # the base image that flytekit will use to build your image.
packages=["pandas"], # python packages to install.
registry="ghcr.io/unionai-oss", # the registry your image will be pushed to.
python_version="3.11" # Optional if python is installed in the base image.
)
```

```{note}
Expand Down
Loading