Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tianocore/containers
Repository to maintain and manage edk2 containers
https://github.com/tianocore/containers
Last synced: about 2 months ago
JSON representation
Repository to maintain and manage edk2 containers
- Host: GitHub
- URL: https://github.com/tianocore/containers
- Owner: tianocore
- License: other
- Created: 2022-05-10T21:01:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-06T11:17:28.000Z (4 months ago)
- Last Synced: 2024-06-06T12:42:11.064Z (4 months ago)
- Language: Dockerfile
- Size: 73.2 KB
- Stars: 20
- Watchers: 11
- Forks: 24
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Tianocore Containers
This is a Tianocore maintained project for container images used to build and
test Edk2 based UEFI firmware code projects. This repository contains the
dockerfiles and the github workflow files to generate these container images.
Container images are automatically build and uploaded to the associated github
container registry. Links to the container registry for the various images can
be found in [current status](#Current-Status).
## Current Status
| Image Name | OS SKU | Type | Build Status | Documentation |
| :--------- | :----- | :--- | :----------- | :---- |
| [fedora-39-build](https://github.com/tianocore/containers/pkgs/container/containers%2Ffedora-39-build) | Fedora 39 | Build | [](https://github.com/tianocore/containers/actions/workflows/Fedora-39.yaml) | [Doc](Fedora-39/Readme.md) |
| [fedora-39-test](https://github.com/tianocore/containers/pkgs/container/containers%2Ffedora-39-test) | Fedora 39 | Test | [](https://github.com/tianocore/containers/actions/workflows/Fedora-39.yaml) | [Doc](Fedora-39/Readme.md) |
| [fedora-39-dev](https://github.com/tianocore/containers/pkgs/container/containers%2Ffedora-39-dev) | Fedora 39 | Dev | [](https://github.com/tianocore/containers/actions/workflows/Fedora-39.yaml) | [Doc](Fedora-39/Readme.md) |
| [fedora-37-build](https://github.com/tianocore/containers/pkgs/container/containers%2Ffedora-37-build) | Fedora 37 | Build | [](https://github.com/tianocore/containers/actions/workflows/Fedora-37.yaml) | [Doc](Fedora-37/Readme.md) |
| [fedora-37-test](https://github.com/tianocore/containers/pkgs/container/containers%2Ffedora-37-test) | Fedora 37 | Test | [](https://github.com/tianocore/containers/actions/workflows/Fedora-37.yaml) | [Doc](Fedora-37/Readme.md) |
| [fedora-37-dev](https://github.com/tianocore/containers/pkgs/container/containers%2Ffedora-37-dev) | Fedora 37 | Dev | [](https://github.com/tianocore/containers/actions/workflows/Fedora-37.yaml) | [Doc](Fedora-37/Readme.md) |
| [windows-2022-build](https://github.com/tianocore/containers/pkgs/container/containers%2Fwindows-2022-build) | Windows ServerCore 2022 | Build | [](https://github.com/tianocore/containers/actions/workflows/Windows-2022.yaml) | [Doc](Windows-2022/Readme.md) |
| [ubuntu-20-build](https://github.com/tianocore/containers/pkgs/container/containers%2Fubuntu-20-build) | Ubuntu 20.04 | Build | [](https://github.com/tianocore/containers/actions/workflows/Ubuntu-20.yaml) | [Doc](Ubuntu-20/Readme.md) |
| [ubuntu-20-test](https://github.com/tianocore/containers/pkgs/container/containers%2Fubuntu-20-test) | Ubuntu 20.04 | Test | [](https://github.com/tianocore/containers/actions/workflows/Ubuntu-20.yaml) | [Doc](Ubuntu-20/Readme.md) |
| [ubuntu-20-dev](https://github.com/tianocore/containers/pkgs/container/containers%2Fubuntu-20-dev) | Ubuntu 20.04 | Dev | [](https://github.com/tianocore/containers/actions/workflows/Ubuntu-20.yaml) | [Doc](Ubuntu-20/Readme.md) |
| [ubuntu-22-build](https://github.com/tianocore/containers/pkgs/container/containers%2Fubuntu-22-build) | Ubuntu 22.04 | Build | [](https://github.com/tianocore/containers/actions/workflows/Ubuntu-22.yaml) | [Doc](Ubuntu-22/Readme.md) |
| [ubuntu-22-test](https://github.com/tianocore/containers/pkgs/container/containers%2Fubuntu-22-test) | Ubuntu 22.04 | Test | [](https://github.com/tianocore/containers/actions/workflows/Ubuntu-22.yaml) | [Doc](Ubuntu-22/Readme.md) |
| [ubuntu-22-dev](https://github.com/tianocore/containers/pkgs/container/containers%2Fubuntu-22-dev) | Ubuntu 22.04 | Dev | [](https://github.com/tianocore/containers/actions/workflows/Ubuntu-22.yaml) | [Doc](Ubuntu-22/Readme.md) |
## Container Types
Containers will be broken up into the following types based on their intended
use. Additional types may be added in the future to accommodate new use cases.
### Build
Build images will only have a minimal set of tools intended to be used for
building the firmware projects. They will not contain virtualization or other
tools used for testing or development.
### Test
Usually built on top of a corresponding build image, test images will additionally
contain tools and packages used for testing the firmware. For example, test images
will contain QEMU for testing a virtualized platform.
### Dev
Intended for local use to develop for EDKII based UEFI products.
## Using containers locally
Containers can provide a convenient and consistent development environment when building
EDK2 based firmware projects. This section details some tools and tips that make
using containers for local development easier. The DEV editions of the containers
are intended for this purpose. This section is not comprehensive however and it
is encouraged users experiment and consider contributing back any new useful
configurations or tools to this documentation.
__NOTE__: If your code base is cloned in Windows, it is not advised that you directly
open this repository in a Linux dev container as the file system share between Windows
and WSL 2 causes a very significant performance reduction. Instead, clone the
repo in the WSL file system and map into the container or directly clone into the
container.
### Visual Studio Code
The Visual Studio Code [Dev Container extension](https://code.visualstudio.com/docs/devcontainers/containers)
provides an easy and consistent way to use containers for local development. At
the time of writing, this extension only supports Linux based containers. This
extension provides a number of useful additions to the specified docker image on
creation.
- Configures git credential manager to pipe in git credentials.
- Makes extensions available on code inside the container.
- Abstracts management of the container for seamless use in the editor.
For a shared docker image configuration, this can be configured by creating a
.devcontainer file in the repository. Some useful configurations are details below.
| Configuration | Purpose |
| :------------ | :------ |
| "privileged": true | This may be needed for access to KVM for QEMU acceleration. |
| "forwardPorts": [####] | Can be used to forward debug or serial ports to the host OS. |
It may also be desireable to run initialization commands using the "postCreateCommand"
option. Specifically running `git config --global --add safe.directory ${containerWorkspaceFolder}`
may be required if mapping the repository into the container is expected.
And example of a devcontainer used for a QEMU platform repo is included below.
```json
{
"image": "ghcr.io/tianocore/containers/fedora-39-dev:latest",
"postCreateCommand": "git config --global --add safe.directory ${containerWorkspaceFolder} && pip install --upgrade -r pip-requirements.txt",
"forwardPorts": [5000],
"privileged": true
}
```
## Notes
### Ubuntu
The Ubuntu 'dev' images are suitable for development and uses a non-standard entry-point
script which changes the user inside the container to match the outside user
and expects the users home directory to be shared.
They can be run like this (changing ubuntu-XX to the appropriate version, such as ubuntu-22):
```
docker run -it \
-v "${HOME}":"${HOME}" -e EDK2_DOCKER_USER_HOME="${HOME}" \
ghcr.io/tianocore/containers/ubuntu-XX-dev:latest /bin/bash
```
To enter the container as 'root', prepend the command to run with `su`, for example
```
docker run -it \
-v "${HOME}":"${HOME}" -e EDK2_DOCKER_USER_HOME="${HOME}" \
ghcr.io/tianocore/containers/ubuntu-XX-dev:latest su /bin/bash
```
The images provide the ["edkrepo" tool](https://github.com/tianocore/edk2-edkrepo).
## License
All content in this repository is licensed under [BSD-2-Clause Plus Patent
License](LICENSE).
## Code of Conduct
No harassment or discrimination of any kind will be tolerated. Please ensure that
all work and communication in this project is done respectfully and fairly. For
more details, please read the [Code of Conduct](CODE_OF_CONDUCT.md).
## Contributing
This project welcomes all types of contributions. Please see the [contributing document](CONTRIBUTING.md)
to get started.