Skip to content

docs(ns8): install from :edge; :latest is still the unusable first build #140

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.

Sign up for GitHub

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

Merged
shockalotti merged 1 commit into from
Oct 14, 2026
Merged

docs(ns8): install from :edge; :latest is still the unusable first build #140

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions packaging/ns8/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,20 @@ Key facts:
On the cluster leader, as root:

```
add-module ghcr.io/calnode/ns8-calnode:latest 1
add-module ghcr.io/calnode/ns8-calnode:edge 1
```

Replace `calnode` with the actual registry namespace if you built your own
image (see Development). The command prints the instance name, usually
`ns8-calnode1`.

> **Use `:edge`, not `:latest`.** This module has not had a release tag yet, so
> `:latest` still points at the first build, which predates the fixes for a
> missing `create-module` action, non-executable action scripts and an
> invalid schema pattern. That build fails at `add-module`. `:latest` becomes
> usable at the next module release, at which point a pinned version tag
> (`ghcr.io/calnode/ns8-calnode:0.10.2`, say) is the better thing to install.

Then configure it with your public hostname:

```
Expand Down Expand Up @@ -116,8 +123,9 @@ tag pushes, mirroring the app tags in `docker-publish.yml`:
- push a `vX.Y.Z` tag pushes module `:X.Y.Z`, `:X.Y` and `:latest`, running
app `:X.Y.Z`, so a module release always runs the matching app release

Because `:latest` only moves on a release tag, use `:edge` to try the newest
module on a test cluster.
Because `:latest` only moves on a release tag, and no module release has been
cut yet, `:latest` is currently unusable (see Install). Use `:edge` until the
first module release lands.

Every published module tag is a **multi-arch** manifest (amd64 + arm64). NS8
runs modules as rootless containers on the node, so a single-arch image would
Expand All @@ -142,7 +150,7 @@ source of truth; nothing is stamped at build time.

Running the test suite needs an NS8 test cluster; see the
[NS8 testing docs](https://github.com/NethServer/ns8-github-actions/blob/v1/README.md#running-tests-locally).
From this directory: `run-ns8-tests <NODE_ADDR> ghcr.io/calnode/ns8-calnode:latest`.
From this directory: `run-ns8-tests <NODE_ADDR> ghcr.io/calnode/ns8-calnode:edge`.
Not yet run in CI: no test cluster is wired up.

## UI translation
Expand Down
Loading