Install on OpenShift

Before running these steps, obtain project-granted read access to the private koios-installer repository and the images in ghcr.io/koiosplatform. These are separate permissions; see Access prerequisites. Run installer commands from an authorized checkout of the release tag described in Install.

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

Koios is installed with OLM from the Koios Operators catalog, package koios-platform-operator.

  1. Registry access: add ghcr.io to the global pull secret and create the platform pull secret (Registry access).

  2. Catalog and operators. From the installer, choose one scope:

    oc apply -k olm/openshift/cluster-scoped    # operators in openshift-operators, all namespaces
    # or
    oc apply -k olm/openshift/namespaced        # operators in the koios namespace only
    

    Each directory includes the CatalogSource (pinned by digest) and the Subscription to the channel of the release. The operators are ready when the ClusterServiceVersion koios-operator.v<version> (with -cluster-scoped for that scope) is Succeeded:

    oc get csv -n openshift-operators     # namespaced: oc get csv -n koios
    
  3. Platform. From the console (Installed Operators → Koios Automation Platform → Create KoiosPlatform), or as YAML:

    oc apply -k kustomize/platform/base
    

    On OpenShift a Route is created by default. The form shows the common fields; advanced ones, such as per-component external databases, are set in YAML (Configure).

  4. Wait until the platform reports Successful (First login).

Upgrades follow the channel: point the CatalogSource at the catalog of a newer release (apply olm/openshift/<scope> from its tag) and OLM upgrades the operators.