SDCICD-1715: updated osde2e README, created CONTRIBUTING.md and consolidated documents by minlei98 · Pull Request #3097 · openshift/osde2e

minlei98 · 2026-01-28T19:27:57Z

Major documentation restructure and updates:

New Documentation

Created docs/Log-Analysis-System.md consolidating internal/ READMEs
(sanitizer, analysisengine, reporter) into comprehensive guide
Created CONTRIBUTING.md with contribution guidelines aligned with AGENTS.md
Migrated content from ops-sop repository to docs/:
- docs/adhoc-osde2e-testing.md - Ad-hoc testing procedures
- docs/run-osde2e-tests.md - Running tests on existing clusters
- docs/testing-with-osde2e.md - Testing overview and guides

Updated Authentication

Replaced OCM_TOKEN with OCM_CLIENT_ID/OCM_CLIENT_SECRET across all docs
Updated all code examples, commands, and environment variable references
Updated README.md, CONTRIBUTING.md, docs/Config.md
Updated test READMEs (sdn_migration, mcscupgrade)
Updated all migrated documentation files with new credentials

Enhanced Documentation

Updated docs/Config.md with missing environment variables:
- Log Analysis and LLM variables (GEMINI_API_KEY, LLM_MODEL, etc.)
Enhanced architecture diagrams with double-line borders
Updated README.md to reference new Log Analysis and Contributing sections

Documentation Organization

Updated all references to point to correct documentation:
- README.md now references testing-with-osde2e.md
- CONTRIBUTING.md lists all testing guides
- Ad-Hoc-E2E-Job.md references correct documentation files
Cross-referenced all new documentation
Added AGENTS.md to CONTRIBUTING.md Additional Resources

Both AI and human are the contributors for this PR.

openshift-ci-robot · 2026-01-28T19:28:02Z

@minlei98: This pull request references SDCICD-1715 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Major documentation restructure and updates:

New Documentation

Created docs/Log-Analysis-System.md consolidating internal/ READMEs
(sanitizer, analysisengine, reporter) into comprehensive guide

Created CONTRIBUTING.md with contribution guidelines aligned with AGENTS.md

Created docs/Running-Tests.md migrating content from ops-sop repository
(excludes operator test harnesses as requested)

Updated Authentication

Replaced OCM_TOKEN with OCM_CLIENT_ID/OCM_CLIENT_SECRET across all docs

Updated all code examples, commands, and environment variable references

Updated README.md, CONTRIBUTING.md, Running-Tests.md, Config.md

Updated test READMEs (sdn_migration, mcscupgrade, krkn-params-examples)

Enhanced Documentation

Updated docs/Config.md with missing environment variables:

Log Analysis and LLM variables (GEMINI_API_KEY, LLM_MODEL, etc.)

Added missing CLI flags (--label-filter, --focus-tests, etc.)

Enhanced architecture diagrams with double-line borders for better readability

Updated README.md to reference new Log Analysis and Contributing sections

Documentation Organization

Consolidated Ad-Hoc-E2E-Job.md to reference Running-Tests.md

Cross-referenced all new documentation

Added AGENTS.md to CONTRIBUTING.md Additional Resources

Standardized language style across CONTRIBUTING.md to match AGENTS.md

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 openshift-eng/jira-lifecycle-plugin repository.

openshift-ci · 2026-01-28T19:29:13Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: minlei98

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [minlei98]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ritmun · 2026-01-28T19:49:15Z

docs/Self-Service-MOPs/Ad-Hoc-E2E-Job.md

+- ROSA sanity (stage): `rosa,stage,sanity`
+- ROSA full e2e (prod): `rosa,prod,e2e-suite`
+- Region: e.g., `me-central-1`
+- Instance Type: e.g., `x1e.xlarge` (or leave empty for random)


empty will not select random machine type. default is m5.xlarge for rosa , In general it will be ocp default.

ritmun · 2026-01-28T19:51:02Z

docs/Self-Service-MOPs/Ad-Hoc-E2E-Job.md

+- GCP sanity (stage): `gcp,stage,sanity`
+- GCP full e2e (prod): `gcp,prod,e2e-suite`
+- Region: e.g., `southamerica-west1`
+- Instance Type: e.g., `custom-8-32768` (or leave empty for random)


same as above: leave empty for default

ritmun · 2026-01-28T19:52:56Z

docs/Running-Tests.md

+```bash
+./out/osde2e test \
+  --cluster-id ${CLUSTER_ID} \
+  --environment stage \


line can be removed

ritmun · 2026-01-28T19:54:47Z

docs/Running-Tests.md

+export SKIP_DESTROY_CLUSTER=true   # Don't delete cluster after tests
+```
+
+4. **Run tests:**


what type of tests is this for? we have multiple types: ad-hoc-images, standalone tests in test/ and some inbuilt tests in sanity suite, all with different methods

ritmun · 2026-01-28T19:55:00Z

docs/Running-Tests.md

+# Run tests
+./out/osde2e test \
+  --cluster-id ${CLUSTER_ID} \
+  --environment prod \


