Skip to content

add k3s images#877

Closed
joshrwolf wants to merge 1 commit intochainguard-images:mainfrom
joshrwolf:k3s
Closed

add k3s images#877
joshrwolf wants to merge 1 commit intochainguard-images:mainfrom
joshrwolf:k3s

Conversation

@joshrwolf
Copy link
Copy Markdown
Contributor

@joshrwolf joshrwolf commented Jun 20, 2023

DEPENDS ON: wolfi-dev/os#2970

Fixes:

Related:

Pre-review Checklist

  • IMPORTANT: 'image-request' tag has been applied if this PR is adding any images, including new versions or variants

Quality Requirements for Images PRs

The items in this checklist should all be checked in the PR with exceptions clearly documented.
The general idea is that to the extent possible, the image should be a drop-in replacement to its public counterpart.

  • Image is a smaller size than its common public counterpart, or if not, the reason why should be explained
  • Image should be scanned for CVEs and should return 0 or near-0 results. Exceptions should be explained.
  • The software in the image should be able to be installed and work as expected
    • The image should start in a cluster
    • The application should be accessible to the user/cluster/etc. as expected
  • If there is an open source helm chart provided, the image should be able to be used with the chart. If needed, please add a -compat package to close any gaps with the public helm chart.
  • build for x86_64 and aarch64 if possible, document exceptions

For new image PRs only

If you have an apko.yaml file in this PR you need to follow this checklist, otherwise feel free to remove.

  • Include tests, sufficient enough that you would trust this image running in production.

  • Perform manual tests as needed and document your testing results

    • For builder images (go, python, etc), build a sample app successfully
    • For services images (rabbit, databases, webservers) test basic functionality, upstream install/getting started, port availability, admin access. Document differences from public image.
    • Applications intended for use with a specific cloud provider must be tested on that cloud provider.
  • The version included is the latest GA version of the software

  • The latest tag points to the newest stable version

  • There is a dev tag available that includes a shell and apk tools (by depending on 'wolfi-base')

  • The image runs as nonroot and GID/UID are set to 65532 or upstream default

    • Alternatively the username and GID/UID may be a commonly used one from the ecosystem e.g: postgres
  • The image contains the ca-certs bundle if needed

  • ENTRYPOINT

    • For applications/servers/utilities call main program with no arguments e.g. [redis-server]
    • For base images leave empty
    • For dev variants set to entrypoint script that falls back to system
  • CMD:

    • For server applications give arguments to start in daemon mode (may be empty)
    • For utilities/tooling bring up help e.g. –help
    • For base images with a shell, call it e.g. [/bin/sh]
  • Add annotations e.g:

annotations:
  "org.opencontainers.image.authors": "Chainguard Team https://www.chainguard.dev/"
  "org.opencontainers.image.url": https://edu.chainguard.dev/chainguard/chainguard-images/reference/busybox/ # use the academy site here
  "org.opencontainers.image.source": https://github.com/chainguard-images/images/tree/main/images/bazel # use github here
  • Check if environment variables are needed e.g. to set data locations
  • Ensure the image responds to SIGTERM
    • docker kill $(docker run -d --rm cgr.dev/chainguard/nginx)
  • Error logs write to stderr and normal logs to stdout. DO NOT write to file.

Documentation Requirements

  • Provide a README file, follow the README template to include variants, tags, and usage examples
  • Document your testing and results in the PR
  • Document any exceptions to the testing and config requirements outlined in this template
  • Document where and how the image deviates from popular alternatives (ports, packages, user, entrypoint, versions, etc). Explain why there's a difference and if the user needs to do anything differently when using the image

Signed-off-by: Josh Wolf <josh@wolfs.io>
@joshrwolf
Copy link
Copy Markdown
Contributor Author

closing this in favor of #1050

@joshrwolf joshrwolf closed this Jul 5, 2023
developer-guy pushed a commit to Dentrax/images that referenced this pull request Feb 12, 2024
Signed-off-by: Jason Hall <jason@chainguard.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant