WIP: add diagram that details the dataflow in component-readiness #3262
Conversation
|
Pipeline controller notification For optional jobs, comment This repository is configured in: automatic mode |
openshift-ci
bot
added
the
do-not-merge/work-in-progress
|
@smg247: GitHub didn't allow me to request PR reviews from the following users: noone. Note that only openshift members and repo collaborators can review this PR, and authors cannot review their own PRs. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
WalkthroughAdds a new, comprehensive documentation file for the Component Readiness system describing architecture, data flows, data sources (BigQuery, PostgreSQL, Redis), data loading jobs, data models, query patterns, statistical methods, cache and performance considerations, and frontend integration. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 7✅ Passed checks (7 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: smg247 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@component-readiness.md`:
- Around line 207-213: The markdown contains multiple fenced code blocks lacking
language identifiers (MD040); update each fence around the diagrams and sample
lines—specifically the blocks containing the GCS Artifacts flow diagram, the
ComponentReport/ComponentReport~4.15~4.16~Platform lines, the Pass/Fail table,
and the template lines (ComponentReport~{base_release}..., TestDetails~...,
Variants~...)—by adding an appropriate language tag (e.g., text, sql, or
mermaid) after the opening backticks so markdownlint no longer flags them.
- Around line 789-799: The markdown tables starting with the header line "|
Column | Example Value |" (e.g., the table showing `id`, `suite`, `name`,
`component`, etc.) must be surrounded by a blank line before and after the table
to satisfy MD058; insert one empty line immediately above the table header and
one empty line immediately below the closing table row for each occurrence
(notably the blocks around the example with `openshift-tests:abc123def456` and
the other occurrences referenced) so each table is isolated by blank lines.
| ``` | ||
| GCS Artifacts → job-run-aggregator → openshift-ci-data-analysis.ci_data | ||
| ↓ | ||
| fetchdata copies to → openshift-gce-devel.ci_analysis_us | ||
| ↓ | ||
| Component Readiness queries | ||
| ``` |
There was a problem hiding this comment.
Add language identifiers to fenced code blocks.
Markdownlint flags missing languages for these fences. Specify a language like text, sql, or mermaid as appropriate to fix MD040.
🔧 Suggested update
-```
+```text
GCS Artifacts → job-run-aggregator → openshift-ci-data-analysis.ci_data
↓
fetchdata copies to → openshift-gce-devel.ci_analysis_us
↓
Component Readiness queries
-```
+```
-```
+```text
ComponentReport~4.15~4.16~Platform:aws~...
ComponentReport~4.15~4.16~Platform:gcp~...
ComponentReport~4.15~4.16~Platform:azure~...
... (hundreds of permutations)
-```
+```
-```
+```text
Pass Fail Total
Base: a b a+b
Sample: c d c+d
Total: a+c b+d n
p-value = hypergeometric probability (two-tailed)
-```
+```
-```
+```text
ComponentReport~{base_release}~{sample_release}~{variants}~{filters}~{config_version}
TestDetails~{base_release}~{sample_release}~{test_id}~{variants}~{config_version}
Variants~{release}~{config_version}
-```
+```Also applies to: 888-893, 1380-1387, 1407-1411
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 207-207: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In `@component-readiness.md` around lines 207 - 213, The markdown contains
multiple fenced code blocks lacking language identifiers (MD040); update each
fence around the diagrams and sample lines—specifically the blocks containing
the GCS Artifacts flow diagram, the
ComponentReport/ComponentReport~4.15~4.16~Platform lines, the Pass/Fail table,
and the template lines (ComponentReport~{base_release}..., TestDetails~...,
Variants~...)—by adding an appropriate language tag (e.g., text, sql, or
mermaid) after the opening backticks so markdownlint no longer flags them.
| **Table Updated:** | ||
| | Column | Example Value | | ||
| |--------|---------------| | ||
| | `id` | `openshift-tests:abc123def456` | | ||
| | `suite` | `openshift-tests` | | ||
| | `name` | `[sig-network] Services should provide secure connectivity` | | ||
| | `component` | `Networking` | | ||
| | `capabilities` | `["Connectivity", "LoadBalancing"]` | | ||
| | `jira_component` | `Networking / ovn-kubernetes` | | ||
| | `created_at` | `2026-02-11 04:00:00` | | ||
|
|
There was a problem hiding this comment.
Surround tables with blank lines to satisfy MD058.
Add a blank line before and after these tables to fix markdownlint warnings.
🔧 Suggested update
**Table Updated:**
+
| Column | Example Value |
|--------|---------------|
| `id` | `openshift-tests:abc123def456` |
| `suite` | `openshift-tests` |
| `name` | `[sig-network] Services should provide secure connectivity` |
| `component` | `Networking` |
| `capabilities` | `["Connectivity", "LoadBalancing"]` |
| `jira_component` | `Networking / ovn-kubernetes` |
| `created_at` | `2026-02-11 04:00:00` |
+
---
**Variant Extraction Examples:**
+
| Job Name | Extracted Variants |
|----------|-------------------|
| `periodic-ci-openshift-release-master-nightly-4.16-e2e-gcp-ovn` | Platform=gcp, Network=ovn, Release=4.16 |
| `periodic-ci-openshift-release-master-ci-4.16-upgrade-from-stable-4.15-e2e-aws-sdn-upgrade` | Platform=aws, Network=sdn, Release=4.16, Upgrade=upgrade |
| `release-openshift-ocp-installer-e2e-azure-serial-4.16` | Platform=azure, Release=4.16, Suite=serial |
+
**Table Updated:**
+
| Column | Example Value |
|--------|---------------|
| `job_name` | `periodic-ci-openshift-release-master-nightly-4.16-e2e-gcp-ovn` |
| `variant_name` | `Platform` |
| `variant_value` | `gcp` |
+
---
**Table Updated:**
+
| Column | Source |
|--------|--------|
| `prowjob_build_id` | GCS path (e.g., `1234567890`) |
| `prowjob_job_name` | Job name from metadata |
| `prowjob_start` | Job start timestamp |
| `prowjob_url` | Link to Prow job page |
| `org`, `repo`, `pr_number` | GitHub PR info |
+Also applies to: 832-839, 841-847, 976-984
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 790-790: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
🤖 Prompt for AI Agents
In `@component-readiness.md` around lines 789 - 799, The markdown tables starting
with the header line "| Column | Example Value |" (e.g., the table showing `id`,
`suite`, `name`, `component`, etc.) must be surrounded by a blank line before
and after the table to satisfy MD058; insert one empty line immediately above
the table header and one empty line immediately below the closing table row for
each occurrence (notably the blocks around the example with
`openshift-tests:abc123def456` and the other occurrences referenced) so each
table is isolated by blank lines.
2 participants
/cc noone
I don't plan on merging this, but I want to be able to share it. It was generated with Claude with the idea of learning how data flows through the application and what tables and columns are important.
Summary by CodeRabbit