line can be removed

ritmun · 2026-01-28T19:56:29Z

docs/Running-Tests.md

+```bash
+./out/osde2e test \
+  --cluster-id ${CLUSTER_ID} \
+  --environment stage \


line can be removed

ritmun · 2026-01-28T19:56:57Z

docs/Running-Tests.md

+./out/osde2e test \
+  --cluster-id ${CLUSTER_ID} \
+  --environment stage \
+  --configs stage \


need to provide rosa/gcp and e2e-suite

ritmun · 2026-01-28T19:57:46Z

docs/Running-Tests.md

+Run tests based on Ginkgo labels:
+
+```bash
+# Run all Operator tests except Upgrade tests


Operator tests are ad-hoc-images, they won't be using label filters

ritmun · 2026-01-28T19:58:05Z

docs/Running-Tests.md

+  --configs stage \
+  --label-filter "Operators && !Upgrade"
+
+# Run only E2E labeled tests


I don't think this command will do anything

ritmun · 2026-01-28T19:58:32Z

docs/Running-Tests.md

+### Skip Specific Tests
+
+```bash
+./out/osde2e test \


same as above , I don't think this command will do anything

ritmun · 2026-01-28T19:59:50Z

docs/Running-Tests.md

This file contains a lot of incorrect commands and configs. Could you verify accuracy of all of them?

ritmun · 2026-01-28T20:00:39Z

If this PR is generated by mainly AI, please add a note to the description !

openshift-ci-robot · 2026-01-28T20:24:59Z

@minlei98: This pull request references SDCICD-1715 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Major documentation restructure and updates:

New Documentation

Created docs/Log-Analysis-System.md consolidating internal/ READMEs
(sanitizer, analysisengine, reporter) into comprehensive guide

Created CONTRIBUTING.md with contribution guidelines aligned with AGENTS.md

Created docs/Running-Tests.md migrating content from ops-sop repository
(excludes operator test harnesses as requested)

Updated Authentication

Replaced OCM_TOKEN with OCM_CLIENT_ID/OCM_CLIENT_SECRET across all docs

Updated all code examples, commands, and environment variable references

Updated README.md, CONTRIBUTING.md, Running-Tests.md, Config.md

Updated test READMEs (sdn_migration, mcscupgrade)

Enhanced Documentation

Updated docs/Config.md with missing environment variables:

Log Analysis and LLM variables (GEMINI_API_KEY, LLM_MODEL, etc.)

Added missing CLI flags (--label-filter, --focus-tests, etc.)

Enhanced architecture diagrams with double-line borders for better readability

Updated README.md to reference new Log Analysis and Contributing sections

Documentation Organization

Consolidated Ad-Hoc-E2E-Job.md to reference Running-Tests.md

Cross-referenced all new documentation

Added AGENTS.md to CONTRIBUTING.md Additional Resources

Standardized language style across CONTRIBUTING.md to match AGENTS.md

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 openshift-eng/jira-lifecycle-plugin repository.

ritmun · 2026-01-28T20:44:13Z

/hold

openshift-ci-robot · 2026-01-28T20:44:21Z

@minlei98: This pull request references SDCICD-1715 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Major documentation restructure and updates:

New Documentation

Created docs/Log-Analysis-System.md consolidating internal/ READMEs
(sanitizer, analysisengine, reporter) into comprehensive guide

Created CONTRIBUTING.md with contribution guidelines aligned with AGENTS.md

Created docs/Running-Tests.md migrating content from ops-sop repository
(excludes operator test harnesses as requested)

Updated Authentication

Replaced OCM_TOKEN with OCM_CLIENT_ID/OCM_CLIENT_SECRET across all docs

Updated all code examples, commands, and environment variable references

Updated README.md, CONTRIBUTING.md, Running-Tests.md, Config.md

Updated test READMEs (sdn_migration, mcscupgrade)

Enhanced Documentation

Updated docs/Config.md with missing environment variables:

Log Analysis and LLM variables (GEMINI_API_KEY, LLM_MODEL, etc.)

Added missing CLI flags (--label-filter, --focus-tests, etc.)

Enhanced architecture diagrams with double-line borders for better readability

Updated README.md to reference new Log Analysis and Contributing sections

Documentation Organization

Consolidated Ad-Hoc-E2E-Job.md to reference Running-Tests.md

Cross-referenced all new documentation

Added AGENTS.md to CONTRIBUTING.md Additional Resources

Standardized language style across CONTRIBUTING.md to match AGENTS.md

AI is the major contributor for this PR.

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 openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot · 2026-01-28T23:04:19Z

@minlei98: This pull request references SDCICD-1715 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Major documentation restructure and updates:

New Documentation

Created docs/Log-Analysis-System.md consolidating internal/ READMEs
(sanitizer, analysisengine, reporter) into comprehensive guide

Created CONTRIBUTING.md with contribution guidelines aligned with AGENTS.md

Created docs/Running-Tests.md migrating content from ops-sop repository
(excludes operator test harnesses as requested)

Updated Authentication

Replaced OCM_TOKEN with OCM_CLIENT_ID/OCM_CLIENT_SECRET across all docs

Updated all code examples, commands, and environment variable references

Updated README.md, CONTRIBUTING.md, Running-Tests.md, Config.md

Updated test READMEs (sdn_migration, mcscupgrade)

Enhanced Documentation

Updated docs/Config.md with missing environment variables:

Log Analysis and LLM variables (GEMINI_API_KEY, LLM_MODEL, etc.)

Added missing CLI flags (--label-filter, --focus-tests, etc.)

Enhanced architecture diagrams with double-line borders for better readability

Updated README.md to reference new Log Analysis and Contributing sections

Documentation Organization

Consolidated Ad-Hoc-E2E-Job.md to reference Running-Tests.md

Cross-referenced all new documentation

Added AGENTS.md to CONTRIBUTING.md Additional Resources

Standardized language style across CONTRIBUTING.md to match AGENTS.md

Both AI and human are the contributors for this PR.

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 openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot · 2026-01-28T23:08:24Z

@minlei98: This pull request references SDCICD-1715 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.22.0" version, but no target version was set.

Details

In response to this:

Major documentation restructure and updates:

New Documentation

Created docs/Log-Analysis-System.md consolidating internal/ READMEs
(sanitizer, analysisengine, reporter) into comprehensive guide

Created CONTRIBUTING.md with contribution guidelines aligned with AGENTS.md

Migrated content from ops-sop repository to docs/:

docs/adhoc-osde2e-testing.md - Ad-hoc testing procedures

docs/run-osde2e-tests.md - Running tests on existing clusters

docs/testing-with-osde2e.md - Testing overview and guides

Updated Authentication

Replaced OCM_TOKEN with OCM_CLIENT_ID/OCM_CLIENT_SECRET across all docs

Updated all code examples, commands, and environment variable references

Updated README.md, CONTRIBUTING.md, docs/Config.md

Updated test READMEs (sdn_migration, mcscupgrade)

Updated all migrated documentation files with new credentials

Enhanced Documentation

Updated docs/Config.md with missing environment variables:

Log Analysis and LLM variables (GEMINI_API_KEY, LLM_MODEL, etc.)

Enhanced architecture diagrams with double-line borders

Updated README.md to reference new Log Analysis and Contributing sections

Documentation Organization

Updated all references to point to correct documentation:

README.md now references testing-with-osde2e.md

CONTRIBUTING.md lists all testing guides

Ad-Hoc-E2E-Job.md references correct documentation files

Cross-referenced all new documentation

Added AGENTS.md to CONTRIBUTING.md Additional Resources

Both AI and human are the contributors for this PR.

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 openshift-eng/jira-lifecycle-plugin repository.

…ents

minlei98 · 2026-02-05T21:11:12Z

Create several small PRs to help review.

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jan 28, 2026

openshift-ci bot requested review from joshbranham and varunraokadaparthi January 28, 2026 19:29

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 28, 2026

joshbranham removed their request for review January 28, 2026 19:31

ritmun reviewed Jan 28, 2026

View reviewed changes

openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 28, 2026

minlei98 force-pushed the SDCICD-1715 branch from 7e9ddaf to 68a8b29 Compare January 28, 2026 23:00

updated osde2e README, created CONTRIBUTING.md and consolidated docum…

800218a

…ents

minlei98 force-pushed the SDCICD-1715 branch from 68a8b29 to 800218a Compare January 28, 2026 23:14

minlei98 closed this Feb 5, 2026

minlei98 deleted the SDCICD-1715 branch February 5, 2026 21:11

Conversation

minlei98 commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Documentation

Updated Authentication

Enhanced Documentation

Documentation Organization

Uh oh!

openshift-ci-robot commented Jan 28, 2026 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Documentation

Updated Authentication

Enhanced Documentation

Documentation Organization

Uh oh!

openshift-ci bot commented Jan 28, 2026

Uh oh!

ritmun Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ritmun commented Jan 28, 2026

Uh oh!

openshift-ci-robot commented Jan 28, 2026 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Documentation

Updated Authentication

Enhanced Documentation

Documentation Organization

Uh oh!

ritmun commented Jan 28, 2026

Uh oh!

openshift-ci-robot commented Jan 28, 2026 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Documentation

Updated Authentication

Enhanced Documentation

Documentation Organization

Uh oh!

openshift-ci-robot commented Jan 28, 2026 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Documentation

Updated Authentication

Enhanced Documentation

Documentation Organization

Uh oh!

openshift-ci-robot commented Jan 28, 2026 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Documentation

Updated Authentication

Enhanced Documentation

Documentation Organization

Uh oh!

minlei98 commented Feb 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

minlei98 commented Jan 28, 2026 •

edited

Loading

openshift-ci-robot commented Jan 28, 2026 •

edited by openshift-ci bot

Loading

ritmun Jan 28, 2026 •

edited

Loading

openshift-ci-robot commented Jan 28, 2026 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Jan 28, 2026 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Jan 28, 2026 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Jan 28, 2026 •

edited by openshift-ci bot

Loading