Skip to content

[docs-scanner] Vague guidance on customizing Model Runner templates in Compose Bridge #24333

@docker-agent

Description

@docker-agent

File: content/manuals/compose/bridge/customize.md

Issue

The "Model Runner templates" section lists template files but provides no actionable information about what each template does or when users would want to customize them:

The default transformation also includes templates for applications that use LLMs:

  • model-runner-deployment.tmpl
  • model-runner-service.tmpl
  • model-runner-pvc.tmpl
  • /overlays/model-runner/kustomization.yaml
  • /overlays/desktop/deployment.tmpl

These templates can be extended or replaced to change how Docker Model Runner is deployed or configured.

This is too vague to be useful. Users don't know:

  • What each template controls
  • Why they might want to customize each one
  • What common customization scenarios exist

Suggested fix

Add brief descriptions for each template explaining its purpose, or provide at least one concrete example of a customization scenario:

The default transformation also includes templates for applications that use LLMs:

- `model-runner-deployment.tmpl` - Controls the Model Runner deployment configuration (replicas, resources, GPU settings)
- `model-runner-service.tmpl` - Defines the service exposing Model Runner endpoints
- `model-runner-pvc.tmpl` - Configures persistent storage for model files
- `/overlays/model-runner/kustomization.yaml` - Kustomize overlay for standalone Kubernetes deployments
- `/overlays/desktop/deployment.tmpl` - Desktop-specific deployment configuration

Common customization scenarios include adjusting resource limits, enabling GPU support, or modifying storage configurations.

Found by nightly documentation freshness scanner

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions