-
Notifications
You must be signed in to change notification settings - Fork 260
docs: Update README with Docker image generation documentation #3723
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Copilot
wants to merge
9
commits into
master
Choose a base branch
from
copilot/fix-3722
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
2e020c4
Initial plan for issue
Copilot 139b87e
Add Docker image generation documentation to README
Copilot cecb16b
Make Docker image generation documentation generic as requested
Copilot 9aadc9e
Move Docker image generation documentation to doc/README.md
Copilot f99a9be
Move Docker image generation documentation to docs/README.md as reque…
Copilot 7a96168
docs: Add Windows (GOOS) impact documentation for image generation
Copilot 987ee10
docs: Change Windows image example from ARM64 to AMD64
Copilot cd8dfda
Changes before error encountered
Copilot f0767b3
docs: Remove GOOS documentation as requested in review
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,5 +10,65 @@ | |
| * [NPM](npm.md) - describes how to setup Azure-NPM (Azure Network Policy Manager). | ||
| * [Scripts](scripts.md) - describes how to use the scripts in this repository. | ||
|
|
||
| ## Docker Image Generation | ||
|
|
||
| This repository supports building Docker container images for networking components using standardized make recipes. The build system uses Docker or Podman to create multi-platform images. | ||
|
|
||
| ### Prerequisites | ||
| - Docker or Podman installed and running | ||
| - For multi-platform builds: `make qemu-user-static` (Linux only) | ||
|
|
||
| ### Available Components | ||
| - **acncli** - CNI manager | ||
| - **azure-ipam** - Azure IP Address Management | ||
| - **cni** - Container Network Interface | ||
| - **cns** - Container Network Service | ||
| - **npm** - Network Policy Manager | ||
| - **ipv6-hp-bpf** - IPv6 Host Policy BPF | ||
|
|
||
| ### Generic Build Pattern | ||
| All components follow the same make recipe pattern: | ||
|
|
||
| ```bash | ||
| # Build container image | ||
| $ make <component>-image | ||
|
|
||
| # View image name and tag | ||
| $ make <component>-image-name-and-tag | ||
|
|
||
| # Push image to registry | ||
| $ make <component>-image-push | ||
|
|
||
| # Pull image from registry | ||
| $ make <component>-image-pull | ||
|
|
||
| # Build multi-platform manifest | ||
| $ make <component>-manifest-build | ||
| $ make <component>-manifest-push | ||
| ``` | ||
|
|
||
| ### Example Usage | ||
| ```bash | ||
| # Build CNS image | ||
| $ make cns-image | ||
|
|
||
| # Build NPM image with custom platform | ||
| $ PLATFORM=linux/arm64 make npm-image | ||
|
|
||
| # Build Azure-IPAM image with custom registry | ||
| $ IMAGE_REGISTRY=myregistry.azurecr.io make azure-ipam-image | ||
|
|
||
| # Use Podman instead of Docker | ||
| $ CONTAINER_BUILDER=podman make cni-image | ||
| ``` | ||
|
|
||
| ### Customization | ||
| Environment variables for customizing builds: | ||
| - `PLATFORM` - Target platform/architecture (default: linux/amd64) | ||
| - `IMAGE_REGISTRY` - Custom registry (default: acnpublic.azurecr.io) | ||
| - `CONTAINER_BUILDER` - Container builder (default: docker, alternative: podman) | ||
|
|
||
| Images are tagged with platform and version information and published to the configured registry. | ||
|
|
||
| ## Code of Conduct | ||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.