Skip to content

Conversation

@minlei98
Copy link
Contributor

@minlei98 minlei98 commented Jan 28, 2026

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 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-robot
Copy link

openshift-ci-robot commented Jan 28, 2026

@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
Copy link
Contributor

openshift-ci bot commented Jan 28, 2026

[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:

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

@openshift-ci 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 joshbranham removed their request for review January 28, 2026 19:31
- 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)
Copy link
Contributor

@ritmun ritmun Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

- 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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above: leave empty for default

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line can be removed

export SKIP_DESTROY_CLUSTER=true # Don't delete cluster after tests
```

4. **Run tests:**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line can be removed

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line can be removed

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to provide rosa/gcp and e2e-suite

Run tests based on Ginkgo labels:

```bash
# Run all Operator tests except Upgrade tests
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

--configs stage \
--label-filter "Operators && !Upgrade"

# Run only E2E labeled tests
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this command will do anything

### Skip Specific Tests

```bash
./out/osde2e test \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@ritmun
Copy link
Contributor

ritmun commented Jan 28, 2026

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

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jan 28, 2026

@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
Copy link
Contributor

ritmun commented Jan 28, 2026

/hold

@openshift-ci 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
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jan 28, 2026

@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
Copy link

openshift-ci-robot commented Jan 28, 2026

@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
Copy link

openshift-ci-robot commented Jan 28, 2026

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants