Skip to content

Latest commit

 

History

History
112 lines (76 loc) · 6.02 KB

README.md

File metadata and controls

112 lines (76 loc) · 6.02 KB
Raw

Dockerfiles for .NET Core Builds

The Dockerfiles in this repository are used for building the .NET Core product. As such there are Dockerfiles for the various supported Linux distributions which setup the necessary prerequisites to build the .NET Core product.

Where are the published images

The images produced from the Dockerfiles are published to the microsoft/dotnet-buildtools-prereqs Docker Hub repository.

How to identify an image

The tag format used by an image is microsoft/dotnet-buildtools-prereqs:<linux-distribution-name>-<version>-<variant>-<dockerfile-commit-sha>-<date-time>

  • <linux-distribution-name> - name of the Linux distribution the image is based on
  • <version> - version of the Linux distribution
  • <variant> - name describing the specialization purpose of the image. Often special dependencies are needed for certain parts of the product. It can be beneficial to separate these dependencies into a separate Dockerfile/image.
  • <dockerfile-commit-sha> - Git commit SHA of the folder containing the Dockerfile the image was produced from
  • <date-time> - UTC timestamp (yyyyMMddhhmmss) of when the image was built

How to modify or create a new image

There will be a need for modifying existing Dockerfiles or creating new ones. For example, when a new Linux distribution/version needs to be supported, a corresponding Dockerfile will need to be created. The following steps are a guideline for modifying/creating Dockerfiles.

  1. Edit Dockerfiles

    • Add/Update the Dockerfile(s)
    • If new Dockerfile(s) were added, then update the manifest

  2. Validate the changes locally by running build.ps1. It is strongly suggested to specify the -DockerfilePath option to avoid the overhead of building all the images.

    For example, if editing the Fedora 24 Dockerfile, then run the following command to build just that Dockerfile.

    .\build.ps1 -DockerfilePath "fedora/24"

    It is a good practice to use --dry-run option on the first attempt to verify what commands will get run.

    .\build.ps1 -DockerfilePath "fedora/24" -ImageBuilderCustomArgs "--dry-run"

    Partial paths and wildcards in the -DockerfilePath option are also supported. The following example will build all the Fedora Dockerfiles.

    .\build.ps1 -DockerfilePath "fedora/*"

  3. Prepare a PR

Additional Info

Source Folder Structure

The folder structure used in src aligns with the tagging convention - <linux-distribution-name>-<version>-<variant>. For example, the Dockerfile used to produce the microsoft/dotnet-buildtools-prereqs:ubuntu-17.04-debpkg-c4fd48a-20171610061631 image is stored in the src/ubuntu/17.04/debpkg folder.

Manifest

The manifest.json contains metadata used by the build infrastructure to produce the Docker images. The metadata describes which Dockerfiles to build, what tags to produce, and where to publish the images. It is critical that the manifest gets updated appropriately when Dockerfiles are added/removed. Each Dockerfile will have an entry that looks like the following.

"platforms": [
    {
        "dockerfile": "alpine/3.6",
        "os": "linux",
        "tags": {
            "alpine-3.6-$(System:DockerfileGitCommitSha)-$(System:TimeStamp)": {}
        }
    }
]
  • dockerfile - relative path to the Dockerfile to build
  • os - (linux/windows) the OS type the Docker image is based on
  • tags - the collection of tags to create for the image
  • $(System:DockerfileGitCommitSha) and $(System:TimeStamp) - built in variable references that are evaluated at build time and substituted

Note: The position in manifest determines the sequence in which the image will be built.

Image Dependency

A precondition for building an image is to ensure that the base image specified in the FROM statement of the Dockerfile is available either locally or can be pulled from a Docker registry. Some of the microsoft/dotnet-buildtools-prereqs Dockerfiles depend on other microsoft/dotnet-buildtools-prereqs Dockerfiles (e.g. src/ubuntu/16.04/debpkg). In these cases, the FROM reference should not include the <dockerfile-commit-sha>-<date-time> portion of the tags. This is referred to as a stable tag as it does not change from build to build. This pattern is used so that the Dockerfiles do not need constant updating as new versions of the base images are built. To support this scenario, the manifest entry for the base image must be defined to produce the stable tag.

"platforms": [
    {
        "dockerfile": "ubuntu/16.04",
        "os": "linux",
        "tags": {
            "ubuntu-16.04-$(System:DockerfileGitCommitSha)-$(System:TimeStamp)": {},
            "ubuntu-16.04": {
                "isLocal": true
            }
        }
    }
]

Hooks

In certain cases, it is necessary to run custom logic before and after the Dockerfiles are built. For example, to build the Dockerfiles that are used for cross-gen builds, the rootfs that gets copied into the Docker image needs to be built on the host OS. To support these scenarios a pre-build or post-build bash or PowerShell script can be placed in a hooks folder next to the Dockerfile. The scripts will get invoked by the build process.

Warning: It is generally recommended to avoid the need to use hooks whenever possible.

Image-Builder

The underlying tool used to build the Dockerfiles is called Image-Builder. Its source is located at dotnet/docker-tools

For any questions, please contact dotnetdocker@microsoft.com