Skip to content

Quick start for the inner-loop demo; fix its PV-write smoke test; refresh integration README - #116

Merged
Anubhuti Sinha (anubhutisinha04) merged 4 commits into
NSLS2:mainfrom
sligara7:fix/inner-loop-writes-integration-readme
Aug 7, 2026
Merged

Quick start for the inner-loop demo; fix its PV-write smoke test; refresh integration README#116
Anubhuti Sinha (anubhutisinha04) merged 4 commits into
NSLS2:mainfrom
sligara7:fix/inner-loop-writes-integration-readme

Conversation

@sligara7

Copy link
Copy Markdown
Collaborator

Verified against a fresh checkout of main brought up with the root docker-compose stack.

Compose fix

The README's second smoke-test command (POST /api/v1/pv/set) was rejected because direct_control_service defaults to read-only and the root compose never opted in to writes — every integration pod already sets DIRECT_CONTROL_GLOBAL_READ_ONLY: "false". The inner-loop stack now does the same (it only talks to the simulated IOC). Both smoke commands verified passing: the write returns success: true and reads back 3.14.

Root README

  • Minimal numbered quick start (clone → compose up → open :8004/docs and :8003/docs → compose down) for pointing people at the interactive API docs.
  • Note that shared-schema/ must be writable by container uid 1000 — the backends export their OpenAPI schemas there at startup and exit if the write is denied.

integration/README.md refresh

The file predated half of the current tree:

  • Documents all six pods — standalone/, with-queueserver/ and profile-seeded/ were missing entirely (with-queueserver was still described as future roadmap).
  • Fixes the full-pod IOC count (7, not 5) and notes its opt-in frontend profile.
  • Drops the stale claim that localdevs.py is "not mounted into any container yet" — every compose surface mounts it.
  • Lists the newer exercisers (direct_control_standalone.sh, queueserver_api_compat.py, _exerciser_lib.sh) plus happi/runtime_seed.json and profile_collections/test_collection/.
  • Removes the stale dev-pod device-count arithmetic.

direct_control_service defaults to read-only, so the README's PV-write
smoke test was rejected. Opt in to writes like every integration pod does.
Document all six pods (standalone, with-queueserver and profile-seeded were
missing), fix the full-pod IOC count, drop the stale 'localdevs is not
mounted' claim, list the newer exercisers, and trim the shipped queueserver
pod out of the roadmap.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates developer-facing documentation and compose defaults to reflect the expanded integration pod set (including queueserver and standalone modes) and to make the root compose stack write-enabled for simulated IOC development.

Changes:

  • Expanded integration/README.md to document new pod surfaces, shared assets, and exercisers (including queueserver compatibility).
  • Enabled DIRECT_CONTROL_GLOBAL_READ_ONLY=false in the root docker-compose.yml for local simulated-IOC usage.
  • Added a root README “Quick start” and documented the shared-schema/ write-permissions requirement.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
integration/README.md Rewrites and expands integration environment docs to cover new pods, queueserver, and exercisers.
docker-compose.yml Changes default direct-control behavior to allow writes in the local stack.
README.md Adds quick start steps and documents a common failure mode (schema export directory permissions).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docker-compose.yml
Comment thread README.md Outdated
@anubhutisinha04
Anubhuti Sinha (anubhutisinha04) merged commit 7930454 into NSLS2:main Aug 7, 2026
9 checks passed
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.

3 participants