Skip to content
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

add nodejs dev variant #479

Merged
merged 1 commit into from
Apr 19, 2023

Conversation

tuananh
Copy link
Contributor

@tuananh tuananh commented Apr 19, 2023

Fixes: #430

Related:

Pre-review Checklist

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

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.

  • Image is marked experimental or stable as appropriate
  • 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
    • Alternatively the username and GID/UID may be a commonly used one from the ecosystem e.g: postgres
    • See above for exceptions to nonroot rule
  • 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]
  • Consider where and how the image deviates from popular alternatives. Is there a good reason and is it documented?
  • 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)
  • Documentation. Let's make this excellent. Include usage example.
  • Error logs write to stderr and normal logs to stdout. DO NOT write to file.
  • Include tests, at the very least a basic smoke test.

Signed-off-by: Tuan Anh Tran <me@tuananh.org>
@tuananh tuananh requested a review from a team as a code owner April 19, 2023 14:09
@tuananh tuananh requested a review from joshrwolf April 19, 2023 14:09
Copy link
Contributor

@jdolitsky jdolitsky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice :)

@jdolitsky jdolitsky merged commit a9995a9 into chainguard-images:main Apr 19, 2023
developer-guy pushed a commit to Dentrax/images that referenced this pull request Feb 12, 2024
)

Signed-off-by: Ariadne Conill <ariadne@dereferenced.org>
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.

Create dev variant of nodejs image
2 participants