Attention

This project is still in an early phase of development.

The python API is not yet stable, and some aspects of the schema for the blueprint and workplan will likely evolve. Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility. We expect to reach a more stable version in 2026.

BlueprintRunner

class cstar.entrypoint.runner.BlueprintRunner(request: RunnerRequest[TBlueprint], service_cfg: ServiceConfiguration, job_cfg: JobConfig)

Bases: Service, XRunner[TBlueprint]

A service that executes a blueprint.

Methods

BlueprintRunner.acknowledge_hc()	Confirm any requests for an update from the health check queue.
BlueprintRunner.add_state(status[, errors])	Create a RunnerResult instance and store the value.
BlueprintRunner.execute()	Execute the complete service lifecycle.
BlueprintRunner.run()	Execute the application.

Attributes

BlueprintRunner.CMD_HEARTBEAT
BlueprintRunner.MIN_HCF
BlueprintRunner.blueprint	Return the deserialized blueprint instance.
BlueprintRunner.blueprint_uri	Return the URI of the blueprint to run.
BlueprintRunner.can_shutdown	Determine if the service is ready to shut down.
BlueprintRunner.is_healthcheck_queue_ready	Determine if the healthcheck queue is available.
BlueprintRunner.is_healthcheck_running	Determine if the healthcheck thread is running.
BlueprintRunner.log	Return the logger instance for this class.
BlueprintRunner.request	Return the request containing configuration for executing the application.
BlueprintRunner.result	Return the runner result object used to record state transitions of the executing blueprint.
BlueprintRunner.state	Return the current state of the application.