Skip to content

docs: fix ConfigMap creation sequence in example docs #1348

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

Merged
merged 1 commit into from
Aug 5, 2025

Conversation

andyzhangx
Copy link
Collaborator

Reason for Change:

doc: fix ConfigMap creation sequence in example docs

ConfigMap should be created before worksapce, otherwise in the first run of kubectl apply -f ... command, it would report ConfigMap not found error, then you need to run kubectl apply -f ... command twice to workaround this issue.

Requirements

  • added unit tests and e2e tests (if applicable).

Issue Fixed:

Notes for Reviewers:

Copy link

kaito-pr-agent bot commented Aug 5, 2025

Title

Ensure ConfigMap is created before Workspace in examples


Description

  • Reordered ConfigMap creation before Workspace in example YAML files

  • Ensured correct sequence for kubectl apply command

  • Updated documentation examples to reflect correct order


Changes walkthrough 📝

Relevant files
Enhancement
2 files
kaito_workspace_custom_config.yaml
Moved ConfigMap definition before Workspace                           
+15/-15 
kaito_workspace_llama-3.3_70b_instruct.yaml
Moved ConfigMap definition before Workspace                           
+17/-16 
Documentation
6 files
inference.md
Updated ConfigMap and Workspace order in example                 
+15/-15 
multi-node-inference.md
Updated ConfigMap and Workspace order in example                 
+10/-10 
inference.md
Updated ConfigMap and Workspace order in example                 
+15/-15 
multi-node-inference.md
Updated ConfigMap and Workspace order in example                 
+10/-10 
inference.md
Updated ConfigMap and Workspace order in example                 
+15/-15 
multi-node-inference.md
Updated ConfigMap and Workspace order in example                 
+10/-10 

Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • Copy link

    kaito-pr-agent bot commented Aug 5, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Formatting

    The --- separator is used to denote the start of a new document in YAML. Ensure that the formatting is consistent and that there are no unintended new documents being created.

    ---
    Formatting

    The --- separator is used to denote the start of a new document in YAML. Ensure that the formatting is consistent and that there are no unintended new documents being created.

    apiVersion: kaito.sh/v1beta1
    Formatting

    The --- separator is used to denote the start of a new document in YAML. Ensure that the formatting is consistent and that there are no unintended new documents being created.

    apiVersion: kaito.sh/v1beta1

    Copy link

    kaito-pr-agent bot commented Aug 5, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    Ensure ConfigMap creation order

    Ensure that the ConfigMap named ds-inference-params is defined before the Workspace
    resource to maintain the correct creation sequence.

    examples/inference/kaito_workspace_custom_config.yaml [21-34]

    +apiVersion: v1
    +kind: ConfigMap
    +metadata:
    +  name: ds-inference-params
    +data:
    +  inference_config.yaml: |
    +    vllm:
    +      cpu-offload-gb: 0
    +      gpu-memory-utilization: 0.95
    +      swap-space: 4
    +      max-model-len: 131072
    +      tensor-parallel-size: 2
    +      max-seq-len-to-capture: 8192
    +      num-scheduler-steps: 1
    +      enable-chunked-prefill: true
    +      # see https://docs.vllm.ai/en/latest/serving/engine_args.html for more options.
     ---
     apiVersion: kaito.sh/v1beta1
     kind: Workspace
     metadata:
       name: workspace-deepseek-r1-distill-qwen-14b
     resource:
       instanceType: "Standard_NC24ads_A100_v4"
       labelSelector:
         matchLabels:
           apps: deepseek-r1-distill-qwen-14b
     inference:
       preset:
         name: "deepseek-r1-distill-qwen-14b"
       config: "ds-inference-params"
    Suggestion importance[1-10]: 7

    __

    Why: The suggestion correctly identifies the need to define the ConfigMap before the Workspace resource. However, it does not address any critical issues and mainly focuses on ensuring the correct creation sequence, which is important but not a major bug fix.

    Medium

    @andyzhangx andyzhangx changed the title doc: fix ConfigMap creation sequence in example docs docs: fix ConfigMap creation sequence in example docs Aug 5, 2025
    @Fei-Guo Fei-Guo merged commit 3ea17ff into kaito-project:main Aug 5, 2025
    15 of 17 checks passed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    Status: Done
    Development

    Successfully merging this pull request may close these issues.

    2 participants