[Guide] Add document lifecycle guide#2017
Merged
reta merged 3 commits intoJun 26, 2026
Merged
Conversation
lsh1215
force-pushed
the
docs/431-document-lifecycle
branch
3 times, most recently
from
41f0b7d to
4e03048
Compare
Constraint: Issue opensearch-project#431 asks for a Java document lifecycle guide similar to the Ruby guide while matching existing Java guide conventions. Rejected: Guide-only snippets | A runnable sample keeps the documented examples compileable and Docker-verified. Rejected: Repository-order CI workaround in this PR | It fixed a transient upstream Maven 503 but widened the guide-focused review scope. Confidence: high Scope-risk: narrow Directive: Keep guide snippets aligned with DocumentLifecycle when changing lifecycle examples. Tested: git diff --check Tested: ./gradlew :samples:compileJava :samples:spotlessJavaCheck Tested: Docker Compose OpenSearch 3.2.0 health green; PASSWORD=0_aD^min_0 ./gradlew :samples:run -Dsamples.mainClass=DocumentLifecycle Not-tested: Full repository test suite Signed-off-by: sanghun <vitash1215@gmail.com>
lsh1215
force-pushed
the
docs/431-document-lifecycle
branch
from
4e03048 to
b4dcaf9
Compare
lsh1215
requested review from
Bukhtawar,
VachaShah,
Xtansia,
madhusudhankonda,
reta,
saratvemulapalli and
szczepanczykd
as code owners
reta
reviewed
Jun 26, 2026
reta
reviewed
Jun 26, 2026
reta
reviewed
Jun 26, 2026
reta
reviewed
Jun 26, 2026
reta
reviewed
Jun 26, 2026
reta
reviewed
Jun 26, 2026
reta
reviewed
Jun 26, 2026
reta
reviewed
Jun 26, 2026
Collaborator
|
Thanks you @lsh1215 , a few minor comments, LGTM otherwise! |
Constraint: Maintainer review requested wording, heading, and setup-style adjustments in guides/document_lifecycle.md. Rejected: Changing the runnable sample | The review feedback targeted guide phrasing, and the sample still compiles unchanged. Confidence: high Scope-risk: narrow Directive: Keep the guide TOC anchors synchronized with section heading changes. Tested: git diff --check Tested: ./gradlew :samples:compileJava :samples:spotlessJavaCheck Not-tested: Full repository test suite Signed-off-by: sanghun <vitash1215@gmail.com>
Contributor
Author
|
Thanks for the review, @reta. I applied your suggestions in 9955e6d. I also updated the TOC anchors to stay in sync with the renamed sections. The current CI failures look unrelated to this docs change. The failing jobs are failing during Gradle dependency resolution because |
Contributor
Author
|
Separately, if this keeps recurring, it may be worth considering a follow-up build hardening change so public Maven artifacts resolve from Maven Central before the OpenSearch snapshot repository is queried. |
reta
reviewed
Jun 26, 2026
Constraint: Maintainer review requested DocumentLifecycle.java to match the setup snippet already applied in guides/document_lifecycle.md. Rejected: Reintroducing SampleClient.create | The review suggestion asks for the explicit HttpHost transport setup. Confidence: high Scope-risk: narrow Directive: Keep sample setup aligned with guide setup code. Tested: git diff --check Tested: ./gradlew :samples:compileJava :samples:spotlessJavaCheck Tested: OPENSEARCH_VERSION=3.2.0 SECURE_INTEGRATION=false docker compose --project-directory .ci/opensearch up -d --build; ./gradlew :samples:run -Dsamples.mainClass=DocumentLifecycle; docker compose down Not-tested: Full repository test suite Signed-off-by: sanghun <vitash1215@gmail.com>
reta
approved these changes
Jun 26, 2026
|
The backport to |
Collaborator
@lsh1215 could you please backport it to |
Contributor
Author
|
@reta Sure, I’ll open a manual backport PR to the 3.x branch. Thank you. |
Contributor
Author
reta
added a commit
that referenced
this pull request
Jun 26, 2026
* [Guide] Add document lifecycle guide (#2017) * Make document lifecycle guidance verifiable for Java users Constraint: Issue #431 asks for a Java document lifecycle guide similar to the Ruby guide while matching existing Java guide conventions. Rejected: Guide-only snippets | A runnable sample keeps the documented examples compileable and Docker-verified. Rejected: Repository-order CI workaround in this PR | It fixed a transient upstream Maven 503 but widened the guide-focused review scope. Confidence: high Scope-risk: narrow Directive: Keep guide snippets aligned with DocumentLifecycle when changing lifecycle examples. Tested: git diff --check Tested: ./gradlew :samples:compileJava :samples:spotlessJavaCheck Tested: Docker Compose OpenSearch 3.2.0 health green; PASSWORD=0_aD^min_0 ./gradlew :samples:run -Dsamples.mainClass=DocumentLifecycle Not-tested: Full repository test suite Signed-off-by: sanghun <vitash1215@gmail.com> * Align document lifecycle guide with review wording Constraint: Maintainer review requested wording, heading, and setup-style adjustments in guides/document_lifecycle.md. Rejected: Changing the runnable sample | The review feedback targeted guide phrasing, and the sample still compiles unchanged. Confidence: high Scope-risk: narrow Directive: Keep the guide TOC anchors synchronized with section heading changes. Tested: git diff --check Tested: ./gradlew :samples:compileJava :samples:spotlessJavaCheck Not-tested: Full repository test suite Signed-off-by: sanghun <vitash1215@gmail.com> * Align document lifecycle sample setup with guide Constraint: Maintainer review requested DocumentLifecycle.java to match the setup snippet already applied in guides/document_lifecycle.md. Rejected: Reintroducing SampleClient.create | The review suggestion asks for the explicit HttpHost transport setup. Confidence: high Scope-risk: narrow Directive: Keep sample setup aligned with guide setup code. Tested: git diff --check Tested: ./gradlew :samples:compileJava :samples:spotlessJavaCheck Tested: OPENSEARCH_VERSION=3.2.0 SECURE_INTEGRATION=false docker compose --project-directory .ci/opensearch up -d --build; ./gradlew :samples:run -Dsamples.mainClass=DocumentLifecycle; docker compose down Not-tested: Full repository test suite Signed-off-by: sanghun <vitash1215@gmail.com> --------- Signed-off-by: sanghun <vitash1215@gmail.com> (cherry picked from commit 354ff2e) Signed-off-by: sanghun <vitash1215@gmail.com> * Switch to SampleClient.create() Signed-off-by: Andriy Redko <drreta@gmail.com> --------- Signed-off-by: sanghun <vitash1215@gmail.com> Signed-off-by: Andriy Redko <drreta@gmail.com> Co-authored-by: Andriy Redko <drreta@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
guides/document_lifecycle.mdguide covering create, index, get, source filtering, mget, exists, update, script update, update by query, reindex, delete, delete by query, and cleanup.DocumentLifecyclesample that mirrors the guide and asserts each operation against OpenSearch.ResponseExceptionandOpenSearchExceptionpaths.CHANGELOG.mdentry for the new guide and sample.Closes #431.
Validation
git diff --check./gradlew :samples:compileJava :samples:spotlessJavaCheckPASSWORD=0_aD^min_0 ./gradlew :samples:run -Dsamples.mainClass=DocumentLifecycleNot run