Skip to content

Document Colima as a supported Docker runtime #1

Description

@xiebinJava

Why

The install docs talk about Docker Desktop memory. Many macOS users run Colima instead. A Colima profile with too little memory, or a compose project outside $HOME, fails in ways that look like OceanBase bugs.

Suggested change

In README.md or docs/operations/troubleshooting.md, add a short Colima note:

  • Give the Colima profile at least 10 GiB RAM (same bar as Docker Desktop).
  • Keep the clone under $HOME so the VM can mount the working directory (backup temp dirs already follow this).
  • Example: colima start --memory 11 --disk 60.

No code change required unless you also want docker-resources.sh to detect Colima in the error text.

Acceptance

A new user who only has Colima can follow the README without guessing Desktop-only settings.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions