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.

Blueprint

class cstar.orchestration.models.Blueprint(*, name: Annotated[str, StringConstraints(strip_whitespace=True, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None, ascii_only=None)], description: Annotated[str, StringConstraints(strip_whitespace=True, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None, ascii_only=None)], application: str, state: BlueprintState = BlueprintState.NotSet, schema_version: str = '1.0.0', working_dir: WithJsonSchema(json_schema={'type': 'string'}, mode=serialization)] = PosixPath('.'), **extra_data: Any)

Bases: ConfiguredBaseModel, ABC

Common elements of all blueprints.

Methods

Blueprint.serialize_with_schema_ref(handler, ...)

Attributes

Blueprint.cpus_needed	The number of CPUs needed to run this blueprint.
Blueprint.name	A unique, user-friendly name for this blueprint.
Blueprint.description	A user-friendly description of the scenario to be executed by the blueprint.
Blueprint.application	The process type to be executed by the blueprint.
Blueprint.state	The current validation status of the blueprint.
Blueprint.schema_version	The schema version for the document.
Blueprint.working_dir	Path to a directory where assets are stored when executing the blueprint.