From 4435574464b367514295c19615b12d62217892d1 Mon Sep 17 00:00:00 2001 From: John Walicki Date: Wed, 6 Nov 2024 23:44:21 -0500 Subject: [PATCH] Fix docker build flag (#1191) Signed-off-by: John Walicki --- docs/src/internal-build.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/docs/src/internal-build.md b/docs/src/internal-build.md index 11d2fb864..588395047 100644 --- a/docs/src/internal-build.md +++ b/docs/src/internal-build.md @@ -3,7 +3,7 @@ - When building the runtime we must use Ubuntu 22.04 docker image - When making an IRD reservation use `--docker-image yyz-gitlab.local.tenstorrent.com:5005/tenstorrent/infra/ird-ubuntu-22-04-amd64:latest` -- You'll have to manaully install a newer version of cmake, at least 3.22, the easiest way to do this is to `pip install cmake` and make sure this one is in your path +- You'll have to manually install a newer version of cmake, at least 3.22, the easiest way to do this is to `pip install cmake` and make sure this one is in your path - You'll want LLVM installation to persist IRD reservations, you can achieve this by: - mkdir /localdev/$USER/ttmlir-toolchain - When requesting an IRD use `--volumes /localdev/$USER/ttmlir-toolchain:/opt/ttmlir-toolchain` @@ -11,27 +11,28 @@ ## Working with Docker Images Components: - - Dockerfile - - Workflow for building Docker image - - Project build using Docker image + +- Dockerfile +- Workflow for building Docker image +- Project build using Docker image ### Overview -We use docker images to prepare project enviroment, install dependancies, tooling and prebuild toolchain. +We use docker images to prepare the project environment, install dependencies, tooling and prebuild toolchain. Project builds four docker images: -Base image `tt-mlir-base-ubuntu-22-04` [Dockerfile.base](.github/Dockerfile.base) -CI image `tt-mlir-ci-ubuntu-22-04` [Dockerfile.ci](.github/Dockerfile.ci) -Base IRD image `tt-mlir-base-ird-ubuntu-22-04`[Dockerfile.ird](.github/Dockerfile.ird) -IRD image `tt-mlir-ird-ubuntu-22-04` [Dockerfile.ird](.github/Dockerfile.ird) +- Base image `tt-mlir-base-ubuntu-22-04` [Dockerfile.base](.github/Dockerfile.base) +- CI image `tt-mlir-ci-ubuntu-22-04` [Dockerfile.ci](.github/Dockerfile.ci) +- Base IRD image `tt-mlir-base-ird-ubuntu-22-04`[Dockerfile.ird](.github/Dockerfile.ird) +- IRD image `tt-mlir-ird-ubuntu-22-04` [Dockerfile.ird](.github/Dockerfile.ird) -Base image starts with a supported base image (Ubuntu 22.04) and installs dependancies for project build. From there we build CI image that contains prebuild toolcahin and is used in CI to shoten the build time. IRD image contain dev tools like GDB, vim etc and shh and are use in IRD enviroments. +Base image starts with a supported base image (Ubuntu 22.04) and installs dependencies for project build. From there, we build the CI image that contains the prebuild toolchain and is used in CI to shorten the build time. IRD image contains dev tools like GDB, vim etc and ssh which are used in IRD enviroments. During the CI Docker build, the project is built and tests are run to ensure that everything is set up correctly. If any dependencies are missing, the Docker build will fail. ### Building the Docker Image using GitHub Actions -The GitHub Actions workflow [Build and Publish Docker Image](.github/workflows/build-image.yml) builds the Docker images and uploads them to GitHub Packages at https://github.com/orgs/tenstorrent/packages?repo_name=tt-mlir. We use the git SHA we build from as the tag. +The GitHub Actions workflow [Build and Publish Docker Image](.github/workflows/build-image.yml) builds the Docker images and uploads them to GitHub Packages at [https://github.com/orgs/tenstorrent/packages?repo_name=tt-mlir](https://github.com/orgs/tenstorrent/packages?repo_name=tt-mlir). We use the git SHA we build from as the tag. ### Building the Docker Image Locally @@ -39,8 +40,8 @@ To test the changes and build the image locally, use the following command: ```bash docker build -f .github/Dockerfile.base -t ghcr.io/tenstorrent/tt-mlir/tt-mlir-base-ubuntu-22-04:latest . docker build -f .github/Dockerfile.ci -t ghcr.io/tenstorrent/tt-mlir/tt-mlir-ci-ubuntu-22-04:latest . -docker build -f .github/Dockerfile.ird -build-args FROM_IMAGE=base -t ghcr.io/tenstorrent/tt-mlir/tt-mlir-ird-base-ubuntu-22-04:latest . -docker build -f .github/Dockerfile.ird -build-args FROM_IMAGE=ci -t ghcr.io/tenstorrent/tt-mlir/tt-mlir-ird-ubuntu-22-04:latest . +docker build -f .github/Dockerfile.ird --build-arg FROM_IMAGE=base -t ghcr.io/tenstorrent/tt-mlir/tt-mlir-ird-base-ubuntu-22-04:latest . +docker build -f .github/Dockerfile.ird --build-arg FROM_IMAGE=ci -t ghcr.io/tenstorrent/tt-mlir/tt-mlir-ird-ubuntu-22-04:latest . ``` ### Using the Image in GitHub Actions Jobs