Add faqs, and fix microos kubeovn networkpolicy blocks liveness probes#164
Open
typhoonzero wants to merge 1 commit intomasterfrom
Open
Add faqs, and fix microos kubeovn networkpolicy blocks liveness probes#164typhoonzero wants to merge 1 commit intomasterfrom
typhoonzero wants to merge 1 commit intomasterfrom
Conversation
WalkthroughAdded a comprehensive FAQ section to Kubeflow installation documentation covering Pod Security Admission label adjustments, oauth2-proxy OIDC URL configuration, S3/MinIO integration for pipeline runs, GPU resource customization, and kube-ovn Pod startup troubleshooting. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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: 2
🤖 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/installation/kubeflow.mdx`:
- Around line 380-424: Fix the spelling/grammar in the Kubeflow Notebook GPU
config section: change "resouce" to "resource" and "these hardware" to "this
hardware" in the introductory paragraph, replace "can not" with "cannot" (or
"can't") in the NOTE line, and consider changing "NOTE, you can only" to "NOTE:
you can only" for punctuation consistency; update any corresponding text around
the "gpus", "value", and "vendors" blocks so the wording is clear and
grammatically correct.
- Around line 341-378: Correct two spelling typos in the Kubeflow S3/MinIO docs:
replace "configuation" with "configuration" (occurrence near the sentence
starting "When you installed Kubeflow...") and replace "configration" with
"configuration" (occurrence in the last sentence starting "After add this
configmap...") in docs/en/installation/kubeflow.mdx so the documentation reads
correctly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 5453358a-2b16-43c7-b82f-0ecf323670cc
📒 Files selected for processing (1)
docs/en/installation/kubeflow.mdx
Comment on lines
+341
to
+378
| ### How to start a Kubeflow Pipeline Run with external S3/MinIO storage | ||
|
|
||
| When you installed Kubeflow with an external S3/MinIO storage service, you need to add a "KFP Launcher" configmap to setup storage used by current namespace or user. You can checkout Kubeflow document https://www.kubeflow.org/docs/components/pipelines/operator-guides/configure-object-store/#s3-and-s3-compatible-provider for more details. If no configuation is set, the pipeline runs may still accessing the default service address like "minio-service.kubeflow:9000" which is not correct. | ||
|
|
||
| Below is a simple sample for you to start: | ||
|
|
||
| ```yaml | ||
| apiVersion: v1 | ||
| data: | ||
| defaultPipelineRoot: s3://mlpipeline | ||
| providers: |- | ||
| s3: | ||
| default: | ||
| endpoint: minio.minio-system.svc:80 | ||
| disableSSL: true | ||
| region: us-east-2 | ||
| forcePathStyle: true | ||
| credentials: | ||
| fromEnv: false | ||
| secretRef: | ||
| secretName: mlpipeline-minio-artifact | ||
| accessKeyKey: accesskey | ||
| secretKeyKey: secretkey | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: kfp-launcher | ||
| namespace: wy-testns | ||
| ``` | ||
|
|
||
| For example, you should setup below values in this configmap to point to your own S3/MinIO storage | ||
|
|
||
| - defaultPipelineRoot: where to store the pipeline intermediate data | ||
| - endpoint: s3/MinIO service endpoint. Note, should NOT start with "http" or "https" | ||
| - disableSSL: whether disable "https" access to the endpoint | ||
| - region: s3 region. If using MinIO, any value will be fine | ||
| - credentials: AK/SK in the secrets | ||
|
|
||
| After add this configmap, the newly started Kubeflow Pipeline Runs will automatically read this configration, and save stuff that is used by Kubeflow Pipeline. |
There was a problem hiding this comment.
Fix spelling errors in S3/MinIO configuration section.
The ConfigMap structure and guidance are correct, but there are two typos:
- Line 343: "configuation" should be "configuration"
- Line 378: "configration" should be "configuration"
📝 Proposed fix for spelling errors
-If no configuation is set, the pipeline runs may still accessing the default service address like "minio-service.kubeflow:9000" which is not correct.
+If no configuration is set, the pipeline runs may still accessing the default service address like "minio-service.kubeflow:9000" which is not correct.-After add this configmap, the newly started Kubeflow Pipeline Runs will automatically read this configration, and save stuff that is used by Kubeflow Pipeline.
+After add this configmap, the newly started Kubeflow Pipeline Runs will automatically read this configuration, and save stuff that is used by Kubeflow Pipeline.🧰 Tools
🪛 LanguageTool
[grammar] ~343-~343: Ensure spelling is correct
Context: ...atible-provider for more details. If no configuation is set, the pipeline runs may still acc...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~378-~378: Ensure spelling is correct
Context: ...eline Runs will automatically read this configration, and save stuff that is used by Kubeflow...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/en/installation/kubeflow.mdx` around lines 341 - 378, Correct two
spelling typos in the Kubeflow S3/MinIO docs: replace "configuation" with
"configuration" (occurrence near the sentence starting "When you installed
Kubeflow...") and replace "configration" with "configuration" (occurrence in the
last sentence starting "After add this configmap...") in
docs/en/installation/kubeflow.mdx so the documentation reads correctly.
Comment on lines
+380
to
+424
| ### Configure Kubeflow Notebook to use custom GPU resources | ||
|
|
||
| You can add other GPU resouce types so that Kubeflow Notebook web page can create instances leveraging these hardware, e.g. when using Ascend GPUs. | ||
|
|
||
| Edit the configmap by running this command: | ||
|
|
||
| ```shell | ||
| kubectl -n kubeflow get configmap | grep jupyter-web-app-config | ||
| kubectl -n kubeflow edit configmap jupyter-web-app-config-<actual-cm-suffix> | ||
| ``` | ||
|
|
||
| Find below section and add your GPU resource types like "your-custom.com/gpu". | ||
|
|
||
| > NOTE, you can only add resource types using integer values, like 1,2,4,8. Also, you can not add "Virtual" or "Shared" GPU resources using both "Cores" and "Memory" like when you are using HAMi. | ||
|
|
||
| ```yaml | ||
| ################################################################ | ||
| # GPU/Device-Plugin Resources | ||
| ################################################################ | ||
| gpus: | ||
| readOnly: false | ||
|
|
||
| # configs for gpu/device-plugin limits of the container | ||
| # https://kubernetes.io/docs/tasks/manage-gpus/scheduling-gpus/#using-device-plugins | ||
| value: | ||
| # the `limitKey` of the default vendor | ||
| # (to have no default, set as "") | ||
| vendor: "" | ||
|
|
||
| # the list of available vendors in the dropdown | ||
| # `limitsKey` - what will be set as the actual limit | ||
| # `uiName` - what will be displayed in the dropdown UI | ||
| vendors: | ||
| - limitsKey: "nvidia.com/gpu" | ||
| uiName: "NVIDIA" | ||
| - limitsKey: "amd.com/gpu" | ||
| uiName: "AMD" | ||
| - limitsKey: "habana.ai/gaudi" | ||
| uiName: "Intel Gaudi" | ||
| - limitsKey: "your-custom.com/gpu" | ||
| uiName: "Your Custom Vendor" | ||
| # the default value of the limit | ||
| # (possible values: "none", "1", "2", "4", "8") | ||
| num: "none" | ||
| ``` |
There was a problem hiding this comment.
Fix spelling and grammar errors in GPU configuration section.
The kubectl commands and ConfigMap structure are correct, but there are several typos and grammar issues:
- Line 382: "resouce" should be "resource"
- Line 382: "these hardware" should be "this hardware"
- Line 393: "can not" should be "cannot" (or "can't")
📝 Proposed fixes for spelling and grammar
-You can add other GPU resouce types so that Kubeflow Notebook web page can create instances leveraging these hardware, e.g. when using Ascend GPUs.
+You can add other GPU resource types so that Kubeflow Notebook web page can create instances leveraging this hardware, e.g. when using Ascend GPUs.-> NOTE, you can only add resource types using integer values, like 1,2,4,8. Also, you can not add "Virtual" or "Shared" GPU resources using both "Cores" and "Memory" like when you are using HAMi.
+> NOTE, you can only add resource types using integer values, like 1,2,4,8. Also, you cannot add "Virtual" or "Shared" GPU resources using both "Cores" and "Memory" like when you are using HAMi.🧰 Tools
🪛 LanguageTool
[grammar] ~382-~382: Ensure spelling is correct
Context: ...om GPU resources You can add other GPU resouce types so that Kubeflow Notebook web pag...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~382-~382: Ensure spelling is correct
Context: ...eb page can create instances leveraging these hardware, e.g. when using Ascend GPUs. ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~393-~393: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...integer values, like 1,2,4,8. Also, you can not add "Virtual" or "Shared" GPU resources...
(CAN_NOT_PREMIUM)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/en/installation/kubeflow.mdx` around lines 380 - 424, Fix the
spelling/grammar in the Kubeflow Notebook GPU config section: change "resouce"
to "resource" and "these hardware" to "this hardware" in the introductory
paragraph, replace "can not" with "cannot" (or "can't") in the NOTE line, and
consider changing "NOTE, you can only" to "NOTE: you can only" for punctuation
consistency; update any corresponding text around the "gpus", "value", and
"vendors" blocks so the wording is clear and grammatically correct.
Deploying alauda-ai with
|
| Latest commit: |
40d0a64
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6b731ccc.alauda-ai.pages.dev |
| Branch Preview URL: | https://troubleshoot-kubeflow-networ.alauda-ai.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit