Skip to content

docs: update Docker quick start readiness logs - #5689

Merged
nobodyiam merged 5 commits into
masterfrom
codex/docker-quick-start-readiness
Oct 4, 2026
Merged

nobodyiam merged 5 commits into
masterfrom
codex/docker-quick-start-readiness

Conversation

@nobodyiam

@nobodyiam nobodyiam commented Oct 4, 2026 •

Copy link
Copy Markdown
Member

What's the purpose of this PR

The Docker Quick Start guide still shows the old background launcher's service/portal messages and separate log directories. Apollo 3.0.0 runs all three services in a foreground Java process, so these instructions no longer identify successful startup.

Update both language guides with the actual Config/Admin/Portal isActive: true messages and the shared /apollo-quick-start/apollo-service.log path. apolloconfig/apollo-quick-start#129 enables console application logs by default.

Which issue(s) this PR fixes

No linked issue.

Brief changelog

  • Replace legacy launcher log examples with verified Apollo 3.0.0 context startup messages.
  • Correct the shared file log path.

Validation: checked both guides against actual Apollo 3.0.0 + MySQL 8.0 container logs and HTTP startup; git diff --check and ./mvnw -q spotless:apply passed. Java code is unchanged, so Maven unit tests were not rerun.

  • Read the contributing guide.
  • Describe the changes and validation.
  • Java unit tests (mvn clean test): not run for this documentation-only change.
  • Run mvn spotless:apply.

Summary by CodeRabbit

  • Documentation
    • Updated the Docker quick-start guide to identify isActive: true messages for Config, Admin, and Portal as startup completion indicators, and clarify when to open http://localhost:8070.
    • Clarified that all three services write logs to /apollo-quick-start/apollo-service.log and explained how to inspect the file from a shell inside the container.

Copilot AI balanced review requested due to automatic review settings October 4, 2026 05:23

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 4, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-04T05:35:34.901071Z 78ffa1d New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Oct 4, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 36772e02-afda-478c-8713-a27a106de511
📥 Commits

Reviewing files that changed from the base of the PR and between dcdd3ee and 78ffa1d.

📒 Files selected for processing (2)
  • docs/en/deployment/quick-start-docker.md
  • docs/zh/deployment/quick-start-docker.md
 _________________________________________________________
< This PR is 10% code and 90% emotional support comments. >
 ---------------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f201405bdb

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

> If you are using a machine with an ARM architecture, such as a Mac M1, execute `docker-compose -f docker-compose-arm64.yml up`

Search all the logs starting with `apollo-quick-start` and see the following logs indicating a successful start.
Quick Start images for Apollo 3.0.0 and later run one foreground Java process containing Config Service, Admin Service, and Portal. Application logs are written to both the console and `/apollo-quick-start/apollo-service.log` by default.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Align the guide with the published Quick Start image

When this documentation lands before the companion image update, the preceding download steps still pull the untagged nobodyiam/apollo-quick-start, whose published latest tag is currently 2.5.0. That image's startup configuration unconditionally sets LOG_APPENDERS=FILE, and its Dockerfile launches demo.sh, so it does not emit these three markers to docker logs or honor the compose override described below. Users following the guide will therefore wait for output that cannot appear; publish and pin the compatible 3.0 image before replacing the existing readiness instructions, or retain instructions for the currently published image.

Useful? React with 👍 / 👎.

@nobodyiam
nobodyiam merged commit d2c55eb into master Oct 4, 2026
13 of 14 checks passed
@nobodyiam
nobodyiam deleted the codex/docker-quick-start-readiness branch October 4, 2026 05:39
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 4, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants