nats-boot-config

packaged by Chainguard

Chainguard Container for nats-boot-config

NATS Controllers for Kubernetes (NACK) pod boot config helper that writes NATS advertise config from Kubernetes node tags

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/nats-boot-config:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

This image provides the nats-boot-config helper from the NATS Controllers for Kubernetes (NACK) project, built with Go and licensed under Apache-2.0. It is designed as a drop-in replacement for the upstream natsio/nats-boot-config image and keeps the same layout:

• The entrypoint is /entrypoint.sh, which executes /${GO_APP} (GO_APP=nats-boot-config) with the supplied arguments.
• The binary is also available at /usr/local/bin/nats-boot-config, /nats-boot-config, and /usr/local/bin/nats-pod-bootconfig.
• Unlike upstream, the image runs as the nonroot user (UID 65532) by default. Any directory the helper writes advertise config files into, such as a shared emptyDir volume, must be writable by that user.

Getting Started

nats-boot-config runs as an init container in a NATS server pod. It reads a tag from the Kubernetes node the pod is scheduled on (by default nats.io/node-external-ip) and writes client and gateway advertise configuration files that NATS server includes at startup.

Print the version and usage:

docker run --rm cgr.dev/ORGANIZATION/nats-boot-config:latest -v
docker run --rm cgr.dev/ORGANIZATION/nats-boot-config:latest -h

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

In Kubernetes, the pod's service account must be allowed to get nodes, and the node name is passed in through the KUBERNETES_NODE_NAME environment variable:

initContainers:
  - name: bootconfig
    image: cgr.dev/ORGANIZATION/nats-boot-config:latest
    args:
      - -f
      - /etc/nats-config/advertise/client_advertise.conf
      - -gf
      - /etc/nats-config/advertise/gateway_advertise.conf
    env:
      - name: KUBERNETES_NODE_NAME
        valueFrom:
          fieldRef:
            fieldPath: spec.nodeName
    volumeMounts:
      - name: advertiseconfig
        mountPath: /etc/nats-config/advertise

Configuration

The helper accepts the following flags:

• -f: path of the client advertise config file to write.
• -gf: path of the gateway advertise config file to write.
• -t: node tag to read the external address from (default nats.io/node-external-ip).

Documentation and Resources

• NACK GitHub Repository
• NATS Documentation
• NATS Helm Charts

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.