AIFACTORY-FEAT-185: Platform template: the environment stack of a Factory estate, as a real template¶
Generated from the architecture model
This page is rendered from model/**/*.yaml by tools/docs_model during mkdocs build. Edit the YAML, not this page; hand-written design lives on the linked service, platform and plane pages.
A design artefact, not a tracker
This backlog is generated from model/backlog/ and validated against the architecture model. No work item exists in any tracker, and no item carries a date, an estimate or an assignee (ADR-0029).
Epic Ecosystem component extensions · Increment I2 Deliver it · State elaborated · Route devops-engineer · Phase before development · Build order 30 of 185 (Templates and libraries)
Before development
Template or library work: every task of this feature changes a template or a shared library the Factory builds on, and it lands before the Factory's own repositories of I2 are developed. The mark travels with every task (tag phase:before-development).
The platform template repository (connectsoft-platform-template) holds what a whole estate needs and no single service template carries: a Pulumi infrastructure project with an Azure stack and an AWS stack and per-stack configuration (ADR-0004), Kubernetes deployment, service and network-policy manifests, docker-compose files for a local estate and for CI, and the observability stack scripts (OpenTelemetry collector, Prometheus, Grafana) with four pages on configuring, running and debugging it. It is not a template yet: there is no .template.config, the inventory records zero switches, the README is the base template''s scaffold with its TODO markers, the Solution Structure page lists about forty projects the repository does not contain, and the hand-written platform-template page of this site describes a multi-service SaaS generator the repository does not implement. Delivering a generated service to a preview environment and promoting it (I2) needs exactly what the repository holds, bound to the Factory''s infrastructure blueprint and deployment profiles: the environment baseline, the per-service workload manifests, the observability specification and a local estate. Component: Platform template (extend).
| Delivers | — |
| Stubs | — |
| Realizes | components: cmp-platform-template adrs: ADR-0004, ADR-0017, ADR-0018, ADR-0028 |
| Requirements | — |
| Depends on | AIFACTORY-FEAT-157 Base template: the Factory service profileAIFACTORY-FEAT-175 Observability libraries: the Factory telemetry conventions as one registration |
| Sources | model/components.yaml, model/templates.yaml, docs/reference/schemas/blueprint-infrastructure.schema.json, model/services/runtime-cloud/IaCProvisioningService.yaml, ConnectSoft.PlatformTemplate/Docs/README.md, ConnectSoft.PlatformTemplate/Docs/Solution Structure.md, ConnectSoft.PlatformTemplate/Docs/Observability Stack.md, docs/templates-docs/platform-template.md |
AIFACTORY-US-314: Platform template: the repository becomes a packable template with estate parameters, UseFactoryProfile and pages that describe what it contains¶
enabling · persona asset-maintainer
As an asset maintainer, I want the platform template repository to be a template with parameters and honest pages, so that an estate is generated by a command and the inventory can bind every parameter.
The platform template repository holds a Pulumi infrastructure project with an Azure stack and an AWS stack, Kubernetes deployment, service and network-policy manifests, docker-compose files for a local estate and for CI, and the observability stack scripts. It is not a template: it has no template configuration, the inventory of this repository records zero switches for it, its README is the scaffold of the base template with its TODO markers, its Solution Structure page lists projects the repository does not contain, and docs/templates-docs/platform-template.md of this site describes a multi-service generator the repository does not implement. Its Observability Stack page already names two template parameters, ObservabilityStack and ObservabilityBackend, that no configuration defines. This PBI makes the repository a template. It gains a template configuration with the symbols an estate needs: the estate name, the cloud, the deployment profile in the four values of ADR-0017, ObservabilityStack and ObservabilityBackend as the page names them, the list of services to include and the path of the infrastructure blueprint. A template configuration cannot emit a set of files per element of a list parameter, so the list is written by plain replacement into an estate definition file of the generated repository, and the files of each service are written from that file by the generate command AIFACTORY-US-316 defines. The Factory shape is selected by the boolean parameter UseFactoryProfile, off by default, the name every template uses; the later PBIs of this file put the blueprint input and the Factory conventions under it. The repository packs, installs and instantiates like the other templates. The README and the Solution Structure page describe the infrastructure project, the manifests, the compose files and the scripts that exist and drop the scaffold text and the TODO markers. This site corrects its platform template page, and the next inventory writes the parameter snapshot with a Factory binding for every parameter.
Acceptance criteria
| AC1 | Given the repository with its template configuration, when it is packed and installed and an estate is instantiated with an estate name, the Azure cloud, a deployment profile, an observability backend and two services, then the generated repository holds the infrastructure project, the estate definition file that names the two services, the estate generator and the observability files of the chosen backend, and builds (ADR-0028 amendment on scaffolding from published templates; ADR-0017 names the four profiles the parameter offers). |
| AC2 | Given the next template inventory of this repository, when it runs, then model/templates.yaml records a switch count above zero for connectsoft-platform-template, a parameter snapshot exists under model/template-parameters with a Factory binding for every parameter including UseFactoryProfile, and docs/templates-docs/platform-template.md describes what the repository contains and carries no warning about an intended template (ADR-0028). |
| AC3 | Given the pages of the template, when they are compared with the repository, then the README and the Solution Structure page name only projects, folders and scripts that exist, hold no scaffold text of the base template and no TODO markers, and the Observability Stack page names the two parameters with the values the template configuration defines (ADR-0004: the infrastructure project is a Pulumi program; docs/templates-docs/platform-template.md). |
| Traces: adrs | ADR-0004, ADR-0017, ADR-0028 |
| Sources | model/components.yaml, model/templates.yaml, docs/templates-docs/platform-template.md, docs/architecture/adr/0017-deployment-profiles.md, docs/architecture/adr/0028-one-repository-and-deployable-per-service.md |
Tasks
| Task | Kind | Expected output | Repository |
|---|---|---|---|
AIFACTORY-TASK-1361 Template configuration with the estate symbols and UseFactoryProfile |
contract | The repository holds a template configuration with the short name connectsoft-platform-template and symbols for the estate name, the cloud, the deployment profile, ObservabilityStack, ObservabilityBackend, the list of services, the path of the infrastructure blueprint and the boolean UseFactoryProfile, off by default, each with its command-line name, its choices and its description; the list of services is written by replacement into the estate definition file estate.yaml of the generated repository, and the blueprint path seeds the stack configuration key blueprintPath. |
ConnectSoft.PlatformTemplate |
AIFACTORY-TASK-654 A packable template with parameters and its own pages |
implementation | The repository packs, installs and instantiates in its pipeline like the other templates; the symbols gate the files of each cloud and backend, while the files of each service are not template output and are written from the estate definition file by the generate command of AIFACTORY-TASK-1425; the README and the Solution Structure page describe what the repository contains and drop the scaffold text of the base template and the TODO markers; the Observability Stack page names the parameters the configuration defines. | ConnectSoft.PlatformTemplate |
AIFACTORY-TASK-1362 Platform template page of this site and the parameter snapshot with Factory bindings |
documentation | docs/templates-docs/platform-template.md describes the infrastructure project, the manifests, the compose estate and the observability stack of the template and its parameters; after python -I tools/docs_model inventory-templates model/templates.yaml lists the switches and the snapshot under model/template-parameters holds a binding for every parameter. |
ConnectSoft.AI.SoftwareFactory.Documentation |
AIFACTORY-TASK-1363 Verify the instantiation, the inventory and the pages |
verification | Pack and install the template, instantiate an estate of two services and build it; run the inventory and the validator of this repository; the estate builds, model/templates.yaml lists the switches and the pages name only what exists, which proves AC1 to AC3 of AIFACTORY-US-314 (ADR-0028). | ConnectSoft.PlatformTemplate |
AIFACTORY-US-315: Platform template: the Azure Pulumi stack declares the environment baseline, network and data of an estate from the infrastructure blueprint, one store per service¶
enabling · persona asset-maintainer
As an asset maintainer, I want the Azure stack of a generated estate to be driven by the infrastructure blueprint and the deployment profiles, so that the program the provisioning service plans and applies is the one the blueprint describes.
The infrastructure project of the repository holds an Azure stack and an AWS stack with per-stack configuration files and unit tests that run both against Pulumi mocks; the resources are fixed in code. The infrastructure blueprint (docs/reference/schemas/blueprint-infrastructure.schema.json) names the IaC tool, the program path and the stacks, the topology, the region, the resources with their kind, store id and SKU, and the environments with their class and approval flag. IaCProvisioningService keeps a deployment specification per environment that refers to a Pulumi program in Git and applies it; its specification kinds are EnvironmentBaseline, Workload, Network, Data and Observability. This PBI binds the two under UseFactoryProfile. The inputs are named: the blueprint path symbol of the template seeds the stack configuration key blueprintPath of the generated estate, and the services with their store ids come from the estate definition file. The Azure stack reads the blueprint document at that key and the estate definition file and declares three groups of resources that match the specification kinds EnvironmentBaseline, Network and Data: the cluster, registry and identity of the environment, the network with its segments, and the stores. The deployment profile parameter, one of the four of ADR-0017, selects placement, network and secret handling, which is where decision 2 of that ADR confines the differences between profiles. Every store of the blueprint becomes one resource that belongs to exactly one service, as ADR-0028 requires; a store shared by two services is refused at preview. The program takes configuration and secrets by reference only and writes no secret value into a stack file. A preview of a fixture stack runs in the pipeline, and a missing blueprintPath key or a blueprint document that does not validate against the schema fails the preview with the key or the violated rule named. The AWS stack stays in the repository as a sample outside the Factory profile and its tests keep running.
Acceptance criteria
| AC1 | Given an estate generated with UseFactoryProfile and a fixture blueprint that validates against docs/reference/schemas/blueprint-infrastructure.schema.json, when the Azure stack is previewed, then it declares the baseline, network and data resources for the topology, the region, the resources and the environments of the blueprint, and Pulumi is the only engine used (ADR-0004, ADR-0017 decision 4). |
| AC2 | Given a blueprint whose resources name a store for each service, when the stack is previewed, then every store is one resource owned by exactly one service, and a blueprint that assigns one store to two services fails the preview with both services named (ADR-0028: one store per service; model/services/runtime-cloud/IaCProvisioningService.yaml names the specification kinds the three groups match). |
| AC3 | Given a blueprint document that violates the schema, or a stack file that holds a secret value, when the fixture preview runs in the pipeline, then it fails with the violated rule or the offending key named; the AWS stack is generated only outside the Factory profile and its unit tests still pass (ADR-0004, docs/reference/schemas/blueprint-infrastructure.schema.json). |
| Traces: adrs | ADR-0004, ADR-0017, ADR-0028 |
| Depends on | AIFACTORY-US-314 |
| Sources | model/components.yaml, docs/reference/schemas/blueprint-infrastructure.schema.json, model/services/runtime-cloud/IaCProvisioningService.yaml, docs/architecture/adr/0004-pulumi-over-bicep-iac.md, docs/architecture/adr/0017-deployment-profiles.md |
Tasks
| Task | Kind | Expected output | Repository |
|---|---|---|---|
AIFACTORY-TASK-655 Environment baseline from the infrastructure blueprint |
implementation | Under UseFactoryProfile the Azure Pulumi stack reads the infrastructure blueprint (topology, region, resources with store ids and SKUs, environments) at the stack configuration key blueprintPath, which the blueprint path symbol seeds, and the services of the estate definition file, and declares the EnvironmentBaseline, Network and Data resources IaCProvisioningService applies, one store per service as ADR-0028 requires; the deployment profile parameter selects placement, network and secret handling (ADR-0017 decision 2); a missing key fails the preview by name; the AWS stack stays a sample outside the Factory profile; configuration and secrets are references only. |
ConnectSoft.PlatformTemplate |
AIFACTORY-TASK-1364 Fixture blueprints and the fixture stack of the preview |
fixture | The template repository holds a valid fixture blueprint of two services with one store each, a fixture with a shared store, a fixture that violates the schema and a fixture stack file; unit tests against Pulumi mocks assert the declared resources of the valid fixture, and the pipeline previews the fixture stack. | ConnectSoft.PlatformTemplate |
AIFACTORY-TASK-1365 Verify the preview of the valid, the shared-store and the invalid blueprint |
verification | Run pulumi preview --stack fixture --non-interactive for the three fixtures of AIFACTORY-TASK-1364; the valid one lists the baseline, network and data resources, the shared store and the invalid document fail by name, which proves AC1 to AC3 of AIFACTORY-US-315 (ADR-0004, ADR-0028). |
ConnectSoft.PlatformTemplate |
AIFACTORY-US-316: Platform template: deployment, service and network-policy manifests are written per service of the estate definition file by a generate command, with the declared dependencies as the only egress¶
enabling · persona asset-maintainer
As an asset maintainer, I want the Kubernetes manifests of an estate to be generated per included service from what the service declares, so that a service is deployed with the replicas, ports and network reach its model entry states and no more.
The repository holds one deployment manifest, one service manifest and one network-policy manifest under its Kubernetes deployment folder, written for a single placeholder workload. ADR-0028 makes every service its own deployable with a declared replica range, and the model entry of a service names its hosting, its replicas and the services it calls. A template configuration cannot emit a set of files per element of a list parameter, so this PBI names the mechanism. The template instantiates an estate definition file, estate.yaml, that lists the services of the estate, each with its replica range, its ports, its dependencies, its store id and the gateway that fronts it; the list parameter of the template seeds the service names and the entries are completed in that file. The generated repository holds an estate generator with two commands. generate writes the deployment, service and network-policy manifest of every service of the file and writes a file only when its content changed. check regenerates in memory and fails with the file named when a committed output is stale, and with the service and the field named when an entry is incomplete. Under UseFactoryProfile an entry takes the deployment.runtime range and the ports of the service entry of the model, and the liveness and readiness probes point at the health endpoints the base template profile generates. The network policy allows ingress from the gateway that fronts the service and egress only to the dependencies the service declares, to its own store and to the telemetry collector; every other egress is denied, so a call to an undeclared service fails in the cluster and not in a review. The manifests carry configuration and secret references and no value. The pipeline of the template runs the check and validates every generated manifest against the schema of the cluster API, and fails with the manifest and the field named. The manifests are the Workload part of what the provisioning service applies for an environment.
Acceptance criteria
| AC1 | Given an estate whose estate definition file lists two services and a gateway, when the generate command runs, then each service has its own deployment, service and network-policy manifest with the replica range and the ports of its entry and probes on its health endpoints, a second run writes no file, and the check command fails with the file named when an entry changed without a regeneration (ADR-0028 amendment: every service declares its replica range under deployment.runtime; the consequences of ADR-0028 make health and readiness work of every service, provided by the base template; NFR-17). |
| AC2 | Given the generated network policy of a service, when it is inspected, then ingress is allowed from its gateway and egress only to its declared dependencies, its own store and the collector, and a fixture service that calls an undeclared service is denied by the policy test (ADR-0028: every service is its own deployable with its own store; model/components.yaml row of the platform template). |
| AC3 | Given a generated manifest with a field the cluster API does not define, or with a secret value in place of a reference, when the pipeline validates the manifests, then it fails with the manifest and the field named (ADR-0017 decision 2: differences between profiles are confined to placement, network and secrets; model/services/runtime-cloud/IaCProvisioningService.yaml keeps secrets as references). |
| Traces: adrs | ADR-0017, ADR-0028 |
| Relates: nfrs | NFR-17 |
| Depends on | AIFACTORY-US-314, feature:component-base-template-factory-profile |
| Sources | model/components.yaml, model/services/runtime-cloud/IaCProvisioningService.yaml, docs/architecture/adr/0017-deployment-profiles.md, docs/architecture/adr/0028-one-repository-and-deployable-per-service.md |
Tasks
| Task | Kind | Expected output | Repository |
|---|---|---|---|
AIFACTORY-TASK-656 Workload manifests and the observability specification per environment |
implementation | The Kubernetes deployment, service and network-policy manifests of every service of the estate definition file are produced by the generate command of AIFACTORY-TASK-1425 from manifest templates of the repository, with the deployment.runtime range and the ports of the service entry, probes on its health endpoints and its declared dependencies as the only allowed egress, and carry references instead of configuration and secret values; the observability part of this task is delivered by AIFACTORY-TASK-1368 and AIFACTORY-TASK-1369. |
ConnectSoft.PlatformTemplate |
AIFACTORY-TASK-1425 Estate definition file and the generate and check commands of a generated estate |
implementation | The generated repository holds the estate definition file estate.yaml with its schema (per service the replica range, the ports, the dependencies, the store id and the gateway) and an estate generator project with two commands: generate writes the per-service manifests, the scrape configuration and the two compose files from the file and writes only on change; check exits non-zero with the file named on a stale output and with the service and the field named on an incomplete entry. |
ConnectSoft.PlatformTemplate |
AIFACTORY-TASK-1366 Manifest schema validation and the network policy test in the pipeline |
fixture | The pipeline of the template runs the check command of the estate generator, validates every generated manifest against the schema of the cluster API and runs a policy test over a fixture estate in which one service calls an undeclared service; a stale output, an invalid field, a secret value or an allowed undeclared egress fails the run with the file named. | ConnectSoft.PlatformTemplate |
AIFACTORY-TASK-1367 Verify the per-service manifests, the egress rule and the validation |
verification | Instantiate the fixture estate of two services and a gateway, run the generate and the check command, validate the manifests and run the policy test; each service has its three manifests, a second generation writes nothing, a stale output fails the check, the undeclared call is denied and the planted manifest fails by name, which proves AC1 to AC3 of AIFACTORY-US-316 (ADR-0028). | ConnectSoft.PlatformTemplate |
AIFACTORY-US-317: Platform template: the collector, Prometheus and Grafana files become the observability specification of an environment, and a compose estate runs the included services locally and in CI¶
enabling · persona asset-maintainer
As an asset maintainer, I want the observability stack and the local estate of the template to be generated for the services and the backend of the estate, so that every environment and every developer machine observes the services on the same conventions.
The repository carries the observability stack as scripts and compose files for an OpenTelemetry collector with Prometheus and Grafana, Jaeger, an ELK stack and Seq, and five pages on the stack, its configuration, its local setup and its debugging. The Observability Stack page describes a collector mode, in which every service sends its telemetry to one collector endpoint that routes it to the backends, and a direct export mode it calls legacy. The repository also holds a compose file for a local estate and one for CI. This PBI turns both into generated parts of an estate. The collector configuration, with one pipeline per signal and the exporters of the chosen backends, and the dashboards are template output gated by ObservabilityStack and ObservabilityBackend. The scrape configuration and the compose estate hold one entry per service, so they are written by the generate command of the estate generator from the estate definition file and covered by its check. Under UseFactoryProfile the collector mode is the only mode, the collector keeps the scope and run attributes the single registration of the observability libraries writes, and a processor drops any attribute outside the allow list of the conventions, so that a payload attribute a service emitted by mistake does not reach a backend; decision 3 of ADR-0019 allows no raw prompt, response or tool output in telemetry. The compose estate is assembled from the services of the file, their stores and the collector with the chosen backend, in the two existing variants for local runs and for CI. The pages are corrected to the generated files, and the direct export mode is described as unavailable under the profile.
Acceptance criteria
| AC1 | Given an estate instantiated with the collector mode and one backend, when the estate is generated, then it holds a collector configuration with a pipeline per signal and the exporter of that backend, a scrape configuration with one target per service of the estate definition file and the dashboards, and no file of a backend that was not chosen (the consequences of ADR-0028 make telemetry wiring work of every service, provided by the base template; NFR-17; model/components.yaml row of the platform template). |
| AC2 | Given an estate generated with UseFactoryProfile, when a fixture service emits a span with the scope attributes of the conventions and one attribute outside the allow list, then the collector forwards the scope attributes and drops the other, and a generation that asks for the direct export mode is refused (docs/architecture/adr/0019-data-governance.md decision 3: no raw prompt, response or tool output in telemetry; ADR-0028). |
| AC3 | Given the generated compose estate, when it is started locally and in the CI variant, then the services of the estate definition file, their stores and the collector start, each service reports ready and its telemetry is visible in the chosen backend; the observability pages of the template name the generated files (ADR-0028: each service has its own store in the estate; NFR-17). |
| Traces: adrs | ADR-0028 |
| Relates: nfrs | NFR-17 |
| Depends on | AIFACTORY-US-314, feature:component-observability-factory-conventions |
| Sources | model/components.yaml, model/templates.yaml, docs/architecture/adr/0019-data-governance.md, docs/architecture/adr/0028-one-repository-and-deployable-per-service.md, docs/architecture/ecosystem-composition.md |
Tasks
| Task | Kind | Expected output | Repository |
|---|---|---|---|
AIFACTORY-TASK-1368 Observability specification generated from the stack and backend parameters |
implementation | The collector configuration and the dashboards of an estate are template output gated by ObservabilityStack and ObservabilityBackend, and the scrape configuration is written by the generate command of AIFACTORY-TASK-1425 with one target per service of the estate definition file; under UseFactoryProfile only the collector mode is generated and a processor keeps the scope and run attributes of the conventions and drops attributes outside their allow list. |
ConnectSoft.PlatformTemplate |
AIFACTORY-TASK-1369 Compose estate assembled from the included services for local runs and CI |
implementation | The two compose files of the deployment folder are written by the generate command of AIFACTORY-TASK-1425 from the services of the estate definition file with their stores, the collector and the chosen backend; the CI variant starts without interactive ports and waits for the readiness of every service. | ConnectSoft.PlatformTemplate |
AIFACTORY-TASK-1370 Observability pages of the template corrected to the generated files |
documentation | The five observability pages of the template describe the generated collector configuration, the backends by parameter value, the compose estate and the debugging steps, and state that the direct export mode is unavailable under the Factory profile. | ConnectSoft.PlatformTemplate |
AIFACTORY-TASK-1371 Verify the generated specification, the attribute allow list and the compose estate |
verification | Instantiate the fixture estate with the profile, run the generate command, start its CI compose variant, emit the fixture span and query the backend; the services report ready, the scope attributes arrive and the attribute outside the allow list does not, which proves AC1 to AC3 of AIFACTORY-US-317 (NFR-17, docs/architecture/adr/0019-data-governance.md). | ConnectSoft.PlatformTemplate |
AIFACTORY-US-318: Platform template: a fixture estate is provisioned, deployed, observed ready and destroyed in a preview stage before the template package publishes¶
evidence · persona asset-maintainer
As an asset maintainer, I want every change of the platform template to be gated by an estate it provisions and deploys from the packed candidate, so that a template package that would produce an environment that does not come up never reaches the feed.
This PBI is the gate of the feature. A template that generates infrastructure cannot be proven by a build alone, so its generated-solution gate is a preview environment. The candidate is packed once and installed, and a fixture estate of two services and a gateway is instantiated with UseFactoryProfile. The two services are generated from the base template with its Factory profile and the gateway from the API gateway template connectsoft-apigateway with its Factory profile, so the estate deploys what the Factory deploys. The generate and check commands of the estate generator run, the generated solution is built and its unit tests run against Pulumi mocks. In the preview stage of the pipeline the Azure stack of the estate is previewed and applied to a disposable environment, the generated manifests are applied to its cluster, and the readiness of each service is observed through the collector of the estate: every service reports ready and its readiness signal carries the attributes of the conventions. The estate is destroyed at the end of the stage whether the observation passed or failed, and a destroy that leaves a resource fails the run with the resource named. A case that fails any stage fails the run with the stage named, and the publication stage is not reached. Publication pushes the template package to the ConnectSoft feed with a version that is not yet on the feed. A planted fixture whose service never reports ready proves that the gate stops the run. This is an evidence PBI: a template feature has no scenario, so the gate names what it proves through traces.adrs and its sources.
Acceptance criteria
| AC1 | Given a change of the template, when its pipeline runs, then the candidate is packed once and installed, the fixture estate of two services and a gateway is instantiated with UseFactoryProfile, built and tested, its Azure stack is applied to a disposable environment, its manifests are applied and each service is observed ready through the collector (ADR-0028 amendment on scaffolding from published templates; ADR-0004: the stack is applied by Pulumi). |
| AC2 | Given a service of the estate never reports ready, or any stage fails, when the pipeline evaluates the run, then the run fails with the stage named, the estate is destroyed all the same, a resource left behind fails the run with its name, and the publication stage is not reached; a planted fixture proves the refusal (the consequences of ADR-0028 make health and readiness work of every service; NFR-17; model/backlog/epics.yaml states the gate as the completion of the epic). |
| AC3 | Given the preview stage is green and the estate is destroyed, when the publication stage runs, then the template package is pushed to the ConnectSoft feed with a version that is not on the feed and a repeated version is refused with the reason (ADR-0028, docs/architecture/catalogs/templates.md keeps the row of the template). |
| Traces: adrs | ADR-0004, ADR-0028 |
| Relates: nfrs | NFR-17 |
| Depends on | AIFACTORY-US-314, AIFACTORY-US-315, AIFACTORY-US-316, AIFACTORY-US-317, feature:component-base-template-factory-profile, feature:component-api-gateway-template |
| Sources | model/components.yaml, model/backlog/epics.yaml, docs/architecture/catalogs/templates.md, docs/architecture/adr/0028-one-repository-and-deployable-per-service.md |
Tasks
| Task | Kind | Expected output | Repository |
|---|---|---|---|
AIFACTORY-TASK-1372 Preview stage of the template pipeline with an unconditional destroy |
operations | The pipeline of the template packs once, installs the candidate, instantiates and builds the fixture estate, applies its Azure stack to a disposable environment, applies the manifests, waits for the readiness of each service through the collector and destroys the estate in a step that always runs; the publication stage depends on the preview stage and refuses a version that is already on the feed. | ConnectSoft.PlatformTemplate |
AIFACTORY-TASK-1373 Fixture estate of two services and a gateway, and a planted service that never reports ready |
fixture | The template repository holds the fixture estate definition with two services generated from the base template with its Factory profile and a gateway generated from connectsoft-apigateway with its Factory profile, and a planted variant whose second service fails its readiness probe; the planted run asserts that the run fails at the observation step, that the estate is destroyed and that publication is not reached. |
ConnectSoft.PlatformTemplate |
AIFACTORY-TASK-657 Preview-environment gate |
verification | One green run and one planted run of the gate: a fixture estate of two services and a gateway is provisioned from the generated stack in the preview stage of the pipeline, the manifests are applied, the readiness of each service is observed through the collector and the estate is destroyed; the template package publishes only when the gate passes, which proves AC1 to AC3 of AIFACTORY-US-318 (ADR-0028, NFR-17). | ConnectSoft.PlatformTemplate |
AIFACTORY-US-124: Platform template: the environment stack of a Factory estate, as a real template is delivered and proven on a generated solution¶
enabling · persona asset-maintainer
As an asset maintainer, I want Platform template to carry the environment stack of a Factory estate, as a real template, so that it serves environment baseline, workload manifests, observability specification and local estate of a Factory estate and of a generated product without later rework.
This is the integration PBI of the feature. An asset maintainer packs the platform template with its template configuration, the blueprint-driven Azure stack, the estate definition file with its generate and check commands, the per-service manifests, the generated observability specification and the compose estate, installs the package and runs the preview-environment gate in the pipeline. The fixture estate is provisioned, deployed, observed ready and destroyed before the template package is allowed to publish; a stage that fails stops the run and blocks publication. The implementation lives in the earlier PBIs of this file; this PBI proves them together on the estate shape the Factory needs when it delivers a generated service to a preview environment and promotes it. From the published package an estate is generated with UseFactoryProfile from a fixture infrastructure blueprint, for the one region the workload baseline of ADR-0018 assumes. Its preview lists the baseline, network and data resources of the blueprint with one store per service, its manifests validate against the cluster API, its compose estate starts with every service ready, and its collector forwards the scope attributes and no payload. The feature is done when that estate is generated from a fresh install of the published package. Repository of the feature: ConnectSoft.PlatformTemplate.
Acceptance criteria
| AC1 | Given the template repository ConnectSoft.PlatformTemplate with the work of this feature, when the template is packed, installed and instantiated in its pipeline, then the generated solution builds, its tests pass and the preview-environment gate is green before the package publishes with a verified version (ADR-0028, model/components.yaml). |
| AC2 | Given the work of AIFACTORY-TASK-654 (a packable template with parameters and its own pages) is done, then the repository has a template configuration with the symbols an estate needs and UseFactoryProfile, packs, installs and instantiates, appears in the parameter snapshot under model/template-parameters with a Factory binding per parameter, and its pages and docs/templates-docs/platform-template.md describe what the repository contains (ADR-0028). |
| AC3 | Given the work of AIFACTORY-TASK-655 (environment baseline from the infrastructure blueprint) is done, then the Azure Pulumi stack reads the infrastructure blueprint at its stack configuration key and the services of the estate definition file, under a deployment profile that is one of the four of ADR-0017, and declares the baseline, network and data resources the provisioning service applies, one store per service as ADR-0028 requires, the AWS stack stays a sample outside the Factory profile, and a fixture preview fails on a document that violates docs/reference/schemas/blueprint-infrastructure.schema.json (ADR-0004). |
| AC4 | Given the work of AIFACTORY-TASK-656 (workload manifests and the observability specification per environment) is done, then the deployment, service and network-policy manifests are written per service of the estate definition file by the generate command, with the deployment.runtime range and the ports of the service entry and its declared dependencies as the only egress, and validated against the cluster API, the collector, Prometheus and Grafana files are the generated observability specification of the environment, and a compose estate is assembled from the services of the file (ADR-0028, NFR-17). |
| AC5 | Given the work of AIFACTORY-TASK-657 (preview-environment gate) is done, then a fixture estate of two services and a gateway is provisioned in the preview stage, deployed, observed ready through the collector and destroyed, and the template package publishes to the ConnectSoft feed only when the gate passes (ADR-0028, NFR-17, docs/architecture/catalogs/templates.md). |
| Traces: adrs | ADR-0004, ADR-0017, ADR-0018, ADR-0028 |
| Relates: nfrs | NFR-17 |
| Depends on | AIFACTORY-US-314, AIFACTORY-US-315, AIFACTORY-US-316, AIFACTORY-US-317, AIFACTORY-US-318 |
| Sources | model/components.yaml, model/templates.yaml, docs/reference/schemas/blueprint-infrastructure.schema.json, model/services/runtime-cloud/IaCProvisioningService.yaml, docs/templates-docs/platform-template.md |
Tasks
| Task | Kind | Expected output | Repository |
|---|---|---|---|
AIFACTORY-TASK-1374 Generate a Factory estate from the published package and a fixture blueprint |
verification | A probe installs the published template package, generates an estate with UseFactoryProfile from the fixture infrastructure blueprint, builds it, previews its Azure stack, validates its manifests and starts its CI compose variant; the run proves AC2 to AC4 of AIFACTORY-US-124 on the published package (ADR-0004, ADR-0028). |
ConnectSoft.PlatformTemplate |
AIFACTORY-TASK-687 Verify platform-template-environment-stack-delivered by running the declared command |
verification | Run dotnet build -c Release and pulumi preview --stack fixture --non-interactive on the authoring solution and on the fixture estate after the published package is installed, and take the green run of the preview-environment gate of AIFACTORY-TASK-657 with its apply and destroy; they pass and prove AC1 to AC5 of AIFACTORY-US-124. |
ConnectSoft.PlatformTemplate |