Skip to content

docs: distinguish Store process lifecycle from readiness - #59

Open
imbajin wants to merge 1 commit into
masterfrom
codex/document-store-process-lifecycle
Open

imbajin wants to merge 1 commit into
masterfrom
codex/document-store-process-lifecycle

Conversation

@imbajin

@imbajin imbajin commented Oct 31, 2026 •

Copy link
Copy Markdown

The Store state flag is operator-set and does not establish storage readiness. Document the proposed GET /-/lifecycle response in both Store quickstarts, including its absence on older versions and the distinction between a started process and restored, caught-up shards.

This documentation depends on the paired Store lifecycle endpoint PR; it must not be treated as available in an image until that change is released. PD registration and per-group readiness still require separate checks.

Validation: bash dist/validate-links.sh and git diff --check passed.

Summary by CodeRabbit

  • 文档
    • 补充 Store GET /-/lifecycle 接口的说明,包括可能返回的状态及其含义。
    • 明确 STARTED 仅表示 Spring 已触发就绪事件且 gRPC 服务已启动、未关闭,并不代表 Store 已完成 PD 注册、分区恢复或具备图读写能力。
    • 说明接口可用性取决于构建版本;旧版本返回 HTTP 404,不能据此判断 Store 已处于 STARTED 状态。

ASF upstream PR: 🔗 #555

@github-actions

Copy link
Copy Markdown

@codecov-ai-reviewer review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 31, 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-31T05:51:10.996252Z 84ddd99 PR opened
ℹ️ 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 31, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c5d1e716-c236-4378-91cd-9cbb30e7d84a
Commits

Reviewing files that changed from the base of the PR and between e208aa2 and 84ddd99.

Files selected for processing: 2
  • content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md
  • content/en/docs/quickstart/hugegraph/hugegraph-hstore.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

中英文 HStore 文档新增 GET /-/lifecycle 端点及其状态说明。文档说明该端点的构建版本条件、STARTED 的含义与边界,以及旧版 Store 返回 HTTP 404 的行为。

Changes

Store 生命周期文档

层 / 文件 摘要
端点与状态说明
content/cn/docs/quickstart/hugegraph/hugegraph-hstore.md、content/en/docs/quickstart/hugegraph/hugegraph-hstore.md
中英文文档均列出 GET /-/lifecycle,并说明其构建版本条件。文档列出 STARTING、STARTED、STOPPING 和 UNAVAILABLE 状态,说明 STARTED 不代表 PD 注册、分区恢复、Raft 追赶或图读写就绪,并注明旧版 Store 返回 HTTP 404。

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Suggested reviewers: bitflicker64

Merge Risk: Minimal · up to 84ddd

The documentation clarifies that process startup does not guarantee storage readiness and that older versions lack the endpoint. No merge-blocking issue is identified.

Pre-merge checks: Passed 4
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed 标题准确概括了主要变更:区分 Store 进程生命周期与存储就绪状态。该主题与两个文档中的新增说明一致。
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Finishing Touches
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · 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

我是小兔,读到新端点
四种状态排成一列
STARTED 不等于读写就绪
旧版返回 404
文档中英都补全
我竖起耳朵,轻轻点头

This branch has not been deployed

No deployments
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.

1 participant