Skip to content

docs(runbooks): note that credential changes require an API restart #365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SoundMindsAI merged 4 commits into from
Jun 1, 2026
+9 −0
Merged

docs(runbooks): note that credential changes require an API restart #365

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
30bde6f
docs(runbooks): note that credential changes require an API restart
Jah-yee Jun 1, 2026
b19c0f5
fix(docs): capitalize API for consistency
Jah-yee Jun 1, 2026
97cee24
fix(docs): capitalize API in restart command for consistency
Jah-yee Jun 1, 2026
141901b
fix(docs): correct service name api (not API) in docker compose resta…
Jah-yee Jun 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/03_runbooks/solr-cluster-registration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@ defaults, enabling `solr.UBIComponent`, and uploading LTR models.
- BasicAuth credentials stored in `./secrets/cluster_credentials.yaml`
under a `credentials_ref` you'll reference in registration. For local
Solr the install script seeds `local-solr`.

> **Credential edits require an API restart.**
> `cluster_credentials.yaml` is read through a cached `Settings`
> accessor that memoizes its value at process start. If you edit the
> file on a running stack (or run step 5a of `scripts/install.sh` after
> `docker compose up -d`), the API keeps serving the *old* credentials
> until you restart: `docker compose restart api worker`.
> The same caching applies to Elasticsearch and OpenSearch credentials.

- For SolrCloud: the operator-supplied URL must point at a Solr node
that exposes `/admin/zookeeper/status` — the probe uses that
endpoint to auto-detect cloud vs. standalone.
Expand Down