Skip to Content

Registries

npm, Docker, file and Nexus registries, the logins a host gets for them, and publishing the release archive.

A registry is a server with one address and one login. Hosts get npm and Docker logins from registries, and Rookery publishes the release archive and the container image to them.

KindWhat it isUsed for
nexusA Sonatype Nexus server, with repositories under itWhatever its repositories are for
npmAny npm-compatible registry at an addressThe agent's npm registry and its login
rawAn address files are uploaded to with HTTP PUTPublishing the release archive
dockerAny container registry, as HOST or HOST:PORTPushing the container image, the agent's Docker login

A registry with a user name logs in with user name and password. Without a user name, what is stored is used as a token: _authToken for npm, a bearer token for uploads.

Registries, with their addresses and user names, are kept in Rookery's store. Passwords and tokens are kept there as secrets, sealed when the store is encrypted. rookery server store status says where the store is.

Adding registries

rookery registry add nexus nexus https://nexus.example.com --user ci-user
rookery registry login nexus                      # asks for the password or token
rookery registry add-repo nexus npm npm-group
rookery registry add-repo nexus raw rookery-releases
rookery registry add-repo nexus docker docker-hosted --address nexus.example.com:8083

rookery registry add verdaccio npm https://npm.example.com     # token login
rookery registry add files raw https://files.example.com/rookery --user ci-user
rookery registry add ghcr docker ghcr.io --user my-user

rookery registry list                                  # the list
rookery registry check                            # do they answer and accept the login?

The Registries tab of the home screen (4) does the same. Enter changes the selected row, or switches the kind or format; x removes a repository, a user name or a stored password. x twice on a registry's name removes the registry.

c on the tab, or rookery registry check, checks that the server answers, that each repository exists and is readable with the stored login, and that a Docker address speaks the Docker API. It only reads, so it does not show whether the account may upload.

Nexus repositories

FormatAddressUsed for
npmURL/repository/NAME/The agent's npm registry and its login
rawURL/repository/NAME/Publishing the release archive
dockerHOST/NAME, or the address you givePushing the container image, the agent's Docker login

A Docker repository with path-based routing in Nexus does not need an address: images are at HOST/REPOSITORY/IMAGE. With a connector on a port or host name of its own, give that address. Maven repositories are not handled.

Giving a host a registry

rookery host set studio registry.nexus=on
rookery run studio secrets

Or switch it on under Registries on the host's Settings tab and run Secrets and registry logins. The agent's ~/.npmrc gets the first npm repository as its registry with the login, in a block Rookery manages. The rest of the file is kept. ~/.docker/config.json gets the login of every Docker address.

Publishing the release archive

A machine set up from a cloud seed downloads the release archive. With Cloud-init seed chosen on a host's Install tab, Publish release to under Release on the Settings tab switches between your file servers and raw repositories. Download with login decides whether the machine logs in for the download. Making the seed then uploads the archive and points the seed at it. From the command line:

rookery registry publish nexus/rookery-releases --host cloud-1
rookery registry publish files --host cloud-1

Either way the seed pins the archive's SHA-256, and the archive contains no profiles, keys or secrets. The new machine downloads it with or without a login.

The default. The repository has to allow anonymous reads.

Pushing the container image

rookery registry push-image nexus/docker-hosted          # NEXUS-DOCKER-ADDRESS/rookery-desktop:latest
rookery registry push-image ghcr v1                      # ghcr.io/rookery-desktop:v1

pushes the image built by the Container image install method.

Edit on GitHub

Last updated on

On this page