Registry access

This documentation is public. During this phase, the images in ghcr.io/koiosplatform and the koios-installer repository are private. The Koios project must grant access to each: repository read permission is separate from registry read permission. A token with read:packages does not by itself grant repository access or permission to read the project’s packages.

To request access, write to the Koios project at asield03@gmail.com.

Once registry access has been granted, use a GitHub token with read:packages and access to the required packages, stored in a registry auth file:

skopeo login ghcr.io --authfile ghcr-auth.json      # or: podman login / docker login

Keep that file private: it is a credential. Only its ghcr.io entry is used by the installer.

OpenShift

Add ghcr.io to the cluster global pull secret, so every node can pull the catalog, the operators and every image (as for registry.redhat.io). A cluster administrator runs:

(
  set -euo pipefail; umask 077; T=$(mktemp -d); trap 'shred -u "$T"/*.json 2>/dev/null; rmdir "$T"' EXIT
  jq -e '{auths: {"ghcr.io": (.auths["ghcr.io"] // error("no ghcr.io entry"))}}' ghcr-auth.json > "$T/ghcr.json"
  oc get secret pull-secret -n openshift-config -o jsonpath='{.data.\.dockerconfigjson}' | base64 -d > "$T/current.json"
  jq -s '.[0] * .[1]' "$T/current.json" "$T/ghcr.json" > "$T/new.json"
  oc set data secret/pull-secret -n openshift-config --from-file=.dockerconfigjson="$T/new.json"
)

Then create the platform pull secret as for Kubernetes (below); OLM does not need more.

Kubernetes

common/pull-secrets.sh (in the installer) creates the pull Secrets from the auth file without printing them:

Install

Command

Without OLM

common/pull-secrets.sh ghcr-auth.json koios koios

With OLM, cluster-scoped

common/pull-secrets.sh ghcr-auth.json operators koios olm

With OLM, namespaced

common/pull-secrets.sh ghcr-auth.json koios koios olm

OpenShift, cluster-scoped (after the global pull secret)

common/pull-secrets.sh ghcr-auth.json openshift-operators koios

OpenShift, namespaced (after the global pull secret)

common/pull-secrets.sh ghcr-auth.json koios koios

It creates:

  • redhat-operators-pull-secret in the operators namespace: the operator Deployments reference that name;

  • koios-ghcr-pull in the platform namespace, for spec.image_pull_secrets of the platform and, through the default ServiceAccount, for automation job and rulebook activation pods;

  • koios-ghcr-pull in the OLM catalog namespace (olm), used by the catalog and its bundles.

It needs kubectl and python3.