Skip to content

Add OSSM general information about all the jobs used by the team#81380

Merged
openshift-merge-bot[bot] merged 2 commits into
openshift:mainfrom
fjglira:add-ossm-docs
Jul 2, 2026
Merged

Add OSSM general information about all the jobs used by the team#81380
openshift-merge-bot[bot] merged 2 commits into
openshift:mainfrom
fjglira:add-ossm-docs

Conversation

@fjglira

@fjglira fjglira commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Instead of having a specific readme inside each folder I'm gathering all the information in only one place for simplicity. Also simplifiying a lot the current sail read me to keep it simple for users to read

Summary by CodeRabbit

This PR centralizes OSSM CI job documentation into a single Sail Operator README, making it easier to find and understand the team’s job workflows across federation, istio, proxy, sail-operator, and ztunnel. It also adds practical guidance for manually triggering presubmit and postsubmit jobs, including the relevant /test command patterns and Slack notification channels.

For Sail Operator performance testing, the documentation has been simplified and updated to reflect the current workflow. The PR refreshes the performance job trigger example, trims the results/access instructions down to the most useful locations, and streamlines the listed metrics so the README is shorter and easier to follow.

fjglira added 2 commits July 2, 2026 11:45
Signed-off-by: Francisco Herrera <fjglira@gmail.com>
Signed-off-by: Francisco Herrera <fjglira@gmail.com>
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

This PR rewrites the Sail Operator CI README, adding a CI jobs overview with repo/job tables, instructions for manually triggering presubmit jobs, a Slack notification channel mapping, an updated performance job trigger example, and simplified test results/metrics documentation.

Changes

Sail Operator CI README Update

Layer / File(s) Summary
CI jobs overview and triggering guidance
ci-operator/config/openshift-service-mesh/sail-operator/README.md
Adds a "CI Jobs Overview" section with tables for federation, istio, proxy, sail-operator, and ztunnel repos/jobs, instructions for manually triggering presubmit jobs via /test <variant>-<job>, sail-operator postsubmit retest commands, and Slack channel-to-job notification mapping.
Performance job trigger and results docs
ci-operator/config/openshift-service-mesh/sail-operator/README.md
Updates the manual trigger example to /test ocp-4.22-istio-pr-perfscale, trims "Accessing Test Results" to Prow Job Artifacts and Internal Performance Dashboard sections, removes outdated build-log/bot/troubleshooting content, and shortens the Performance Metrics list.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • openshift/release#81283: Introduces always_run: false, postsubmit job conversion, and Slack reporter_config changes matching the manual triggering and notification guidance documented here.

Suggested labels: lgtm, approved

Suggested reviewers: MaxBab


Important

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

❌ Failed checks (1 error)

Check name Status Explanation Resolution
No-Sensitive-Data-In-Logs ❌ Error README adds an internal Grafana URL and viewer/viewer credentials, exposing internal hostnames/credentials in repo docs. Remove the hostname/credential details or replace them with placeholders and link to private access docs.
✅ Passed checks (14 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the main change by describing centralized OSSM job documentation for the team's CI jobs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names ✅ Passed PASS: The PR only updates a README; no Ginkgo test definitions or titles changed, so there are no unstable/dynamic test names to review.
Test Structure And Quality ✅ Passed Docs-only README changes; no Ginkgo test code or test fixtures were modified, so the test-structure check is not applicable.
Microshift Test Compatibility ✅ Passed Docs/config only: sail-operator README and YAMLs changed, and the only touched Go file is a test-lane generator with no Ginkgo tests, so no MicroShift issue.
Single Node Openshift (Sno) Test Compatibility ✅ Passed This PR only updates README documentation; no new Ginkgo/e2e tests or multi-node assumptions were added.
Topology-Aware Scheduling Compatibility ✅ Passed PR only updates a markdown README; no deployment manifests, operators, or controllers were modified, so topology-aware scheduling checks are not applicable.
Ote Binary Stdout Contract ✅ Passed Only README and declarative ci-operator YAML changed in sail-operator; no Go/main/TestMain or stdout-writing code was touched.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed PR only updates README docs; no new Ginkgo/e2e tests or networking code were added, so this compatibility check is not applicable.
No-Weak-Crypto ✅ Passed The changed Sail README is documentation-only and contains no MD5/SHA1/DES/RC4/3DES/Blowfish, crypto APIs, or timing-safe comparison code.
Container-Privileges ✅ Passed PASS: The PR is docs-focused, and sail-operator YAMLs show no privileged, hostPID/hostNetwork/hostIPC, SYS_ADMIN, allowPrivilegeEscalation, or root-running settings.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@fjglira

fjglira commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

/retest

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 2, 2026
@openshift-ci openshift-ci Bot requested review from pbajjuri20 and rcernich July 2, 2026 10:07
@openshift-merge-bot

Copy link
Copy Markdown
Contributor

[REHEARSALNOTIFIER]
@fjglira: no rehearsable tests are affected by this change

Note: If this PR includes changes to step registry files (ci-operator/step-registry/) and you expected jobs to be found, try rebasing your PR onto the base branch. This helps pj-rehearse accurately detect changes when the base branch has moved forward.

@openshift-merge-bot openshift-merge-bot Bot added the rehearsals-ack Signifies that rehearsal jobs have been acknowledged label Jul 2, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@ci-operator/config/openshift-service-mesh/sail-operator/README.md`:
- Around line 69-71: The fenced /test example in the README is missing a
language tag, which triggers markdownlint MD040. Update the fenced block around
the /test <variant>-<job> example to use an explicit language such as bash or
text so the README stays lint-clean.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 11fa54e1-95c8-43df-a87f-d7dc3ed60e4b

📥 Commits

Reviewing files that changed from the base of the PR and between d947fcf and 046ddc8.

📒 Files selected for processing (1)
  • ci-operator/config/openshift-service-mesh/sail-operator/README.md

Comment on lines +69 to +71
```
/test <variant>-<job>
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Add a language to the /test example fence.

The bare fenced block trips markdownlint (MD040). Mark it as bash or text so the README stays lint-clean.

Proposed fix
-```
+```bash
 /test <variant>-<job>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
```
/test <variant>-<job>
```
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 69-69: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@ci-operator/config/openshift-service-mesh/sail-operator/README.md` around
lines 69 - 71, The fenced /test example in the README is missing a language tag,
which triggers markdownlint MD040. Update the fenced block around the /test
<variant>-<job> example to use an explicit language such as bash or text so the
README stays lint-clean.

Source: Linters/SAST tools

@fjglira

fjglira commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

/retest

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Jul 2, 2026
@openshift-ci

openshift-ci Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fjglira, MaxBab

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 commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

@fjglira: all tests passed!

Full PR test history. Your PR dashboard.

Details

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. I understand the commands that are listed here.

@openshift-merge-bot openshift-merge-bot Bot merged commit 0ac8f1f into openshift:main Jul 2, 2026
13 checks passed
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. lgtm Indicates that a PR is ready to be merged. rehearsals-ack Signifies that rehearsal jobs have been acknowledged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants