score-spec/spec
Spec
Score is a platform-agnostic workload specification standard that defines containerized application deployments and their resource dependencies in a declarative YAML format. It provides a developer-centric specification that separates environment-agnostic workload definitions from environment-specific configuration, enabling consistent deployment across development, testing, and production environments.
The specification framework translates a single workload definition into deployable manifests for multiple container orchestration platforms, including Docker Compose and Kubernetes. It includes schema-driven validation to catch configuration errors before deployment, placeholder-based dynamic resolution for referencing workload metadata and resource outputs, and a pluggable provisioner architecture that maps abstract resource declarations to concrete provisioning implementations. Score also supports patch template customization for modifying generated manifests, stateful pipeline persistence to preserve stable values across clean-slate CI environments, and environment-specific overrides that allow the same workload file to work unchanged across targets.
Score automatically provisions and connects backing services like databases, caches, and DNS based on workload dependency declarations, and can generate local mock services for testing frontends against simulated APIs. It provides CLI tools for manifest generation, project initialization, provisioner management, and version control, with support for containerized execution in Dev Containers. The project includes community provisioners for common infrastructure components and can extend to new platforms through custom workload translators and provisioners.
Features
- Workload Specification Implementations - Collects and validates YAML workload files, provisions resources, and converts workloads into deployment manifests.
- Workload Definitions - Declares workload API version, metadata, and name in a platform-agnostic format.
- Platform-Agnostic Workload Specifications - Defines application deployment requirements in a platform-agnostic YAML format separating environment-agnostic from environment-specific configuration.
- Workload Metadata Placeholder Resolutions - Resolves placeholder references to workload metadata and resource outputs within container variables, files, and volumes.
- Provisioner Loading Architectures - Loads provisioners from local files, HTTP, Git, or OCI registries with configurable priority ordering for extensibility.
- Declarative Database Connectors - Declares database dependencies in workload specs so the platform automatically provisions and links the service.
- Declarative Database Provisioners - Declares database dependencies in workload specs so the platform automatically provisions and connects them.
- Shared Resource Provisioners - Automatically creates and connects shared dependencies like DNS and databases across multiple workloads.
- Schema Validators - Validates workload files against a JSON schema and applies implementation-specific checks before deployment.
- Per-Environment Overrides - Applies environment-specific overrides so the same workload file works unchanged across targets.
- Dynamic Variable Interpolations - Uses placeholder syntax to reference workload metadata or resource outputs within container variables and files.
- Workload Configuration Separators - Separates environment-agnostic workload definitions from environment-specific overrides for consistent configuration.
- Workload Configuration Separators - Separates environment-agnostic workload definitions from environment-specific parameters for consistent configuration.
- Deployment Manifest Generators - Accepts files with overrides and image defaults, provisions resources, and produces final manifests in an additive, idempotent manner.
- Workload Spec Provisioners - Automatically creates required backing services like databases when deploying workload definitions.
- Container Configuration - Specifies container image, command, arguments, environment variables, files, volumes, compute resources, and health probes.
- Docker Compose Deployments - Produces Docker Compose files from workload specifications and runs workloads with mocked dependencies locally.
- Docker Compose Generators - Converts platform-agnostic workload specs into deployable Docker Compose files with resource provisioning.
- Workload Spec Converters - Translates platform-agnostic workload specs into Docker Compose files for local development.
- Containerized Application Deployments - Describes and deploys multi-service applications to local or Kubernetes environments from a single config.
- Workload Translators - Translates workload specifications into any container runtime or platform format.
- Workload Resource Dependency Declarations - Declares relationships between workloads and dependent resources in an environment-agnostic way.
- Resource Type Provisioner Definitions - Defines concrete implementations of resource types referenced in workload specifications.
- Workload-to-Compose Translators - Converts platform-agnostic workload definitions into Docker Compose files for local development and testing.
- Multi-Platform Manifest Generators - Generates both Docker Compose and Kubernetes manifests from a single workload specification.
- Multi-Platform Manifest Translators - Translates a single workload specification into deployable manifests for Docker Compose, Kubernetes, or other target platforms.
- Workload Manifest Translators - Converts declarative workload specifications into deployable manifests for multiple container orchestration platforms.
- Workload-to-Kubernetes Translators - Converts platform-agnostic workload definitions into Kubernetes manifests for deployment to clusters.
- Workload Spec Provisioners - Generates manifests or executes scripts to provision databases, caches, and networking from workload specs.
- Multi-Service Application Definitions - Defines each containerized service in separate YAML files, specifying dependencies and network exposure for multi-service applications.
- Declarative Resource Provisioning Abstractions - Maps abstract resource declarations to concrete provisioning implementations that create and connect infrastructure services like databases and DNS.
- Kubernetes Resource Manifests - Generates Kubernetes resource manifests from platform-agnostic workload specifications.
- Workload Spec Converters - Converts platform-agnostic workload specs into deployable Kubernetes manifests with resource provisioning.
- Workload-to-Kubernetes Translators - Converts workload specifications into Kubernetes manifests for cluster deployment.
- Automated Resource Provisioning - Automatically creates cloud resources based on project configuration manifests.
- Declarative Workload Descriptions - Defines workload runtime requirements in a platform-agnostic YAML file.
- Single-Source Workload Definitions - Defines workload configuration once in a platform-agnostic file for multiple orchestration platforms.
- Workload Specification Generators - Defines application deployment configuration in a platform-agnostic YAML format.
- Workload YAML Definitions - Describes application configuration in a platform-agnostic YAML format.
- Workload Manifest Converters - Transforms validated workloads into deployment manifests, resolving placeholders and injecting secrets.
- Workload Specification Validators - Validates YAML workload files against a JSON schema to catch structural errors before deployment.
- Deployment Platform Translators - Translates workload specifications into native formats for any deployment platform.
- Fly.io Deployers - Generates Fly.io deployment configurations from workload specifications with resource provisioner support.
- Schema Validators - Validates workload files against a formal JSON schema to catch configuration errors before deployment.
- Workload Configuration Linters - Highlights schema violations in workload configuration files directly in the IDE.
- Provisioner Output Sharers - Passes resource outputs like hostnames and passwords between workloads through placeholder resolution.
- Provisioner Installers from Remote Sources - Downloads and installs provisioner files from HTTP, Git, OCI registries, or local files.
- Local Development Service Provisioners - Automatically provisions dedicated instances of databases and other services for local development environments.
- State-Carrying Pipeline Integrations - Downloads and re-uploads state files between CI pipeline runs so generated values remain stable across clean-slate environments.
- Multi-Environment Pipeline Orchestrations - Combines implementations into CI/CD pipelines to test and deploy workloads across different environments.
- Dapr StateStore Deployers - Deploys containerized applications using Dapr StateStore backed by Redis from declarative workload descriptions.
- Build Context Image Builders - Builds container images from local directories using specified build contexts during manifest generation.
- Workload Spec Generators - Generates Azure Container Apps configuration files from platform-agnostic workload specifications.
- Mock Service Generators - Generates Docker Compose files with mocked dependencies for local testing without real backends.
- Self-Hosted Mock Backends - Declares mock service dependencies so workloads can develop and test against simulated APIs without a real backend.
- Docker Compose Generators - Converts specification files into a combined Docker Compose file, resolving all resources and workload links.
- Compose Output Patchers - Applies JSON patches to generated Docker Compose files to modify or extend their content.
- Custom Provisioner Frameworks - Allows users to write custom provisioners using Go templates or external commands for new resource types.
- Kubernetes Application Deployments - Applies generated manifests to provision and run containerized applications on Kubernetes.
- Kubernetes Deployment - Applies generated Kubernetes manifests to a cluster for workload deployment.
- Patch Template Customizers - Score applies patch templates to the generated Kubernetes manifests, allowing users to override or extend the default output.
- Community Provisioner Libraries - Provides a library of pre-built provisioners for common infrastructure components like Redis and DNS.
- Local Kubernetes Clusters - Translates workload specs into Kubernetes resources and applies them to local Kind clusters.
- Manifest Patching - Applies JSON patches to generated manifests using Go templates, allowing users to override or extend default output.
- Workload Orchestration - Accepts defined workloads and resources directly into platform orchestrators for unified deployment management.
- Workload Port Exposures - Defines network ports with public and target configurations to expose containerized workloads to external applications.
- OpenAPI Endpoint Resolutions - Declares backend service dependencies via OpenAPI specs for automatic endpoint resolution during deployment.
- CI Pipeline State Persistences - Stores generated identifiers and resource outputs on disk between pipeline runs to preserve stable values across clean-slate CI environments.
- Deployment State Persistences - Stores generated secrets, port assignments, and resource outputs on disk so repeated deployments reuse stable values instead of re-randomizing them.
- Workload Integration Testers - Validates workload specifications and resource provisioning by launching workloads with dependencies in CI pipelines.
- Local Mock Service Generators - Generates realistic local mock services from declared backend specs for frontend testing without real backends.
- Continuous Delivery and GitOps - Specification for application configuration files.
