Update KF pipeline deployment document #329
Conversation
|
/assign @sarahmaddox @abhi-g |
|
/assign @paveldournov @yebrahim @qimingj @vicaire |
| ```bash | ||
| kubectl create -f bootstrapper.yaml | ||
| ``` | ||
| Starting from Kubeflow Pipeline [V0.1.3](https://github.com/kubeflow/pipelines/releases/tag/0.1.3), pipeline will be one of the Kubeflow core components. It will be deployed automatically when deploying Kubeflow. Please refer to [GKE setup](/docs/started/getting-started-gke/)" for setting up Kubeflow. |
There was a problem hiding this comment.
I'd use present tense here, people will likely be reading this after 0.1.3 is out.
There was a problem hiding this comment.
For some reason, I don't see your update in the latest diff...
There was a problem hiding this comment.
oh i failed to push the change. updated.
| ```bash | ||
| kubectl create -f bootstrapper.yaml | ||
| ``` | ||
| Starting from [V0.1.3](https://github.com/kubeflow/pipelines/releases/tag/0.1.3), Kubeflow Pipeline becomes one of the Kubeflow core components. It's automatically deployed during Kubeflow deployment. Please refer to [GKE setup](/docs/started/getting-started-gke/)" for setting up Kubeflow. |
There was a problem hiding this comment.
s/Kubeflow Pipeline/Kubeflow Pipelines
There was a problem hiding this comment.
Also remove the extra quotation mark " after the bracket - it's rendering on the page.
| ```bash | ||
| kubectl create -f bootstrapper.yaml | ||
| ``` | ||
| Starting from [V0.1.3](https://github.com/kubeflow/pipelines/releases/tag/0.1.3), Kubeflow Pipeline becomes one of the Kubeflow core components. It's automatically deployed during Kubeflow deployment. Please refer to [GKE setup](/docs/started/getting-started-gke/)" for setting up Kubeflow. |
There was a problem hiding this comment.
We shouldn't refer only to the GKE setup, as Pipelines is available for other flavours of Kubeflow too. Instead, how about linking to the getting-started guide:
See the [getting-started guide](/docs/started/getting-started/) for help with setting up Kubeflow, or the [GKE setup](/docs/started/getting-started-gke/) for a specific guide to Kubeflow on GKE.
There was a problem hiding this comment.
Thanks Sarah. Great you pointed this out. I link to the GKE deployment on propose.
Unfortunately some of the Pipeline features are relying on GCP(specifically GCS) and it's not available for non-GCP environment. See
kubeflow/pipelines#345
kubeflow/pipelines#337
Before they are resolved, I am not sure if we should link to the guide you mentioned. The rest of the features should work fine though. What do you think? Which link should we point user to?
There was a problem hiding this comment.
Do you mind adding a line mentioning this? There are users interested in trying this on non-GCP platforms and it would help them to know before spending time and figuring this out after some pain.
|
|
||
| Note: Due to | ||
| [kubeflow/pipelines#345](https://github.com/kubeflow/pipelines/issues/345) and | ||
| [kubeflow/pipelines#337](https://github.com/kubeflow/pipelines/issues/337), Kubeflow Pipelines depends on GCP services and some of the funcitonalities are not supported by non-GKE cluster. |
| Note: Due to | ||
| [kubeflow/pipelines#345](https://github.com/kubeflow/pipelines/issues/345) and | ||
| [kubeflow/pipelines#337](https://github.com/kubeflow/pipelines/issues/337), Kubeflow Pipelines depends on GCP services and some of the funcitonalities are not supported by non-GKE cluster. | ||
| For best user experience, please deploy Kubeflow through GKE. Please refer to [GKE setup](/docs/started/getting-started-gke/) for instruction. |
There was a problem hiding this comment.
Can we please reword this last sentence to:
You can try it currently with a Kubeflow deployment on GKE. Please refer to GKE setup for instructions.
There was a problem hiding this comment.
Also as an FYI, tech writers avoid the use of the word "please" as it can have an ambiguous tone, especially for readers whose first language is not English. Instead, it's clearer just to tell people what to do:
You can try it currently with a Kubeflow deployment on GKE. See the [GKE setup guide](/docs/started/getting-started-gke/).
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: abhi-g The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Note - The v0.1.3 is not yet created. The link will be valid once the release is created.
This change is