Repository navigation
Document subordinate backends in the administration guide - #1302
Conversation
maximthomas
left a comment
There was a problem hiding this comment.
praise: The chapter clearly distinguishes creating an empty subordinate backend from migrating an existing branch.
subordinate-backends-createexplains that registering a base DN does not populate the backend.subordinate-backends-migratewarns that registration does not move existing data and requires separate parent and child datasets.
issue (blocking): The chapter presents subordinate proxy backends as an available use case, but this revision ships no configurable directory-server proxy backend.
opendj-doc-generated-ref/src/main/asciidoc/admin-guide/chap-subordinate-backends.adoc:41, :83, :88, :90
Normal backend startup and creation reach BackendConfigManager.registerBackend(), which accepts only LocalBackend implementations and otherwise throws RuntimeException("registerBackend() is not yet supported for proxy backend."). The configuration test explicitly records that the proxy backend is absent from this codebase; the standalone SDK proxy example is not a directory-server backend. Although custom LocalBackend implementations are possible, the documented topology cannot be configured using the shipped backends. Please remove the proxy-specific recommendation and operational references, including the concluding link, or identify the separate implementation required and state that it is not included in this server.
|
Addressed in 4ec5924. The subordinate-backends chapter now uses an LDIF parent with two PDB children and one disposable Memory child, and its operational guidance no longer presents proxy backends as available. I also replaced the proxy example in the existing LDIF chapter and removed the corresponding proxy references from the Memory chapter. The former LDIF section anchor remains available for existing links. Validation: the xref checker verified 12 file references in the subordinate-backends chapter, Asciidoctor rendered both LDIF section anchors, and |
maximthomas
left a comment
There was a problem hiding this comment.
praise: The LDIF/PDB/Memory example separates persistent and disposable data, explains migration hazards, and preserves the former LDIF section anchor.
Document how subordinate backends divide a directory tree, when to use them, and how to create a backend or plan an existing branch migration. Cover search, replication, backup, indexing, and availability considerations.
Use a local example with an LDIF parent, two persistent PDB child backends, and a disposable Memory child backend. Update the existing LDIF and Memory chapters to describe supported local backends instead of presenting a proxy backend as available. Preserve the former LDIF section anchor for existing links.
Validation:
git diff --checkpassed.