From cd5aff2216350ea2ba592573845cc1209d93dfe0 Mon Sep 17 00:00:00 2001 From: Ido David Date: Mon, 25 Mar 2024 15:14:16 -0400 Subject: [PATCH 1/4] first version --- .arg | 3 + .github/CODEOWNERS | 2 + .github/renovate.json5 | 102 ++++++++++ .github/workflows/ci.yml | 43 ++++ .github/workflows/release.yml | 37 ++++ CONTRIBUTING.md | 15 ++ Earthfile | 18 ++ LICENSE | 373 ++++++++++++++++++++++++++++++++++ README.md | 83 +++++++- common/Earthfile | 130 ++++++++++++ os/alpine/Earthfile | 42 ++++ os/ubuntu-20.04/Earthfile | 42 ++++ os/ubuntu-23.04/Earthfile | 42 ++++ 13 files changed, 931 insertions(+), 1 deletion(-) create mode 100644 .arg create mode 100644 .github/CODEOWNERS create mode 100644 .github/renovate.json5 create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/release.yml create mode 100644 CONTRIBUTING.md create mode 100644 Earthfile create mode 100644 LICENSE create mode 100644 common/Earthfile create mode 100644 os/alpine/Earthfile create mode 100644 os/ubuntu-20.04/Earthfile create mode 100644 os/ubuntu-23.04/Earthfile diff --git a/.arg b/.arg new file mode 100644 index 0000000..8271990 --- /dev/null +++ b/.arg @@ -0,0 +1,3 @@ +DOCKERHUB_USER=earthly +IMAGE_NAME=dind +EARTHLY_REPO_VERSION=ido-dind-preparations diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..e2d3d45 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +# PRs require approval from the earthly core team +* @earthly/core diff --git a/.github/renovate.json5 b/.github/renovate.json5 new file mode 100644 index 0000000..8ab6153 --- /dev/null +++ b/.github/renovate.json5 @@ -0,0 +1,102 @@ +{ + $schema: "https://docs.renovatebot.com/renovate-schema.json", + extends: [ + "config:recommended" + ], + configMigration: true, + prHourlyLimit: 1, + schedule: [ // utc timezone + 'after 6am on monday', + ], + enabledManagers: [ + 'dockerfile', + 'custom.regex', + 'github-actions', + ], + dockerfile: { + fileMatch: [ + 'Earthfile', + ], + }, + customManagers: [ + { + // Earthly Version in GH Actions + customType: 'regex', + fileMatch: [ + '.*?\\.yml', + ], + matchStrings: [ + '- uses: earthly/actions/setup-earthly@.*?[\\s\\n]+.*?[\\s\\n]+with:[\\s\\n]*version: (?.*?)[\\s\\n/]+', + ], + depNameTemplate: 'earthly/earthly', + datasourceTemplate: 'github-releases', + }, + { + // ARG/LET in Earthfile that have a Renovate comment + customType: 'regex', + fileMatch: [ + 'Earthfile', + ], + matchStrings: [ + '\\s*#\\s*renovate:\\s*datasource=(?.*?)\\s+depName=(?.*?)[\\s\\n]+(versioning=(?.*?)\\s+)?(ARG|LET)\\s+.*?(_VERSION|_VER|version)=(?.*?)($|\\s|\\n)', + ], + }, + { + // Updating the Repology alpine version + customType: 'regex', + fileMatch: [ + 'Earthfile', + ], + matchStrings: [ + '# renovate: datasource=repology depName=alpine_(?\\d+_\\d+)', + ], + currentValueTemplate: "{{{ replace '_' '.' currentValue }}}", + datasourceTemplate: 'docker', + depNameTemplate: 'alpine', + versioningTemplate: 'regex:^(?\\d+)[._](?\\d+)$', + autoReplaceStringTemplate: '# renovate: datasource=repology depName=alpine_{{{newMajor}}}_{{{newMinor}}}', + }, + { + // Updating the commit hash of earthly/earthly + customType: 'regex', + fileMatch: ['^\\.arg$'], + matchStrings: [ + 'EARTHLY_REPO_VERSION=(?.*?)($|\\s|\\n)', + ], + currentValueTemplate: 'main', + depNameTemplate: 'earthly/earthly', + packageNameTemplate: 'https://github.com/earthly/earthly', + datasourceTemplate: 'git-refs', + }, + ], + labels: [ + 'renovate', + ], + packageRules: [ + // set the group name for alpine dind dependencies + { + groupName: "{{{ replace 'os\\/(.*?)$' '$1' packageFileDir}}}-dind-image", + matchPackagePatterns: [ + 'alpine', + 'alpine.*?/docker', + 'docker/docker', + ], + matchManagers: [ + 'custom.regex', + ], + matchDatasources: [ + 'docker', + 'repology', + 'github-releases', + ], + matchFileNames: [ + 'os/**/Earthfile', + ], + }, + { + // let all package updates auto merge + matchPackagePatterns: [ '*' ], + automerge: true, + }, + ], +} diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..09f3f49 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,43 @@ +name: CI + +on: + # TODO: enable when this bug is resolved: https://github.com/earthly/earthly/issues/3930 + # push: + # branches: [ "main" ] + pull_request: + branches: [ "main" ] + +concurrency: + group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} + cancel-in-progress: true + +jobs: + test: + name: test + runs-on: ubuntu-latest + env: + FORCE_COLOR: 1 + EARTHLY_CONVERSION_PARALLELISM: "5" + EARTHLY_TOKEN: "${{ secrets.EARTHLY_TOKEN }}" + EARTHLY_INSTALL_ID: "earthly-dind-githubactions" + steps: + - uses: earthly/actions/setup-earthly@v1 + with: + version: v0.8.5 + - uses: actions/checkout@v4 + - name: Docker login (non fork only) + run: |- + docker login --username "${{ secrets.DOCKERHUB_USERNAME }}" --password "${{ secrets.DOCKERHUB_TOKEN }}" + docker login registry-1.docker.io.mirror.corp.earthly.dev --username "${{ secrets.DOCKERHUB_MIRROR_USERNAME }}" --password "${{ secrets.DOCKERHUB_MIRROR_PASSWORD }}" + if: github.event.pull_request.head.repo.full_name == github.repository + - name: Configure Earthly to use mirror (non fork only) + run: |- + earthly config global.buildkit_additional_config "'[registry.\"docker.io\"] + mirrors = [\"registry-1.docker.io.mirror.corp.earthly.dev\"]'" + if: github.event.pull_request.head.repo.full_name == github.repository + - name: Run tests + run: |- + earthly config git "{github.com: {auth: ssh, user: git}}" && \ + eval $(ssh-agent) && \ + earthly secrets --org earthly-technologies --project core get littleredcorvette-id_rsa | ssh-add - && \ + earthly --ci -P --push --org earthly-technologies --satellite dind +test diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..16e06c6 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,37 @@ +name: Release + +on: + pull_request_target: + types: [ closed ] + +jobs: + release: + name: release after merging ${{ github.head_ref }} + if: github.event.pull_request.merged == true && startsWith(github.head_ref, 'renovate/') && endsWith(github.head_ref, '-dind-image') + runs-on: ubuntu-latest + env: + FORCE_COLOR: 1 + EARTHLY_CONVERSION_PARALLELISM: "5" + EARTHLY_TOKEN: "${{ secrets.EARTHLY_TOKEN }}" + EARTHLY_INSTALL_ID: "earthly-dind-githubactions" + steps: + - uses: earthly/actions/setup-earthly@v1 + with: + version: v0.8.5 + - uses: actions/checkout@v4 + - name: Docker login (non fork only) + run: |- + docker login --username "${{ secrets.DOCKERHUB_USERNAME }}" --password "${{ secrets.DOCKERHUB_TOKEN }}" + docker login registry-1.docker.io.mirror.corp.earthly.dev --username "${{ secrets.DOCKERHUB_MIRROR_USERNAME }}" --password "${{ secrets.DOCKERHUB_MIRROR_PASSWORD }}" + if: github.event.pull_request.head.repo.full_name == github.repository + - name: Configure Earthly to use mirror (non fork only) + run: |- + earthly config global.buildkit_additional_config "'[registry.\"docker.io\"] + mirrors = [\"registry-1.docker.io.mirror.corp.earthly.dev\"]'" + if: github.event.pull_request.head.repo.full_name == github.repository + - name: Build & Push image + run: |- + earthly config git "{github.com: {auth: ssh, user: git}}" && \ + eval $(ssh-agent) && \ + earthly secrets --org earthly-technologies --project core get littleredcorvette-id_rsa | ssh-add - && \ + earthly --ci -P --push --org earthly-technologies --satellite dind +release --RENOVATE_BRANCH=${{github.head_ref}} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a83ba7d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing + +## Code of Conduct + +Please refer to the [CNCF Community Code of Conduct v1.0](https://github.com/cncf/foundation/blob/main/code-of-conduct.md) + +## CLA + +### Individual + +All contributions must indicate agreement to the [Earthly Contributor License Agreement](https://gist.github.com/vladaionescu/ed990fa149a38a53ac74b64155bc6766) by logging into GitHub via the CLA assistant and signing the provided CLA. The CLA assistant will automatically notify the PRs that require CLA signing. + +### Entity + +If you are an entity, please use the [Earthly Contributor License Agreement form](https://earthly.dev/cla-form) in addition to requiring your individual contributors to sign all contributions. diff --git a/Earthfile b/Earthfile new file mode 100644 index 0000000..3729483 --- /dev/null +++ b/Earthfile @@ -0,0 +1,18 @@ +VERSION --wildcard-builds 0.8 + +PROJECT earthly-technologies/core + +# test runs tests for all defined dind images in this repo +test: + BUILD --pass-args ./os/*+test-build + +# release expects to get a renovate branch in the form of renovate/-dind-image, extracts the os and then kicks off its +release target +# this is meant to be run by a github workflow +release: + FROM alpine + # RENOVATE_BRANCH is the renovate branch that is expected to get merged and trigger this target + ARG --required RENOVATE_BRANCH + LET os=${RENOVATE_BRANCH#renovate/} + # using a LET/SET in the target path does not work, use an ARG instead until it's fixed + ARG OS=${os%-dind-image} + BUILD --pass-args ./os/$OS+release diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..fa0086a --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. \ No newline at end of file diff --git a/README.md b/README.md index 5ec586d..c6da432 100644 --- a/README.md +++ b/README.md @@ -1 +1,82 @@ -first commit +# Earthly dind (Docker In Docker) Images +[![Release](https://github.com/earthly/dind/actions/workflows/release.yml/badge.svg)](https://github.com/earthly/dind/actions/workflows/release.yml) +![Docker Pulls](https://img.shields.io/docker/pulls/earthly/dind) + + +Earthly's official [earthly/dind](https://hub.docker.com/repository/docker/earthly/dind/general) docker images. +For information on how to use these images, please refer to [docker in earthly](https://docs.earthly.dev/docs/guides/docker-in-earthly). + +## Supported Distributions + +There are currently 3 supported dind distributions available: +- `alpine` +- `ubuntu:20.04` +- `ubuntu:23.04` + +Other distributions and/or base images can be used with our [dind+INSTALL](https://docs.earthly.dev/docs/guides/docker-in-earthly#performance) [FUNCTION](https://docs.earthly.dev/docs/guides/functions). + +## How Images are Built + +In this repository, we maintain the OS & Docker versions that warrants releasing a new version of the image. +However, the installations of docker and other dependencies are done via an installation script that is currently maintained in [earthly/earthly](https://github.com/earthly/earthly). + +### Dependencies + +Dependencies are maintained by Renovate and will be merged automatically (provided required checks pass), primarly +dependencies that will trigger new versions of the dind images such as the docker or the os (alpine) versions. + + + +## Repo structure + +```bash +. +├── Earthfile // Targets that apply to all images (e.g. +test) +├── common +│ └── Earthfile // A library of common helper targets +└── os // Each directory contains an Earthfile with targets to maintain the specific os (e.g. +test, +build) + ├── alpine + │ └── Earthfile + ├── ubuntu-20.04 + │ └── Earthfile + └── ubuntu-23.04 + └── Earthfile +``` + +## Testing + +Images are tested by running remote test targets that are maintained in [earthly/earthly](https://github.com/earthly/earthly/tree/main/tests/with-docker). This is because these tests also help test [WITH DOCKER](https://docs.earthly.dev/docs/earthfile#with-docker) command in earthly cli. + +Temporary images are built, pushed, and pulled as part of the test cycle. + +### How to run tests + +* Test a specific image os: + +```bash +earthly --push -P ./os/+test-build +``` + +* Test all images: +```bash +earthly --push -P +test +``` + +#### Community members +Community members do not have permissions to push a built image and run the tests against it. However, they can easily set a different dockerhub repository by changing the `DOCKERHUB_USER` ARG value in [.arg](.arg) to a private repository or by passing the arg in the earthly command, e.g. `earthly --push -P +test --DOCKERHUB_USER=`. + +## Deployment + +When the relevant dependencies are updates by Renovate, new images/tags will be pushed automatically to the docker registry. + +## Contributing + +* Please report bugs as [GitHub issues](https://github.com/earthly/dind/issues). +* Join us on [Slack](https://earthly.dev/slack)! +* Questions via GitHub issues are welcome! +* PRs welcome! But please give a heads-up in a GitHub issue before starting work. If there is no GitHub issue for what you want to do, please create one. +* Check the [contributing page](./CONTRIBUTING.md) for more details. + +## Licensing + +Earthly is licensed under the Mozilla Public License Version 2.0. See [LICENSE](./LICENSE). diff --git a/common/Earthfile b/common/Earthfile new file mode 100644 index 0000000..24a433e --- /dev/null +++ b/common/Earthfile @@ -0,0 +1,130 @@ +VERSION --build-auto-skip 0.8 +PROJECT earthly-technologies/core + +FROM alpine + +# EARTHLY_REPO_VERSION specifies a branch and/or commit of earthly/earthly (it defaults to the earthly cli version if left empty) +ARG EARTHLY_REPO_VERSION + +IMPORT github.com/earthly/earthly/buildkitd:$EARTHLY_REPO_VERSION AS earthly +IMPORT github.com/earthly/earthly/tests/with-docker:$EARTHLY_REPO_VERSION AS with-docker +IMPORT github.com/earthly/earthly/tests/with-docker-kind:$EARTHLY_REPO_VERSION AS with-docker-kind + +# DOCKERHUB_USER is the organization name in docker hub (default: earthly) +ARG --global DOCKERHUB_USER +# IMAGE_NAME is the image repository in docker hub (default: dind) +ARG --global IMAGE_NAME + +# build builds both the alpine and ubuntu dind images for earthly +build: + # OS_IMAGE is the base image to use, e.g. alpine, ubuntu + ARG --required OS_IMAGE + # OS_VERSION is the version of the base OS to use, e.g. 3.18.0, 23.04 + ARG --required OS_VERSION + # DOCKER_VERSION is the version of docker to use, e.g. 20.10.14 + ARG --required DOCKER_VERSION + FROM $OS_IMAGE:$OS_VERSION + COPY earthly+export-docker-script/docker-auto-install.sh /usr/local/bin/docker-auto-install.sh + RUN docker-auto-install.sh + LET DOCKER_VERSION_TAG=$DOCKER_VERSION + IF [ "$OS_IMAGE" = "alpine" ] + RUN apk add iptables-legacy # required for older kernels + END + # DOCKERHUB_USER is the organization name in docker hub (default: earthly) + ARG DOCKERHUB_USER + # IMAGE_NAME is the image repository in docker hub (default: dind) + ARG IMAGE_NAME + COPY --dir --pass-args +get-image-info/image-info . + LET image_name=$(cat image-info/name) + LET image_tag=$(cat image-info/tag) + RUN rm -rf image-info + SAVE IMAGE --push --cache-from=$image_name:$OS_IMAGE-main $image_name:$image_tag + +# get-image-info generates the image name and tag as a saved artifact so it can be used by multiple targets +get-image-info: + # OS_IMAGE is the base image to use, e.g. alpine, ubuntu + ARG --required OS_IMAGE + # OS_VERSION is the version of the base OS to use, e.g. 3.18.0, 23.04 + ARG --required OS_VERSION + # DOCKER_VERSION is the version of docker to use, e.g. 20.10.14 + ARG --required DOCKER_VERSION + LET DOCKER_VERSION_TAG=$DOCKER_VERSION + IF [ "$OS_IMAGE" = "ubuntu" ] + # the docker ce repo contains packages such as "5:24.0.4-1~ubuntu.20.04~focal", we will remove the epoch and debian-revision values, + # in order to display the upstream-version, e.g. "24.0.5-1". + SET DOCKER_VERSION_TAG="$(echo $DOCKER_VERSION | sed 's/^[0-9]*:\([^~]*\).*$/\1/')" + RUN if echo $DOCKER_VERSION_TAG | grep "[^0-9.-]"; then echo "DOCKER_VERSION_TAG looks bad; got $DOCKER_VERSION_TAG" && exit 1; fi + END + LET TAG=$OS_IMAGE-$OS_VERSION-docker-$DOCKER_VERSION_TAG + # DOCKERHUB_USER is the organization name in docker hub (default: earthly) + ARG --required DOCKERHUB_USER + # IMAGE_NAME is the image repository in docker hub (default: dind) + ARG --required IMAGE_NAME + LET image_full_name=$DOCKERHUB_USER/$IMAGE_NAME + ARG SUFFIX + IF [ -n "$SUFFIX" ] + SET TAG="$TAG-$SUFFIX" + END + LET dir=image-info + RUN mkdir $dir + RUN echo $image_full_name > $dir/name && echo $TAG > $dir/tag + SAVE ARTIFACT $dir + +# test runs tests against the specified image (DIND_IMAGE) or otherwise uses the image specified in earthly/earthly repo +test: + # DIND_IMAGE is the full docker image name & tag to run the tests against. The image must exist in the remote docker registry + ARG DIND_IMAGE + BUILD --pass-args with-docker+all --DIND_IMAGE=$DIND_IMAGE + +# build-and-test is used to build a new image and run tests against it after pushing it to registry +# this can be used on either the final image or a test image (which is differentiated by the repo and tag that is used) +# this target will call +build & +test targets that are defined in $DIR_PATH/Earthfile +# Note: +test will only run when executing earthly with the --push flag since the tests need to run against the pushed image +build-and-test: + # DIR_PATH needs to match the directory name of the linux distribution of the dind image (alpine, ubuntu-22.04, ...) + ARG --required DIR_PATH + WAIT + # todo: do we need to invlidate cache when date is updated? + BUILD --pass-args ../os/$DIR_PATH+build + END + # run tests using the image that was pushed above (if it was pushed) + COPY --dir --pass-args +get-image-info/image-info . + LET image_name=$(cat image-info/name) + LET image_tag=$(cat image-info/tag) + WAIT + # EARTHLY_PUSH is a builtin arg that helps determine if the tests should run + ARG EARTHLY_PUSH + IF [ "$EARTHLY_PUSH" = "true" ] + BUILD --pass-args ../os/$DIR_PATH+test --DIND_IMAGE=$image_name:$image_tag + END + END + +# push-new-tag expects to get an image with a tag that contains a date as a suffix, and save the image with the same tag but without the date suffix +# this is used to "graduate" the image version from a temporary version to an official version. +push-new-tag: + FROM alpine + ARG --required TAG_WITH_DATE + WAIT + IF ! [[ "$TAG_WITH_DATE" =~ "-[0-9]{14}$" ]] + RUN --no-cache echo "the specified image tag ($TAG_WITH_DATE) does not have a date suffix" && \ + exit 1 + END + END + FROM $DOCKERHUB_USER/$IMAGE_NAME:$TAG_WITH_DATE + LET new_tag="$(echo ${TAG_WITH_DATE%-*})" + IF [ "$new_tag" = "$TAG_WITH_DATE" ] + RUN --no-cache echo "failed to remove date from tag $TAG_WITH_DATE" && exit 1 + END + SAVE IMAGE --push $DOCKERHUB_USER/$IMAGE_NAME:$new_tag + +# push-new-tag-multi-platform builds push-new-tag using both amd64 & arm64 platforms. +push-new-tag-multi-platform: + BUILD --pass-args --platform=linux/amd64 --platform=linux/arm64 +push-new-tag + +# alpine-kind-test is a specific test for alpine, we put it in this file consolidate the IMPORT statement in one file +alpine-kind-test: + BUILD --pass-args with-docker-kind+alpine-kind + +# ubuntu-kind-test is a specific test for ubuntu, we put it in this file consolidate the IMPORT statement in one file +ubuntu-kind-test: + BUILD --pass-args with-docker-kind+ubuntu-kind diff --git a/os/alpine/Earthfile b/os/alpine/Earthfile new file mode 100644 index 0000000..a634dbb --- /dev/null +++ b/os/alpine/Earthfile @@ -0,0 +1,42 @@ +VERSION --build-auto-skip 0.8 + +PROJECT earthly-technologies/core + +FROM alpine + +IMPORT ../../common AS common + +ARG --global OS_IMAGE=alpine + +# renovate: datasource=docker depName=alpine +ARG --global OS_VERSION=3.19 +# renovate: datasource=repology depName=alpine_3_19/docker versioning=loose +ARG --global DOCKER_VERSION=25.0.3-r1 + +# DIR_PATH is set to that common targets can call os specific targets. It should match the directory name this Earthfile is located in +ARG --global DIR_PATH=$OS_IMAGE + +# release builds the image using a new datetime as a suffix and run tests against the pushed image, then finally retag and push the image without the datetime suffix +release: + RUN --no-cache date --utc +%Y%m%d%H%M%S > datetime + LET datetime="$(cat datetime)" + WAIT + BUILD --pass-args common+build-and-test --SUFFIX=$datetime + END + COPY --dir --pass-args common+get-image-info/image-info . + LET image_tag="$(cat image-info/tag)-$datetime" + BUILD --pass-args common+push-new-tag-multi-platform --TAG_WITH_DATE=$image_tag + +# test-build will build a test image that is pushed to a temporary registry and run tests against it +test-build: + BUILD --pass-args common+build-and-test --IMAGE_NAME="dindtest" + +# build builds an dind:alpine image +build: + BUILD --pass-args --platform=linux/amd64 --platform=linux/arm64 common+build + +# test runs test for a dind:alpine image +# this is primarly used to run against a newly, temporariy image build by +test-build +test: + BUILD --pass-args common+alpine-kind-test + BUILD --pass-args common+test diff --git a/os/ubuntu-20.04/Earthfile b/os/ubuntu-20.04/Earthfile new file mode 100644 index 0000000..9e576f6 --- /dev/null +++ b/os/ubuntu-20.04/Earthfile @@ -0,0 +1,42 @@ +VERSION --build-auto-skip 0.8 + +PROJECT earthly-technologies/core + +FROM alpine + +IMPORT ../../common AS common + +ARG --global OS_IMAGE=ubuntu + +ARG --global OS_VERSION=20.04 +# renovate: datasource=github-releases depName=docker/docker +LET docker_package_version=24.0.5 +ARG --global DOCKER_VERSION=5:$docker_package_version-1~ubuntu.$OS_VERSION~focal + +# DIR_PATH is set to that common targets can call os specific targets. It should match the directory name this Earthfile is located in +ARG --global DIR_PATH=$OS_IMAGE-$OS_VERSION + +# release builds the image using a new datetime as a suffix and run tests against the pushed image, then finally retag and push the image without the datetime suffix +release: + RUN --no-cache date --utc +%Y%m%d%H%M%S > datetime + LET datetime="$(cat datetime)" + WAIT + BUILD --pass-args common+build-and-test --SUFFIX=$datetime + END + COPY --dir --pass-args common+get-image-info/image-info . + LET image_tag="$(cat image-info/tag)-$datetime" + BUILD --pass-args common+push-new-tag-multi-platform --TAG_WITH_DATE=$image_tag + +# test-build will build a test image that is pushed to a temporary registry and run tests against it +test-build: + BUILD --pass-args common+build-and-test --IMAGE_NAME="dindtest" + +# build builds an dind:alpine image +build: + BUILD --pass-args --platform=linux/amd64 --platform=linux/arm64 common+build + +# test runs test for a dind:alpine image +# this is primarly used to run against a newly, temporariy image build by +test-build +test: + BUILD --pass-args common+ubuntu-kind-test + BUILD --pass-args common+test diff --git a/os/ubuntu-23.04/Earthfile b/os/ubuntu-23.04/Earthfile new file mode 100644 index 0000000..fa02dcc --- /dev/null +++ b/os/ubuntu-23.04/Earthfile @@ -0,0 +1,42 @@ +VERSION --build-auto-skip 0.8 + +PROJECT earthly-technologies/core + +FROM alpine + +IMPORT ../../common AS common + +ARG --global OS_IMAGE=ubuntu + +ARG --global OS_VERSION=23.04 +# renovate: datasource=github-releases depName=docker/docker +LET docker_package_version=24.0.5 +ARG --global DOCKER_VERSION=5:$docker_package_version-1~ubuntu.$OS_VERSION~lunar + +# DIR_PATH is set to that common targets can call os specific targets. It should match the directory name this Earthfile is located in +ARG --global DIR_PATH=$OS_IMAGE-$OS_VERSION + +# release builds the image using a new datetime as a suffix and run tests against the pushed image, then finally retag and push the image without the datetime suffix +release: + RUN --no-cache date --utc +%Y%m%d%H%M%S > datetime + LET datetime="$(cat datetime)" + WAIT + BUILD --pass-args common+build-and-test --SUFFIX=$datetime + END + COPY --dir --pass-args common+get-image-info/image-info . + LET image_tag="$(cat image-info/tag)-$datetime" + BUILD --pass-args common+push-new-tag-multi-platform --TAG_WITH_DATE=$image_tag + +# test-build will build a test image that is pushed to a temporary registry and run tests against it +test-build: + BUILD --pass-args common+build-and-test --IMAGE_NAME="dindtest" + +# build builds an dind:alpine image +build: + BUILD --pass-args --platform=linux/amd64 --platform=linux/arm64 common+build + +# test runs test for a dind:alpine image +# this is primarly used to run against a newly, temporariy image build by +test-build +test: + BUILD --pass-args common+ubuntu-kind-test + BUILD --pass-args common+test From f538d13e50c5d3ebc2732fe906e6f86702a6233a Mon Sep 17 00:00:00 2001 From: Ido David Date: Mon, 25 Mar 2024 16:07:18 -0400 Subject: [PATCH 2/4] readme new lines; remove redundant ssh config in gh workflow --- .github/workflows/ci.yml | 6 +----- README.md | 3 +-- 2 files changed, 2 insertions(+), 7 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 09f3f49..b457d1f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -36,8 +36,4 @@ jobs: mirrors = [\"registry-1.docker.io.mirror.corp.earthly.dev\"]'" if: github.event.pull_request.head.repo.full_name == github.repository - name: Run tests - run: |- - earthly config git "{github.com: {auth: ssh, user: git}}" && \ - eval $(ssh-agent) && \ - earthly secrets --org earthly-technologies --project core get littleredcorvette-id_rsa | ssh-add - && \ - earthly --ci -P --push --org earthly-technologies --satellite dind +test + run: earthly --ci -P --push --org earthly-technologies --satellite dind +test diff --git a/README.md b/README.md index c6da432..91b0995 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,6 @@ However, the installations of docker and other dependencies are done via an inst Dependencies are maintained by Renovate and will be merged automatically (provided required checks pass), primarly dependencies that will trigger new versions of the dind images such as the docker or the os (alpine) versions. - - ## Repo structure ```bash @@ -63,6 +61,7 @@ earthly --push -P +test ``` #### Community members + Community members do not have permissions to push a built image and run the tests against it. However, they can easily set a different dockerhub repository by changing the `DOCKERHUB_USER` ARG value in [.arg](.arg) to a private repository or by passing the arg in the earthly command, e.g. `earthly --push -P +test --DOCKERHUB_USER=`. ## Deployment From e711d6ab5159141d86a5ac97ec41155550a2e197 Mon Sep 17 00:00:00 2001 From: Ido David Date: Mon, 25 Mar 2024 16:13:41 -0400 Subject: [PATCH 3/4] remove redundant ssh config in another gh workflow --- .github/workflows/release.yml | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 16e06c6..fd8e3a0 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -30,8 +30,4 @@ jobs: mirrors = [\"registry-1.docker.io.mirror.corp.earthly.dev\"]'" if: github.event.pull_request.head.repo.full_name == github.repository - name: Build & Push image - run: |- - earthly config git "{github.com: {auth: ssh, user: git}}" && \ - eval $(ssh-agent) && \ - earthly secrets --org earthly-technologies --project core get littleredcorvette-id_rsa | ssh-add - && \ - earthly --ci -P --push --org earthly-technologies --satellite dind +release --RENOVATE_BRANCH=${{github.head_ref}} + run: earthly --ci -P --push --org earthly-technologies --satellite dind +release --RENOVATE_BRANCH=${{github.head_ref}} From 7d5251538186e00ba72120e79cdb16405add7666 Mon Sep 17 00:00:00 2001 From: Ido David Date: Mon, 25 Mar 2024 16:18:59 -0400 Subject: [PATCH 4/4] remove cache-from flag --- common/Earthfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/common/Earthfile b/common/Earthfile index 24a433e..fded545 100644 --- a/common/Earthfile +++ b/common/Earthfile @@ -38,7 +38,7 @@ build: LET image_name=$(cat image-info/name) LET image_tag=$(cat image-info/tag) RUN rm -rf image-info - SAVE IMAGE --push --cache-from=$image_name:$OS_IMAGE-main $image_name:$image_tag + SAVE IMAGE --push $image_name:$image_tag # get-image-info generates the image name and tag as a saved artifact so it can be used by multiple targets get-image-info: