openshift/pagerduty-operator

Latest recorded source activity: July 6, 2026 at 17:57

SkillsMP catalog refreshed: November 9, 2026 at 14:22

skills collected: 1

GitHub stars: 21
GitHub forks: 75

Install with an AI assistant

Copy this prompt into the AI assistant you're using.

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/openshift/pagerduty-operator.

Repository README

Repository README source: README.md

Read the source README

Expand full README

# PagerDuty Operator - [PagerDuty Operator](#pagerduty-operator) - [About](#about) - [How the PagerDuty Operator works](#how-the-pagerduty-operator-works) - [Development](#development) - [Set up local openshift cluster](#set-up-local-openshift-cluster) - [Deploy dependencies](#deploy-dependencies) - [Option 1: Run pagerduty-operator outside of OpenShift](#option-1-run-pagerduty-operator-outside-of-openshift) - [Option 2: Run local built operator in CRC](#option-2-run-local-built-operator-in-crc) - [Generate secret with quay.io creds](#generate-secret-with-quayio-creds) - [Deploy pagerduty-operator from custom repo](#deploy-pagerduty-operator-from-custom-repo) - [Create PagerDutyIntegration](#create-the-pagerdutyintegration-object) - [Create ClusterDeployment](#create-the-clusterdeployment-object) - [Delete ClusterDeployment](#delete-the-clusterdeployment-object) - [Testing](#testing) - [Unit tests](#unit-tests) - [PKO template tests](#pko-template-tests) - [Regenerating test fixtures](#regenerating-test-fixtures) ## About The PagerDuty operator is used to automate integrating OpenShift Dedicated clusters with PagerDuty that are provisioned via <https://cloud.redhat.com/>. This operator runs on [Hive](https://github.com/openshift/hive) and watches for new cluster deployments. Hive is an API driven OpenShift cluster providing OpenShift Dedicated provisioning and management. ## How the PagerDuty Operator works - The PagerDutyIntegration controller watches for changes to PagerDutyIntegration CRs, and also for changes to appropriately labeled ClusterDeployment CRs (and ConfigMap/Secret/SyncSet resources owned by such a ClusterDeployment). - For each PagerDutyIntegration CR, it will get a list of matching ClusterDeployments that have the `spec.installed` field set to true. - For each of these ClusterDeployments, PagerDuty creates a secret which contains the integration key required to communicate with PagerDuty Web application. - The PagerDuty operator then creates [syncset](https://github.com/openshift/hive/blob/master/config/crds/hive.openshift.io_syncsets.yaml) with the relevant information for hive to send the PagerDuty secret to the newly provisioned cluster. - This syncset is used by hive to deploy the pagerduty secret to the provisioned cluster so that the relevant SRE team get notified of alerts on the cluster. - The pagerduty secret is deployed to the coordinates specified in the `spec.targetSecretRef` field of the PagerDutyIntegration CR. ## Development ### Set up local OpenShift cluster For example install [crc](http://crc.dev/crc/getting_started/getting_started/introducing/) as described in its documentation. ### Deploy dependencies Create hive CRDs. To do so, clone [hive repo](https://github.com/openshift/hive/) and run ```bash oc apply -f config/crds ``` Deploy namespace, role, etc from pagerduty-operator ```bash oc apply -f manifests/01-namespace.yaml oc apply -f manifests/02-role.yaml oc apply -f manifests/03-service_account.yaml oc apply -f manifests/04-role_binding.yaml oc apply -f deploy/crds/pagerduty.openshift.io_pagerdutyintegrations.yaml ``` Create secret with pagerduty api key, for example using a [trial account](https://www.pagerduty.com/free-trial/). You can then create an API key at <https://{your-account}.pagerduty.com/api_keys>. Following is an example secret to adjust and apply with `oc apply -f ${FILENAME}`. ```yaml apiVersion: v1 data: PAGERDUTY_API_KEY: bXktYXBpLWtleQ== #echo -n ${PAGERDUTY_API_KEY} | base64 kind: Secret metadata: name: pagerduty-api-key namespace: pagerduty-operator type: Opaque ``` ### Option 1: Run pagerduty-operator outside of OpenShift ```bash export OPERATOR_NAME=pagerduty-operator go run main.go ``` In another terminal create namespace `pagerduty-operator` if needed: ```bash oc create namespace pagerduty-operator ``` Continue to [Create PagerDutyIntegration](#create-the-pagerdutyintegration-object). ### Option 2: Run local built operator in CRC Build local code modifications and push image to your own quay.io account. ```bash $ ALLOW_DIRTY_CHECKOUT=true IMAGE_REPOSITORY=${USER_ID} make docker-build [...] Successfully tagged quay.io/${USER_ID}/pagerduty-operator:latest $ podman login quay.io $ podman push quay.io/${USER_ID}/pagerduty-operator:latest ``` #### Generate secret with quay.io creds - visit account page <https://quay.io/user/{userid}?tab=settings> - click _generate encrypted password_ - Re-enter password - download `${USER_ID}-secret.yml` - Deploy quay.io secret ```bash oc project pagerduty-operator oc apply -f ~/Downloads/${USER_ID}-secret.yml -n pagerduty-operator ``` #### Deploy pagerduty-operator from custom repo Create a copy of `manifests/05-operator.yaml` and modify it to use your image from quay.io ```yaml ... imagePullSecrets: - name: ${USER_ID}-pull-secret containers: - name: pagerduty-operator image: quay.io/${USER_ID}/pagerduty-operator ... ``` Deploy modified operator manifest ```bash oc apply -f path/to/modified/operator.yaml ``` **Note:** In some cases, the `pagerduty-operator` pod in the `pagerduty-operator` namespace doesn't start with the following error: ```bash Warning FailedScheduling 3m5s default-scheduler 0/1 nodes are available: 1 Insufficient memory. preemption: 0/1 nodes are available: 1 No preemption victims found for incoming pod. ``` To remedy this, lower the requested resources in the `manifests/05-operator.yaml` deployment (e.g. lower memory from 2G to 0.5G). ### Create the `PagerDutyIntegration` object There's an example at `deploy-extras/pagerduty_v1alpha1_pagerdutyintegration_cr.yaml` that you can edit and apply to your cluster. You'll need to use a valid escalation policy ID from your PagerDuty account. You can get this by clicking on your policy at <https://{your-account}.pagerduty.com/escalation_policies#>. The ID will be visible in the URL after the `#` character. ### Create the `ClusterDeployment` object `pagerduty-operator` doesn't start reconciling clusters until `spec.installed` is set to `true`. You can create a dummy ClusterDeployment by copying a real one from an active hive ```bash real-hive$ oc get cd -n ${NAMESPACE} ${CD_NAME} -o yaml > /tmp/fake-clusterdeployment.yaml ... $ oc create namespace ${NAMESPACE} $ oc apply -f /tmp/fake-clusterdeployment.yaml ``` Perform the following modifications: ```bash oc edit clusterdeployment ${CD_NAME} -n ${NAMESPACE} ``` - Add the following finalizer (i.e. `metadata.finalizers`): ```yaml - pd.managed.openshift.io/example-pagerdutyintegration ``` (the suffix comes from the `PagerDutyIntegration` name) - Add the following label: ```yaml api.openshift.com/test: "true" ``` (this is used by the `ClusterDeployment` selector in the default [`PagerDutyIntegration`](deploy-extras/pagerduty_v1alpha1_pagerdutyintegration_cr.yaml)) - Set `spec.installed` to true. ### Delete the `ClusterDeployment` object To trigger `pagerduty-operator` to remove the service in pagerduty, delete the clusterdeployment. ```bash oc delete clusterdeployment fake-cluster -n fake-cluster-namespace ``` You may need to remove dangling finalizers from the `clusterdeployment` object. ```bash oc edit clusterdeployment fake-cluster -n fake-cluster-namespace ``` ## Testing ### Unit tests Run the full test suite: ```bash make test ``` This runs all Go unit tests including controller tests, utility tests, and PKO template tests. ### PKO template tests The operator is deployed via [Package Operator (PKO)](https://package-operator.run/). Deployment manifests live in `deploy_pko/` as Go templates (`.gotmpl` files) that PKO renders using config values from the ClusterPackage. Template tests validate that all `.gotmpl` files render correctly with different configurations. There are two layers of testing: **Go unit tests** (`pkg/pko/template_test.go`): Structural validation of rendered templates — verifies correct `kind`, metadata, phase annotations, config substitution (image, fedramp, escalation policies), array rendering via `toJson`, JSON blob quoting, and that osd-silent/osd-scale-test PDIs correctly include or omit fields relative to the main osd PDI. ```bash go test ./pkg/pko/... -v ``` **PKO snapshot tests** (`deploy_pko/manifest.yaml` `test.template` section): The `manifest.yaml` defines test contexts with different config values (production, integration, empty arrays, fedramp, orchestration-disabled). `kubectl-package validate` renders all templates with each context and compares the output against snapshot fixtures in `deploy_pko/.test-fixtures/`. ```bash kubectl-package validate deploy_pko/ ``` If the output doesn't match the fixtures, validation fails — this catches unintended changes to template rendering. ### Regenerating test fixtures After intentionally modifying a `.gotmpl` file or the `manifest.yaml` config schema, the snapshot fixtures need to be regenerated: ```bash rm -rf deploy_pko/.test-fixtures kubectl-package validate deploy_pko/ ``` This regenerates the fixture directories. Review the changes with `git diff` to confirm only the expected fields changed, then commit the updated fixtures alongside the template changes. If `kubectl-package` is not installed, download it from the [package-operator releases](https://github.com/package-operator/package-operator/releases).

Loading the repository README…

Skills in this repository

Software Developers

1 occupation category · 100% classified

skill

occupation

description

updated

prow-ci

Software Developers

Fetch and analyze OpenShift Prow CI job failures with automated artifact download and failure pattern detection

2026-07-06

Showing 1 of 1 collected skill.