aps-peas-prototype

Consolidated sbt/npm project for the TMT APS PEAS prototype suite.

Components

ICD name	sbt project ID	Directory	What it is
ApsSequencerScripts	apsSequencerScripts / apsSequencerScriptsRunner	aps-sequencer-scripts/	Kotlin ESW sequencer scripts + Scala runner
PeasComputationAssembly	peasComputationAssembly	peas-computation-assembly/assembly	CSW assembly wrapping the APS Algorithm Library
PeasComputationDeploy	peasComputationDeploy	peas-computation-assembly/deploy	Container/host-config apps for deploying the assembly
(test client, no ICD name)	peasComputationClient	peas-computation-assembly/client	Standalone CLI client for sending test commands to the assembly
PeasProcedureDataService	peasProcedureDataService	peas-procedure-data-service/	jOOQ/Postgres-backed procedure data storage service
PeasProcedureSetupService	peasProcedureSetupService	peas-procedure-setup-service/	HTTP backend for building/submitting sequences
PeasWebApplication	(npm, not sbt)	peas-web-application/	React/TypeScript frontend
PeasExposureService	peasExposureService	peas-exposure-service/	New placeholder service (health-check stub only so far)

peas-web-application is a decoupled npm project (sibling to the sbt build, not wired into it) -- build and run it independently with npm.

The scripts/ directory holds the auth/config setup scripts referenced in the Startup Guide below (setup-tmt-auth.sh, setup-config.sh, generate-testmode-sequence.py), carried over from the original aps-submitter-prototype repo root with paths updated for the new structure.

CSW/ESW Prerequisites for Running Components

We recommend using coursier for installing and running the apps. Steps for installing coursier are documented here.

The CSW services (Location, Config, Event, Alarm, Database, and AAS) need to be running before starting any component in this project:

cs install csw-services
csw-services start --auth

Note: csw-services version should be compatible with the csw.version / esw.version properties in project/build.properties and the dependency versions in project/Libs.scala. You can refer to the ESW-to-CSW version compatibility table here.

You can run csw-services --help / csw-services start --help for more information.

Startup Guide

This is the complete order of operations to get every component running together locally - Run all commands from this repo's root (aps-peas-prototype/) unless otherwise noted.

Important: Keycloak and the Config Service reset on every csw-services restart. Steps 2 and 7 must be repeated each time.

Before starting any app, set the following environment variables:

• TMT_LOG_HOME - directory location where CSW can log to
• INTERFACE_NAME=en0 - set to primary machine's interface name
• PUBLIC_INTERFACE_NAME=en0
• AAS_INTERFACE_NAME=en0

To set environment variables, use export <ENV_VAR>=<VALUE>.

1. Start CSW Services

csw-services start --location --auth --config --event

Note: if using the Procedure Data Service (default) add "--database"

2. Run Auth Setup Script

Must be run after every csw-services restart and before starting the ESW Gateway.

./scripts/setup-tmt-auth.sh

Expected output:

==> Getting admin token...
    OK
==> Creating tmt-backend-app client...
    OK
==> Getting tmt-frontend-app client UUID...
    OK (UUID: ...)
==> Adding tmt-backend-app audience mapper to tmt-frontend-app...
    OK
==> Getting esw-user1 user ID...
    OK (UUID: ...)
==> Getting aps-user role ID...
    OK (UUID: ...)
==> Assigning aps-user role to esw-user1...
    OK

Auth setup complete. You can now start the ESW Gateway.

3. Start ESW Gateway

cat > /tmp/command-role-mapping.conf << 'EOF'
APS.primary.startSequence: [aps-user]
EOF

esw-gateway-server start -p 8090 -l -c /tmp/command-role-mapping.conf

4. Start APS Sequencers, ICS Sequencer and PIT Sequencer

Run each command on a separate terminal tab for visibility and debugging

 sbt "apsSequencerScriptsRunner/run sequencer -s APS -n peasA -m apsPeasSequencerA_ApsStandaloneMode"

 sbt "apsSequencerScriptsRunner/run sequencer -s APS -n peasB -m apsPeasSequencerB_ApsStandaloneMode"

 sbt "apsSequencerScriptsRunner/run sequencer -s APS -n peasC -m apsPeasSequencerC_ApsStandaloneMode"

 sbt "apsSequencerScriptsRunner/run sequencer -s APS -n peasD -m apsPeasSequencerD_ApsStandaloneMode"

For the ICS Sequencer, replace "_IcsSimulator" with "IcsOperational" to communicate with ICS assemblies

 sbt "apsSequencerScriptsRunner/run sequencer -s APS -n icsSequencer  -m icsSequencer_IcsSimulator"

For the PIT Sequencer, replace "_PitSimulator" with "PitOperational" to communicate with ICS assemblies

 sbt "apsSequencerScriptsRunner/run sequencer -s APS -n pitSequencer  -m pitSequencer_PitSimulator"

5. Start Procedure Setup Service

sbt "peasProcedureSetupService/run start --port 8085"

6. Start Web Application

Perform install first time running or whenever code has changed

cd peas-web-application
npm install

Run React front-end

cd peas-web-application
npm start

7. Load Sequence Data into Config Service

Must be run after every csw-services restart (Config Service resets too).

./scripts/setup-config.sh

8. Start the Computation Assembly (Optional)

sbt "peasComputationDeploy/runMain peas.computationdeploy.ComputationDeployContainerCmdApp --local ./peas-computation-assembly/deploy/src/main/resources/JComputationAssemblyStandalone.conf"

9. Start the Procedure Data Service (Optional)

DB_READ_USERNAME=admin DB_READ_PASSWORD=Zernike1 DB_WRITE_USERNAME=admin DB_WRITE_PASSWORD=Zernike1 sbt "peasProcedureDataService/run start -p 8084"

Note: these credentials are carried over verbatim from the original README and match what's committed in peas-procedure-data-service/jooq-codegen.xml (also flagged in MIGRATION.md). Worth rotating at some point, consolidation or not.

10. Use the App

1. Open http://localhost:3000
2. Log in with esw-user1 / esw-user1
3. Click Load
4. Change any configuration options available on screen
5. Click Build Sequence
6. Click Start

Startup Guide Notes

• The Keycloak admin UI at http://localhost:8081 only shows the master realm. The TMT realm must be managed via the API -- the setup-tmt-auth.sh script handles this.
• Predefined TMT realm users (password = username): esw-user1, config-admin1, config-user1, iris-user1, tcs-user1, wfos-user1
• The Config Service resets on csw-services restart -- sequence files must be re-uploaded each time.
• Why tmt-backend-app must be created manually: the ESW Gateway's application.conf references this client for token validation, but the embedded Keycloak from csw-services does not include it by default. This appears to be a gap in the development tooling.

Other component-specific details

For anything beyond the startup sequence above (route/impl structure, API details, etc.), see each component's own README:

• peas-procedure-setup-service/README.md
• peas-procedure-data-service/README.md
• peas-computation-assembly/README.md
• peas-exposure-service (port 8086, via PEAS_EXPOSURE_SERVICE_PORT)
• peas-web-application/README.md

Migration notes

See MIGRATION.md for the record of what was renamed/moved during consolidation from the four original repos, and what's still unverified (dependency resolution, build verification, a plaintext credential that predates this migration).