Installation¶

ClusterPulse can be installed on OpenShift clusters via OperatorHub or on any Kubernetes cluster using Helm.

Prerequisites¶

OpenShift 4.x or Kubernetes 1.21+ cluster
Cluster administrator privileges
For Helm installation: Helm 3.x installed locally

OperatorHub Installation (OpenShift)¶

ClusterPulse is available in the OperatorHub community operator index.

GUI Installation¶

Log in to the OpenShift web console as a cluster administrator.
Navigate to Operators > OperatorHub in the left sidebar.
In the search field, enter ClusterPulse.
Select the ClusterPulse tile from the search results.
Review the operator information and click Install.
Configure the installation options:
- Update channel: Select the desired release channel.
- Installation mode: Choose whether to install in a specific namespace or all namespaces.
- Installed Namespace: Select or create the target namespace.
- Update approval: Select Automatic or Manual based on your upgrade policy.
Click Install to begin the installation.
Wait for the operator status to display Succeeded. This can be monitored under Operators > Installed Operators.
Once installed, create a ClusterPulse instance by navigating to the operator's detail page and selecting Create Instance under the provided API.

CLI Installation¶

Create a namespace for the operator (optional, if not using an existing namespace):
```
oc create namespace clusterpulse
```

Create an OperatorGroup if one does not already exist in the target namespace:

apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
  name: clusterpulse-operatorgroup
  namespace: clusterpulse
spec:
  targetNamespaces:
    - clusterpulse

Apply the manifest:

oc apply -f operatorgroup.yaml

Create a Subscription to install the operator:

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: clusterpulse
  namespace: clusterpulse
spec:
  channel: stable
  name: clusterpulse
  source: community-operators
  sourceNamespace: openshift-marketplace
  installPlanApproval: Automatic

Apply the manifest:

oc apply -f subscription.yaml

Verify the operator installation:
```
oc get csv -n clusterpulse
```
The output should show the ClusterPulse operator with a phase of Succeeded.

Create a ClusterPulse custom resource to deploy the application. The default options should suffice for most instances:

apiVersion: clusterpulse.io/v1alpha1
kind: ClusterPulse
metadata:
  name: clusterpulse
  namespace: clusterpulse
spec:
  # Add configuration options as needed

Apply the manifest:

oc apply -f clusterpulse-cr.yaml

Helm Installation¶

Helm installation is suitable for any Kubernetes cluster, including OpenShift.

Clone the operator repository:

git clone https://github.com/ClusterPulse/operator.git
cd operator/

Install the Custom Resource Definitions:
```
make install
```

Install ClusterPulse using Helm:

helm install clusterpulse ./helm-charts/clusterpulse

To install in a specific namespace:

helm install clusterpulse ./helm-charts/clusterpulse --namespace clusterpulse --create-namespace

Verify the installation:
```
oc get pods -n clusterpulse
```

Helm Configuration¶

To customize the installation, create a values.yaml file with your configuration overrides:

helm install clusterpulse ./helm-charts/clusterpulse -f values.yaml

Refer to the chart's default values.yaml in ./helm-charts/clusterpulse/values.yaml for available configuration options.

Upgrading¶

To upgrade an existing Helm installation:

cd operator/
git pull
helm upgrade clusterpulse ./helm-charts/clusterpulse

Uninstalling¶

To remove ClusterPulse installed via Helm:

helm uninstall clusterpulse
make uninstall  # Removes CRDs

Post-Installation¶

After installation, configure the following:

Target Clusters: Add the Kubernetes clusters you want to monitor.
RBAC Policies: Define access control policies for your users and teams.
Authentication: Configure OAuth2 integration with your identity provider.