development-tools

A centralized location for the openshift observability-ui team to keep development-related scripts and information.

Miro Mind Map

https://miro.com/app/board/uXjVIHGY4-A=/

UI Plugins Life Cycle

https://docs.google.com/spreadsheets/d/1iJP8hjod1J_Wqv_sfGglwVYquhsHLRlqjoyvrMBv0FY/edit?gid=0#gid=0

OCP Life Cycle

https://access.redhat.com/support/policy/updates/openshift

Compatibility Matrix

https://github.com/rhobs/observability-operator/blob/main/docs/user-guides/observability-ui-plugins.md

COO Version	OCP Versions	Dashboards	Distributed Tracing	Logging	Troubleshooting Panel	Monitoring
0.2.0	4.11	✔	✘	✘	✘	✘
0.3.0 - 0.4.0	4.11 - 4.15	✔	✔	✔	✘	✘
0.3.0 - 0.4.0	4.16+	✔	✔	✔	✔	✘
1.0.0+	4.11 - 4.14	✔	✔	✔	✘	✘
1.0.0+	4.15	✔	✔	✔	✘	✔
1.0.0+	4.16+	✔	✔	✔	✔	✔

Details on Monitoring Plugin Image Streams: Breaking Changes

COO Version	OCP Versions	Breaking Change
COO 1	4.12 - 4.14	PF4
COO 1.1	4.15 - 4-18	PF5
COO TBD	4.19+	PF6

Upcoming breaking change

1. React Router may land in OCP 4.19 or 4.20

Minimize breaking changes to the same version to avoid multiple streams

1. Konflux maintence of multiple versions/streams of the same component (e.g. Distributed-tracing-0.3, Distributed-tracing-0.4, Logging 6.0 Logging 6.1 all packaged in COO 1.2)
2. Backporting becomes more complex. We cannot automatically backport; some manual adjustments are required to accommodate breaking changes.

OpenShift Console Versions vs PatternFly Versions

https://github.com/openshift/console/blob/main/frontend/packages/console-dynamic-plugin-sdk/README.md#openshift-console-versions-vs-patternfly-versions

Each Console version supports specific version(s) of PatternFly in terms of CSS styling. This table will help align compatible versions of PatternFly to versions of the OpenShift Console.

Console Version	PatternFly Versions	Notes
4.19.x	6.x + 5.x	New dynamic plugins should use PF 6.x
4.15.x - 4.18.x	5.x + 4.x	New dynamic plugins should use PF 5.x
4.12.x - 4.14.x	4.x

ROSA Clusters

Requires a STS role 'ManagedOpenShift'

https://docs.openshift.com/rosa/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.html

Makefile

To pass your own image of the observability operator bundle use the flag OPERATOR_BUNDLE. For example:

make coo-resources OPERATOR_BUNDLE="quay.io/test/observability-operator-bundle"

Konflux

1. UI https://console.redhat.com/application-pipeline/workspaces/jezhu/applications/perses-operator-staging/activity/pipelineruns

Testing

Monitoring Test Plan

https://docs.google.com/document/d/1ZtGEFDOIsLDHnp8Gd0bq41RaRkm0_nrp37gj-mNo9BI/edit?usp=sharing

COO Acceptance Criteria

https://docs.google.com/document/d/1rBio1lFD3GzWqVP35ZLUdfVDNPwjDSxG08wy5Yo2tG8/edit?tab=t.0#heading=h.bupciudrwmna