Skip to content

docs: add Elyra KFP pipeline guide#200

Open
EdisonSu768 wants to merge 1 commit intomasterfrom
feat/add-elyra
Open

docs: add Elyra KFP pipeline guide#200
EdisonSu768 wants to merge 1 commit intomasterfrom
feat/add-elyra

Conversation

@EdisonSu768
Copy link
Copy Markdown
Member

@EdisonSu768 EdisonSu768 commented Apr 24, 2026

Summary

  • add a Workbench user guide for running Kubeflow Pipelines from JupyterLab with Elyra
  • document Elyra runtime metadata mounts, pipeline runtime images, and private registry image sync guidance
  • include a step-by-step two-notebook hello world pipeline flow and KFP UI verification path

Validation

  • ./node_modules/.bin/doom lint docs/en/workbench/how_to
  • commit hook: doom lint docs

Summary by CodeRabbit

  • Documentation
    • Added comprehensive how-to guide for executing Kubeflow Pipelines from JupyterLab with Elyra, including configuration setup, runtime image options, step-by-step pipeline creation, verification procedures, and troubleshooting guidance.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 24, 2026

Walkthrough

This change introduces a comprehensive how-to guide for executing Kubeflow Pipelines from JupyterLab using Elyra. The document covers prerequisites, configuration details via PVC-mounted and ConfigMap-mounted metadata, runtime image recommendations, setup steps, pipeline execution, verification procedures, and troubleshooting guidance.

Changes

Cohort / File(s) Summary
Documentation: Kubeflow Pipelines with Elyra Guide
docs/en/workbench/how_to/run-kubeflow-pipelines-with-elyra.mdx
New 412-line how-to guide covering prerequisites, Elyra configuration (PVC and ConfigMap mounting), runtime images, notebook and pipeline setup, KFP v2 execution flow, verification steps, and troubleshooting for common issues.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Poem

🐰 A guide hops to life on the page,
Kubeflow pipelines take center stage!
With Elyra's magic and notebooks so fine,
The clusters now gleam—documentation divine!
From setup to troubleshooting, every clue,
JupyterLab dreams now have pathways true! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding a documentation guide for running Kubeflow Pipelines with Elyra in JupyterLab.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/add-elyra

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.

❤️ Share

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

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 the current code and only fix it if needed.

Inline comments:
In `@docs/en/workbench/how_to/run-kubeflow-pipelines-with-elyra.mdx`:
- Around line 131-133: The PVC mount for runtime configuration shown with
mountPath: /opt/app-root/runtimes and pvcName: <elyra-runtime-config-pvc> is
currently set readOnly: false; change that default to readOnly: true so the
example mounts the runtime-config PVC as read-only (least privilege) unless a
later example explicitly requires writable access. Locate the block that defines
mountPath and pvcName and set the readOnly field to true.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 983d43d5-6269-4940-99ff-b0c1456698c6

📥 Commits

Reviewing files that changed from the base of the PR and between d4c4a48 and 3cbfcb2.

📒 Files selected for processing (1)
  • docs/en/workbench/how_to/run-kubeflow-pipelines-with-elyra.mdx

Comment on lines +131 to +133
- mountPath: /opt/app-root/runtimes
pvcName: <elyra-runtime-config-pvc>
readOnly: false
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Make the runtime-config PVC mount read-only in the example.

Line 133 currently uses readOnly: false for sensitive runtime metadata. This should default to read-only for least privilege unless write access is explicitly required.

🔒 Proposed docs fix
     volumes:
       data:
         - mountPath: /opt/app-root/runtimes
           pvcName: <elyra-runtime-config-pvc>
-          readOnly: false
+          readOnly: true
📝 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
- mountPath: /opt/app-root/runtimes
pvcName: <elyra-runtime-config-pvc>
readOnly: false
- mountPath: /opt/app-root/runtimes
pvcName: <elyra-runtime-config-pvc>
readOnly: true
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/en/workbench/how_to/run-kubeflow-pipelines-with-elyra.mdx` around lines
131 - 133, The PVC mount for runtime configuration shown with mountPath:
/opt/app-root/runtimes and pvcName: <elyra-runtime-config-pvc> is currently set
readOnly: false; change that default to readOnly: true so the example mounts the
runtime-config PVC as read-only (least privilege) unless a later example
explicitly requires writable access. Locate the block that defines mountPath and
pvcName and set the readOnly field to true.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying alauda-ai with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3cbfcb2
Status: ✅  Deploy successful!
Preview URL: https://34ec4c3d.alauda-ai.pages.dev
Branch Preview URL: https://feat-add-elyra.alauda-ai.pages.dev

View logs

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant