Skip to content

Commit ed62d10

Browse files
authored
Removed docker build docs + fixed CLI command for zenml pipeline build list (#2938)
* Hydrated pipeline build * removed docs for reuse docker build
1 parent 0baa9d6 commit ed62d10

File tree

6 files changed

+10
-83
lines changed

6 files changed

+10
-83
lines changed

docs/book/how-to/configure-python-environments/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,6 @@ When running locally, there is no real concept of an `execution` environment as
4141

4242
ZenML handles the Docker image configuration, creation, and pushing, starting with a [base image](https://hub.docker.com/r/zenmldocker/zenml) containing ZenML and Python, then adding pipeline dependencies. To manage the Docker image configuration, follow the steps in the [containerize your pipeline](../../how-to/customize-docker-builds/README.md) guide, including specifying additional pip dependencies, using a custom parent image, and customizing the build process.
4343

44-
The execution environments do not need to be built each time a pipeline is run - you can [reuse builds from previous runs to save time](../../how-to/customize-docker-builds/reuse-docker-builds.md).
45-
4644
## Image Builder Environment
4745

4846
By default, execution environments are created locally in the [client environment](#client-environment-or-the-runner-environment) using the local Docker client. However, this requires Docker installation and permissions. ZenML offers [image builders](../../component-guide/image-builders/image-builders.md), a special [stack component](../../component-guide/README.md), allowing users to build and push Docker images in a different specialized _image builder environment_.

docs/book/how-to/customize-docker-builds/build-the-pipeline-without-running.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

docs/book/how-to/customize-docker-builds/reuse-docker-builds.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/book/how-to/customize-docker-builds/use-code-repositories-to-speed-up-docker-build-times.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Use code repositories to speed up Docker build times
22

3-
While [reusing Docker builds](reuse-docker-builds.md) is useful, it can be limited. This is because specifying a custom build when running a pipeline will **not run the code on your client machine** but will use the code **included in the Docker images of the build**. As a consequence, even if you make local code changes, reusing a build will _always_ execute the code bundled in the Docker image, rather than the local code. Therefore, if you would like to reuse a Docker build AND make sure your local code changes are also downloaded into the image, you need to disconnect your code from the build.
3+
While reusing Docker builds is useful, it can be limited. This is because specifying a custom build when running a pipeline will **not run the code on your client machine** but will use the code **included in the Docker images of the build**. As a consequence, even if you make local code changes, reusing a build will _always_ execute the code bundled in the Docker image, rather than the local code. Therefore, if you would like to reuse a Docker build AND make sure your local code changes are also downloaded into the image, you need to disconnect your code from the build.
44

55
You can do so by connecting a git repository. Registering a code repository lets you avoid building images each time you run a pipeline **and** quickly iterate on your code. When running a pipeline that is part of a local code repository checkout, ZenML can instead build the Docker images without including any of your source files, and download the files inside the container before running your code. This greatly speeds up the building process and also allows you to reuse images that one of your colleagues might have built for the same stack.
66

docs/book/toc.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,7 @@
106106
* [Specify pip dependencies and apt packages](how-to/customize-docker-builds/specify-pip-dependencies-and-apt-packages.md)
107107
* [Use your own Dockerfiles](how-to/customize-docker-builds/use-your-own-docker-files.md)
108108
* [Which files are built into the image](how-to/customize-docker-builds/which-files-are-built-into-the-image.md)
109-
* [Reuse Docker builds to speed up Docker build times](how-to/customize-docker-builds/reuse-docker-builds.md)
110109
* [Use code repositories to automate Docker build reuse](how-to/customize-docker-builds/use-code-repositories-to-speed-up-docker-build-times.md)
111-
* [Build the pipeline without running](how-to/customize-docker-builds/build-the-pipeline-without-running.md)
112110
* [Define where an image is built](how-to/customize-docker-builds/define-where-an-image-is-built.md)
113111
* [⚒️ Manage stacks & components](how-to/stack-deployment/README.md)
114112
* [Deploy a cloud stack with ZenML](how-to/stack-deployment/deploy-a-cloud-stack.md)

src/zenml/cli/pipeline.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,7 @@ def list_pipeline_builds(**kwargs: Any) -> None:
516516
client = Client()
517517
try:
518518
with console.status("Listing pipeline builds...\n"):
519-
pipeline_builds = client.list_builds(**kwargs)
519+
pipeline_builds = client.list_builds(hydrate=True, **kwargs)
520520
except KeyError as err:
521521
cli_utils.error(str(err))
522522
else:
@@ -526,7 +526,14 @@ def list_pipeline_builds(**kwargs: Any) -> None:
526526

527527
cli_utils.print_pydantic_models(
528528
pipeline_builds,
529-
exclude_columns=["created", "updated", "user", "workspace"],
529+
exclude_columns=[
530+
"created",
531+
"updated",
532+
"user",
533+
"workspace",
534+
"images",
535+
"stack_checksum",
536+
],
530537
)
531538

532539

0 commit comments

Comments
 (0)