Skip to content

Latest commit

 

History

History
115 lines (86 loc) · 3.85 KB

README.md

File metadata and controls

115 lines (86 loc) · 3.85 KB
Raw

nats-docker

License

This is the repository for building the official NATS server Docker images. If you just want to use NATS server, then head over to Docker Hub. You don't need this repository.

The rest of this readme is for image maintainers.

Directory structure

The directories are structured in a way such that each NATS server release has a directory. Each release version has a number of base image variants, such as scratch on Linux or nanoserver on Windows.

nats-docker/
├── 2.9.x
│   ├── image variant 1
└───└── image variant 2
├── 2.10.x
│   ├── image variant 1
└───└── image variant 2

For the most part, image variant Dockerfiles will download the official NATS server release binaries when building the server image and COPY a default configuration file.

The Linux scratch image is a little special. It copies a server binary from the Alpine image because the scratch image doesn't come with any tools to download and untar binaries.

Updating NATS server version

First, make sure you've published a new NATS server git tag and make sure the release binaries and SHASUMS are ready to download.

Next, run the command below. This will update the version and hash of the NATS server. If this is a patch release, it will update the existing directory. However, if it is a minor or major version, it will create the new directory (if required) from the latest minor version.

usage: ./update.py <server version>
       ./update.py 2.10.0

You can check what changed with git diff.

Manual updates

This script doesn't update everything. Here are some other things you may or may not want to update.

  • The Ubuntu host version used for CI.
  • The Windows host versions used for CI.
  • The Alpine version

After you've updated everything that needs updating. Submit a PR to this repo. Make sure CI passes.

Publishing on Docker Hub

To publish your new changes to Docker Hub. Head over to docker-library/official-images. You'll need to update the nats IMF file.

IMF stands for Internet Message Format. It's the format that Docker chose to declare images, instead of something like YAML.

You'll need to update the git commit in this file.

GitCommit: 710f0ed18645d78e97fa7fd8cdf9b80dbe936eb6

Also handy to know, if you're testing and haven't merged your PR in nats-io/nats-docker. You can tell Docker to pull a commit from a different branch like this.

GitFetch: refs/heads/mybranch
GitCommit: 710f0ed18645d78e97fa7fd8cdf9b80dbe936eb6

Docker images will be built in the order they're specified in the IMF file. This detail is very important because Windows images and the scratch image depend on this behavior. Nanoserver images must be built after servercore images. Scratch must be built after Alpine.

Tags: 2.1.0-windowsservercore-1809, windowsservercore-1809
Architectures: windows-amd64
Directory: 2.1.0/windowsservercore-1809
Constraints: windowsservercore-1809

Tags: 2.1.0-nanoserver-1809, nanoserver-1809
Architectures: windows-amd64
Directory: 2.1.0/nanoserver-1809
Constraints: nanoserver-1809, windowsservercore-1809

The names of the images also have to be consistent with the rest of the official images. Make sure the names match existing image names. For example, it should be 2.1.0-windowsservercore-1809, not 2.1.0-windowsservercore1809, not 2.1.0-servercore-1809.