Repository navigation
docs: correct the quick start, monitoring commands, backend count and design index - #668
Open
LeeroyHannigan wants to merge 1 commit into
Open
LeeroyHannigan wants to merge 1 commit into
LeeroyHannigan wants to merge 1 commit into
Conversation
LeeroyHannigan
requested review from
amrith,
c33howard,
jcshepherd,
pdf-amzn,
robinnsc and
yesyayen
as code owners
October 29, 2026 23:59
… design index The README quick start ran aws dynamodb list-tables without credentials, and the AWS CLI stopped with "Unable to locate credentials". The quick start now reads the default account's ID with extenddb manage list-accounts, creates an IAM user, attaches a policy that allows DynamoDB, creates an access key, and exports the key before the request. init prints the admin password but not the account ID. A key this server did not issue gets UnrecognizedClientException, so configured AWS credentials do not help. /metrics requires admin HTTP Basic auth and answers 401 without it. The metrics commands in the README, the admin guide and the event ticketing demo now pass the admin credentials, and the deployment guide's monitoring checklist says the poller needs them. The demo's metrics and console URLs had **18443** as the port, which curl refuses, so the asterisks are removed. The storage design status line said PostgreSQL is the only supported backend. It now names the four backends in crates/: PostgreSQL, SQLite, MongoDB and Cassandra. #412 made the same correction to the README crate list and the architecture guide overview. The design index linked version 2.0 of the auth design, which 05-component-auth-v3.md supersedes. The index row now links version 3 and names version 2.0 as superseded. The Linux and macOS install manuals and the MongoDB setup page also run list-tables before any access key exists. #523 removes those pages. Refs #663
LeeroyHannigan
force-pushed
the
docs/launch-prep-corrections
branch
from
October 31, 2026 22:14
b3c747a to
34a0dbf
Compare
This was referenced Nov 1, 2026
This branch has not been deployed
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
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.
What changed
This branch fixes the four documentation problems #663 lists. The quick start
problem also appears in pages that #523 removes; those pages are left to that
PR and named under the quick start item.
README quick start
The quick start ran
aws dynamodb list-tablesright afterserve. Requestsmust be signed with an access key this server issued, and nothing in the quick
start created one, so the AWS CLI stopped with
Unable to locate credentials(exit 255). A reader who already has AWS credentials configured gets
UnrecognizedClientExceptioninstead, because the server does not know thosekeys.
The quick start now reads the default account's ID with
extenddb manage list-accounts, becauseinitprints the admin password butnot the account ID. It then creates an IAM user, attaches a policy that allows
dynamodb:*, creates an access key for the user withextenddb manage, andsets
AWS_ACCESS_KEY_IDandAWS_SECRET_ACCESS_KEYto theaccess_key_idand
secret_access_keythatcreate-access-keyprints. These are the admincommands
docs/local-dev-docker-compose.mdalready uses.The Linux and macOS install manuals and the MongoDB setup page also run
list-tableswith no key. #523 removes those pages, and itsdocs/install-from-source.mdcreates the key before the first request.Monitoring commands
/metricsrequires an admin user's name and password as HTTP Basic auth andanswers 401
Missing Authorization headerwithout them. Thecurlcommandsin the README, the admin guide and the event ticketing demo sent none. They now
pass
-u admin:<password>(the demo reads theEXTENDDB_ADMIN_PASSWORDitexports in step 3), and the deployment guide's monitoring checklist says the
poller needs the admin credentials. Step 13 of the demo also wrote the port as
**18443**inside a code block. curl refuses that URL (exit 3), so theasterisks are removed from both URLs in that step.
/health,extenddb statusandextenddb healthcheckwork as written and areunchanged.
Backend count
The storage design's status line ("PostgreSQL is the only supported backend")
named PostgreSQL as the only backend. It now names the four backends in
crates/: PostgreSQL, SQLite, MongoDB and Cassandra. No support tiers areadded; #662 covers those.
This branch first made the same correction to the README crate list and the
architecture guide overview ("currently PostgreSQL"). #412 corrected both on
mainbefore this branch was rebased, so the rebased commit keepsmain'stext there and no longer changes
docs/manuals/01-architecture-guide.md.Design index
docs/design/README.mdlinked version 2.0 of the auth design(
05-component-auth.md). Version 3 (05-component-auth-v3.md) states that itsupersedes version 2.0. The index row now links version 3 and links version 2.0
as superseded.
How it was measured
The measurements ran on a release build of
mainat 817b240 (cargo build --release -p extenddb, the PostgreSQL backend) against PostgreSQL 16 in acontainer, in a clean
HOMEand an environment with no AWS settings.initwas given the container's host and port, and the server listened on port 15740
in place of 18443; the other commands ran as the docs write them.
aws dynamodb list-tablesUnable to locate credentials, exit 255{"TableNames": []}, exit 0curl ... /metrics(README, admin guide)Missing Authorization headercurl ... | python3 -m json.toolcurl ... | python3 -c ...JSONDecodeErrorcurl ... /healthThe corrected quick start then ran end to end in a fresh
HOMEagainst a freshdatabase, and
list-tablesreturned an empty table list. The AWS CLI on thebuild host is 1.18.147; the docs name version 2, which was not run.
After the rebase onto
f49c5f823, the quick start ran again on 2026-10-31,from
inittolist-tables, with a SQLite build of1c0523c9(
init --backend sqlite). That commithas the same
initandextenddb managecode asf49c5f823.initprintedthe admin password and no account ID,
list-accountsprinted the defaultaccount, and
create-user,put-user-policyandcreate-access-keyexited 0.The quick start's last command,
aws dynamodb list-tables --endpoint-url https://127.0.0.1:18443 --region us-east-1,returned
{"TableNames": []}with exit 0.Testing
tests/cli/test-doc-consistency.shreports the same 110 failures onmain(
f49c5f823) and on this branch.cargo test --release -p extenddb-storage-postgres --test doc_version_literalspassed (3 tests). The workspace tests in CI run it onthis branch.
The change is documentation only. No Rust, workflow or test file changes.
Overlap with the open docs PRs
After the rebase this branch no longer changes the architecture guide. Its
commit applies without conflicts on top of the current heads of #491, #523,
#530 and #666.
Refs #663