Skip to content

docs(pipelines): Add troubleshooting tip for standalone Pipelines installation #4084

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

kaikaila
Copy link

@kaikaila kaikaila commented Apr 11, 2025

This PR adds a troubleshooting tip under the installation section of Kubeflow Pipelines standalone deployment guide.

Some users (see kubeflow/pipelines#11757 and kubeflow/pipelines#9546) reported that using the default env/dev path caused persistent pod crashes, such as proxy-agent and workflow-controller failing to start. As a workaround, switching to the env/platform-agnostic configuration helped resolve the issue in version 2.0.0, verified on Minikube.

This patch proposes a minimal documentation update to help users facing similar issues.

Fixes kubeflow/pipelines#11757
Closes kubeflow/pipelines#11757
/area website
/area pipelines

…orm-agnostic path

Some users reported pod crashes (e.g., proxy-agent, workflow-controller) when following the default installation instruction using `env/dev`. This patch adds a troubleshooting tip to use `env/platform-agnostic` as an alternative.

Verified working on Minikube with v2.0.0, based on community suggestions (see kubeflow/pipelines#9546).

Fixes kubeflow/pipelines#11757

Signed-off-by: Yunkai Li <[email protected]>
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign chensun for approval. For more information see the Kubernetes Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link

Hi @kaikaila. Thanks for your PR.

I'm waiting for a kubeflow member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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/test-infra repository.

@kaikaila kaikaila changed the title docs(pipelines): add troubleshooting tip for installation docs(pipelines): Add troubleshooting tip for standalone Pipelines installation Apr 11, 2025
@@ -24,11 +24,19 @@ You should be familiar with [Kubernetes](https://kubernetes.io/docs/home/),
kubectl apply -k "github.com/kubeflow/pipelines/manifests/kustomize/env/dev?ref=$PIPELINE_VERSION"
Copy link
Member

Choose a reason for hiding this comment

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

I think we replace the environment installation from dev to env/platform-agnostic to make the installation compatible on any Kubernetes cluster

Copy link
Author

Choose a reason for hiding this comment

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

I think we replace the environment installation from dev to env/platform-agnostic to make the installation compatible on any Kubernetes cluster

That makes sense — I originally added it as a troubleshooting tip to keep the change minimal, but I agree platform-agnostic might be a better default in the long run.

I'm happy to update the PR if that's the preferred direction from the maintainers. Open to hearing what others think!

Copy link
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

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

/ok-to-test

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

Successfully merging this pull request may close these issues.

[bug] Incorrect Deployment URL in Kubeflow Pipelines Documentation
3 participants