> For the complete documentation index, see [llms.txt](https://docs.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.collibra.com/platform-self-hosted/about-installation-and-upgrade-for-collibra-platform-self-hosted-expanded-capabilities/observability-installation-and-upgrade-for-cpsh-extended-capabilities.md).

# Observability installation and upgrade for CPSH extended capabilities

This section describes the Observability installation for CPSH extended capabilities.

{% hint style="info" %}
The Observability package is optional. Installation is not required.
{% endhint %}

## Prerequisites

You must first install the `cpsh-platform` Zarf package.

Additionally, the following information should be defined before proceeding:

The two cloud storage buckets where the logging stack files can be stored, identified by their name (`LOKI_CHUNKS_BUCKET_NAME` and `LOKI_RULER_BUCKET_NAME`), region (`LOKI_BUCKET_REGION`) and the Amazon Resource Name for the service account bound to the preconfigured IAM role which grants S3 access (`LOKI_SERVICE_ACCOUNT_ARN`).

## Steps

{% stepper %}
{% step %}
Download the `zarf-package-cpsh-observability-amd64-X.Y.Z.tar.zst` Zarf package (where `X.Y.Z` corresponds to the Collibra Observability release version) into a temporary folder (e.g. `/tmp/`).
{% endstep %}

{% step %}
Run the following command to deploy the package:

```bash
zarf package deploy /tmp/zarf-package-cpsh-observability-amd64-X.Y.Z.tar.zst
```

{% endstep %}

{% step %}
Provide the answers to the Zarf deployment process.
{% endstep %}

{% step %}
Verify that the deployment process completed successfully by confirming the Zarf command execution log lines are similar to the following:

```log
2025-09-02 17:12:59 INF processing Helm chart name=raw-cpsh-observability-grafana-virtualservice-grafana virtualservice version=0.1.1756825769 source=Zarf-generated
2025-09-02 17:13:00 INF performing Helm install chart=raw-cpsh-observability-grafana-virtualservice-grafana virtualservice
2025-09-02 17:13:03 INF running health checks chart=raw-cpsh-observability-grafana-virtualservice-grafana virtualservice
```

{% endstep %}
{% endstepper %}

## Operations

Retrieve Grafana web console user credentials by running the following command:

```bash
zarf tools kubectl get secrets -n collibra-observability grafana -o yaml |zarf tools yq '.data | map_values(@base64d)'
```

### Logs

The logs of the workloads running the Kubernetes cluster are available in Grafana.

To `fetch` the Grafana URL using `kubectl get svc`:

1. Run the following:

```bash
zarf tools kubectl get virtualservice/grafana -o jsonpath='{.spec.hosts}' -n collibra-observability
```

2\. To access Grafana, connect to one of the following:to.

* `http://<hostname>/grafana`: Use if you are not using a TLS.
* `https://<hostname>/grafana`: Use if you are using a TLS.

See [Grafana](https://grafana.com/docs/learning-journeys/drilldown-logs/) for more information.