NO-JIRA: add Konflux links to documentation for ODH-io and RHDS #2662
Conversation
Added documentation for Konflux projects including ODH-io and RHDS with links to their respective UIs and OpenShift consoles.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
github-actions
bot
added
the
review-requested
WalkthroughAdded a new documentation file Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/konflux.md (2)
1-15: Add context and documentation structure.The file lacks an introduction explaining what Konflux is, the purpose of these links, or how users should navigate between ODH-io and RHDS environments. Without this context, new readers may be confused about when to use each environment.
Consider adding a brief introduction at the top explaining:
- What Konflux is (or link to external documentation)
- The purpose of each environment (ODH-io vs. RHDS)
- When to use which environment
Example structure:
# Konflux Konflux is [brief description/link]. This page provides links to the Konflux UI and OpenShift console for different environments. ## ODH-io ...
1-15: Document URL maintenance and staleness risk.The file contains hardcoded production URLs that may become stale if infrastructure is updated. Consider adding a note about:
- How often these URLs might change
- Where to report broken links
- How to update these URLs when needed
Example addition:
# Konflux ... **Note:** These URLs are subject to change. If you encounter broken links, please [file an issue/contact the team](link-to-issue-tracker).
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/konflux.md(1 hunks)
🔇 Additional comments (1)
docs/konflux.md (1)
7-7: Clarify inconsistent Konflux UI link paths.The Konflux UI links use different URL paths:
- ODH-io:
.../applications/opendatahub-release/components- RHDS:
.../applicationsPlease clarify whether this inconsistency is intentional or if both should use the same path structure.
Also applies to: 14-14
Added links to configurations and automation workflows for ODH and RHDS projects.
|
@jiridanek: The following test failed, say
Full PR test history. Your PR dashboard. 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. |
atheo89
left a comment
atheo89
left a comment
There was a problem hiding this comment.
Super useful doc Jiri! Thank you for adding that. I just added some text on you links as it was a bit dry.
| @@ -0,0 +1,25 @@ | |||
| # Konflux | |||
|
|
|||
There was a problem hiding this comment.
This file provides an overview and quick access links to the Konflux environments used for building and deploying components for the Open Data Hub (ODH) and Red Hat Data Services (RHDS) projects.
There was a problem hiding this comment.
@jiridanek, I cannot commit code directly to the repository, but I can provide you with the suggested text that you can add to the file yourself.
Here's the content suggested by @atheo89 that should be added after the # Konflux heading:
# Konflux
This file provides an overview and quick access links to the **Konflux** environments used for building and deploying components for the **Open Data Hub (ODH)** and **Red Hat Data Services (RHDS)** projects.You can add this descriptive paragraph right after the heading in docs/konflux.md to provide context about what the file contains.
| @@ -0,0 +1,25 @@ | |||
| # Konflux | |||
|
|
|||
| ## ODH-io | |||
There was a problem hiding this comment.
ODH-io (Open Data Hub)
This section covers the Konflux setup for the upstream Open Data Hub community project.
project: open-data-hub-tenant
- Konflux UI: View and monitor applications, components, and pipelines running in the ODH tenant.
- OpenShift Console: Access the underlying OpenShift cluster for deeper insights, logs, and resource management.
- Configuration Repository (
odh-konflux-central): The primary source of truth for the Konflux configuration (GitOps).
| [pipelines](https://github.com/opendatahub-io/odh-konflux-central/tree/main/pipelines/notebooks), | ||
| [gitops](https://github.com/opendatahub-io/odh-konflux-central/tree/main/gitops) (components, e2e tests) | ||
|
|
||
| ## RHDS |
There was a problem hiding this comment.
RHDS (Red Hat Data Services / RHOAI)
This section covers the Konflux setup for the enterprise downstream Red Hat Data Services offering (often associated with RHOAI - Red Hat OpenShift AI).
project: rhoai-tenant
- Konflux UI: View and monitor applications and components specific to the RHDS tenant.
- OpenShift Console: Access the underlying OpenShift cluster for the RHDS tenant.
- Configuration Repository (
konflux-central): GitOps repository for RHDS Konflux definitions.- configs:
- pipelineruns: Specific PipelineRun definitions used for execution.
- configs:
| * [configs](https://github.com/red-hat-data-services/konflux-central): | ||
| [pipelineruns](https://github.com/red-hat-data-services/konflux-central/tree/main/pipelineruns/notebooks/.tekton) | ||
|
|
||
| ## Automations |
There was a problem hiding this comment.
⚙️ Automations (Upstream/Downstream Flow)
These GitHub Actions workflows manage the automated synchronization of configurations between the upstream ODH community repositories and the downstream RHDS/RHOAI repositories, ensuring a smooth flow of changes and releases.
- ODH-io -> RHDS Auto-Merge (Upstream to Downstream): Automatically merges approved changes from ODH upstream configurations into the RHDS central configuration repository.
- RHDS/main -> RHOAI- Auto-Merge (Release Propagation):* Manages the promotion of changes from the main RHDS branch to specific release branches (e.g.,
rhoai-vX.Y), facilitating new product releases.
|
Want to add AIPCC Python Index urls to some doc
|
2 participants
Added documentation for Konflux projects including ODH-io and RHDS with links to their respective UIs and OpenShift consoles.
Description
How Has This Been Tested?
Self checklist (all need to be checked):
make test(gmakeon macOS) before asking for reviewDockerfile.konfluxfiles should be done inodh/notebooksand automatically synced torhds/notebooks. For Konflux-specific changes, modifyDockerfile.konfluxfiles directly inrhds/notebooksas these require special attention in the downstream repository and flow to the upcoming RHOAI release.Merge criteria:
Summary by CodeRabbit