Overview

This guide outlines the steps required to install ScaleOps on an OpenShift cluster using the OpenShift OperatorHub. ScaleOps is a powerful platform for optimizing and managing OpenShift resources with advanced features.

1. Preparing Your Cluster

Before installing ScaleOps, ensure the following prerequisites are met:

1. OpenShift 4.13 or above.
2. The oc command-line tool is installed.
3. You have authenticated access to your OpenShift cluster via oc login.

Once these requirements are met, proceed with the installation steps.

2. Configure Image Pull Secrets

To enable the operator to pull images, create an image pull secret in the scaleops-system namespace using your ScaleOps installation token.

oc create ns scaleops-system
oc create secret docker-registry scaleops-operator-pull-secret -n scaleops-system \
  --docker-server=ghcr.io/scaleops-sh --docker-username=scaleops \
  --docker-password=<YOUR_SCALEOPS_TOKEN>
oc patch secrets scaleops-operator-pull-secret -n scaleops-system \
  --patch '{"stringData":{"token":"<YOUR_SCALEOPS_TOKEN>"}}'

3. Installing the ScaleOps Operator

3.1. Access the OpenShift OperatorHub

In your OpenShift cluster dashboard, navigate to OperatorHub, search for “ScaleOps” click on it and click the Install button.

3.2. Select Installation Namespace

Choose the scaleops-system namespace as the Installed Namespace and click the Install button.

3.3. Complete the Installation

Once the installation completes, verify the success by locating the installed operator.

4. Deploying the ScaleOps Platform

In this step we will deploy the ScaleOps Platform to the cluster.

4.1. Prepare The ScaleOps Instance

Open the Installed ScaleOps Operator ether from the success page from step 3.3 or locate it in the Installed Operators Section in your cluster. Then click on the Create Instance button.

4.2. Customize ScaleOps Helm Values

Select YAML view, under spec section you can define ScaleOps helm values.

4.3. Deploy ScaleOps Instance

Click on Create to deploy ScaleOps on your cluster.

Wait until the installation is completed, and proceed to the next step.

5. Access ScaleOps Dashboard

oc port-forward service/scaleops-dashboards -n scaleops-system 8080

6. Configure OpenShift OAuth SSO (Operator-Specific Notes)

If you’re enabling OpenShift OAuth login on an Operator-managed install, the general setup is covered in the OpenShift SSO guide. All Helm chart values can be set directly in the Operator CR under spec. The items below are specific to Operator installs and are easy to miss.

6.1. Set loginRedirectURL on the CR

ScaleOps handles the OAuth token exchange at /auth/callback. If loginRedirectURL is left pointing at /, the OpenShift login completes but the session is never registered in ScaleOps, and users see “authentication not enabled”. Set it explicitly under spec in the ScaleOps CR:

spec:
  openshiftSSO:
    enabled: true
    clientID: scaleops
    loginRedirectURL: 'https://<YOUR-SCALEOPS-DASHBOARD-URL>/auth/callback'

Make sure the OAuthClient’s redirectURIs also include /auth/callback (see Create an OAuth Client in the OpenShift SSO guide).

6.2. Grant scaleops-dashboards group-lookup permission

The Operator does not grant this automatically. This permission is needed to resolve each user’s OpenShift group membership at login. Replace scaleops-system below with the namespace ScaleOps is installed in if you used a different one:

oc adm policy add-cluster-role-to-user system:auth-delegator \
  -z scaleops-dashboards -n scaleops-system