Add Swarm S3 guide

[k3dz0r]

Summary by CodeRabbit

• Documentation

  • Added new guide for deploying large language models with S3-backed storage
  • Enhanced deployment documentation with tabbed interface for multiple model configurations
  • Updated deployment scripts with new default domain settings

• Chores

  • Upgraded Docusaurus framework to version 3.10.0

[coderabbitai]

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

This PR introduces a new LLM deployment guide with S3 storage support, restructures the existing vLLM guide with tabbed UI components, adds a new Bash deployment script for Qwen/S3 deployments, updates deployment script domain defaults from monai-swarm.win to superprotocol.com, and upgrades Docusaurus dependencies from version 3.9.2 to 3.10.0.

Changes

Cohort / File(s)	Summary
Documentation Guides docs/cli/Guides/swarm-vllm-s3.md, docs/cli/Guides/swarm-vllm.md	Added new Qwen/S3 deployment guide; restructured vLLM guide with Docusaurus Tabs for multi-model switching, updated sign-in instructions, changed BASE_DOMAIN handling and ingress verification flows, consolidated test requests under model tabs, and added Support section.
Deployment Scripts static/files/deploy_apertus_official.sh, static/files/deploy_medgemma_official.sh, static/files/deploy_qwen_s3.sh	Updated BASE_DOMAIN defaults from monai-swarm.win to superprotocol.com in existing scripts; added new Qwen/S3 deployment script with Kubernetes namespace provisioning, S3-backed secret management, Helm vLLM stack deployment, and Ingress resource configuration.
Package Dependencies package.json	Upgraded Docusaurus packages (@docusaurus/core, @docusaurus/plugin-client-redirects, @docusaurus/preset-classic, @docusaurus/theme-mermaid, @docusaurus/module-type-aliases, @docusaurus/types) from ^3.9.2 to ^3.10.0.

Sequence Diagram(s)

sequenceDiagram
    participant User as User/Operator
    participant Kubectl as kubectl
    participant Helm as Helm
    participant K8s as Kubernetes<br/>(Namespace/Secrets)
    participant S3 as S3 Bucket
    participant Ingress as Ingress<br/>Controller

    User->>Kubectl: Validate kubeconfig & create namespace
    Kubectl->>K8s: Create namespace (llm)
    K8s-->>Kubectl: Namespace created
    
    User->>Kubectl: Create API Key secret
    Kubectl->>K8s: Store vLLM_API_KEY
    K8s-->>Kubectl: Secret created
    
    User->>Kubectl: Create AWS/S3 credentials secret
    Kubectl->>K8s: Store AWS_ACCESS_KEY_ID, etc.
    K8s-->>Kubectl: Secret created
    
    User->>Helm: Deploy vLLM stack with Helm values
    Helm->>K8s: Install/upgrade vllm-stack release
    K8s->>S3: InitContainer syncs model via aws s3 sync
    S3-->>K8s: Model artifacts fetched
    K8s-->>Helm: Deployment ready
    Helm-->>User: Release deployed
    
    User->>Kubectl: Apply Ingress resource
    Kubectl->>K8s: Create Ingress (API_HOST)
    K8s->>Ingress: Register route
    Ingress-->>K8s: Ingress configured
    
    User->>Kubectl: Check pod/service/ingress status
    Kubectl->>K8s: Query resources
    K8s-->>Kubectl: Status returned
    Kubectl-->>User: Ready for requests
    
    User->>Ingress: Send curl request to /v1/chat/completions
    Ingress->>K8s: Route to vLLM service
    K8s-->>Ingress: Response from vLLM pod
    Ingress-->>User: API response

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐰 Hop! Skip! A new S3 stride,
Swarm deploys with Qwen inside,
Tabs now switch, domains align,
Docusaurus bumped to 3.10 divine!
With Helm and Ingress singing true,
Our LLM guide is fresh and new!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Add Swarm S3 guide' is partially related to the changeset, referring to the main new documentation file added, but is overly broad and does not capture the complete scope of changes which also include documentation updates, package upgrades, and deployment script modifications.

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

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch 2025-04-08

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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