Skip to content

docs: clarify "primary docker image" error is an LLM backend failure#325

Open
mason5052 wants to merge 2 commits into
vxcontrol:mainfrom
mason5052:codex/issue-309-image-chooser-troubleshooting
Open

docs: clarify "primary docker image" error is an LLM backend failure#325
mason5052 wants to merge 2 commits into
vxcontrol:mainfrom
mason5052:codex/issue-309-image-chooser-troubleshooting

Conversation

@mason5052
Copy link
Copy Markdown
Contributor

Summary

Add a troubleshooting subsection to the README "Docker Image Configuration" section clarifying that the failed to select primary docker image via llm call error (older versions: failed to get primary docker image) is an LLM backend failure during image selection, not a Docker or registry problem.

Refs #309

Problem

On a fresh install, creating a flow can fail immediately with:

failed to get flow provider: failed to select primary docker image via llm call: API returned unexpected status code: 502

The phrase "primary docker image" leads users to debug Docker, the image registry, or pull access even though Docker is healthy. As the maintainer noted on #309 (and on the related #312 and #203), the real cause is the configured LLM backend: PentAGI makes its first LLM call to choose the primary image when a flow starts, so a backend failure (502/404, unreachable endpoint, wrong model, or a missing/mismatched tool-call parser on custom/sglang-style backends) surfaces at this step.

The error string itself was already made more precise in #312 / #320 (failed to get primary docker image -> failed to select primary docker image via llm call). This PR closes the remaining documentation gap so users can act on that clarified message.

Solution

Add a short #### Troubleshooting subsection under "Docker Image Configuration" that:

  • States the error indicates an LLM backend problem, not Docker or the registry.
  • Explains the image-selection-at-flow-start mechanism so the origin of a 502/404 is clear.
  • Distinguishes it from the existing "Restricted Networks, Docker Mirrors, and Proxies" subsection, which covers genuine registry reachability.
  • Gives concrete diagnosis steps: check docker logs pentagi, check the LLM backend logs, verify the provider URL/key/model, and confirm tool-call / function-calling parser support for custom, OpenAI-compatible, vLLM, or sglang backends.
  • Cross-links to the existing "Custom LLM Provider Configuration" section.

Documentation only. No runtime, schema, config, or behavior changes.

User Impact

Users who hit this error can immediately look in the right place (the LLM backend) instead of debugging Docker, reducing time-to-resolution for a recurring fresh-install confusion reported across #309, #312, and #203.

Test Plan

  • Documentation-only change; no Go or frontend code touched.
  • git diff --check reports no whitespace errors.
  • Verified only README.md is modified (15 insertions).
  • Verified the cross-link anchor #custom-llm-provider-configuration resolves to the existing "Custom LLM Provider Configuration" heading.
  • Reviewed the rendered Markdown for correct heading, list, and code-span formatting.

…xcontrol#309)

Add a troubleshooting subsection to the Docker Image Configuration
section explaining that "failed to select primary docker image via llm
call" (older versions: "failed to get primary docker image") is raised
when PentAGI's first LLM call fails during image selection, not when
Docker or the registry is unhealthy. Points users to PentAGI and LLM
backend logs, provider URL/key/model verification, and tool-call parser
configuration for custom/OpenAI-compatible/vLLM/sglang backends.
Copilot AI review requested due to automatic review settings June 1, 2026 21:06
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds targeted documentation to help users distinguish LLM-backend failures from Docker/registry issues when flow creation fails during primary image selection.

Changes:

  • Documented what the "failed to select primary docker image via llm call" error usually indicates.
  • Added diagnostic steps focusing on PentAGI and LLM backend configuration/logs.
  • Clarified common misdirection from older PentAGI error wording.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment thread README.md Outdated
Address review feedback on PR vxcontrol#325: capitalize SGLang to match the
project's name and clarify that tool calling and function calling
refer to the same capability.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants