{ "$id": "https://raw.githubusercontent.com/architect-team/architect-cli/main/src/dependency-manager/schema/architect.schema.json", "title": "Schema for architect.yml. See: https://docs.architect.io/reference/architect-yml", "$schema": "http://json-schema.org/draft-07/schema", "properties": { "name": { "type": "string", "pattern": "^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?[\\w][\\w\\.-]{0,127}))?$", "errorMessage": "must contain only lower alphanumeric and single hyphens in the middle; max length 32", "description": "Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": { "type": "string", "description": "A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for." }, "keywords": { "type": "array", "items": { "anyOf": [ { "type": "string" } ] }, "description": "Additional search terms to be used when the component is indexed so that others can find it more easily." }, "author": { "type": "string", "description": "The name or handle of the author of the component as a developer contact." }, "homepage": { "type": "string", "description": "The url that serves as the informational homepage of the component (i.e. a github repo)." }, "secrets": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/SecretDefinitionSpec" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec", "additionalProperties": false }, "outputs": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/OutputDefinitionSpec" }, { "type": "null" } ] }, "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/OutputDefinitionSpec" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.", "additionalProperties": false } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.", "additionalProperties": false }, "databases": { "type": "object", "patternProperties": { "^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?[\\w][\\w\\.-]{0,127}))?$": { "anyOf": [ { "type": "string", "pattern": "^[\\w][\\w\\.-]{0,127}$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } }, { "$ref": "#/definitions/DependencySpec" } ] } }, "errorMessage": { "additionalProperties": "must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": "A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)", "additionalProperties": false }, "interfaces": { "type": "object", "patternProperties": { "^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?[\\w][\\w\\.-]{0,127}))?$", "errorMessage": "must contain only lower alphanumeric and single hyphens in the middle; max length 32", "description": "Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": { "type": "string", "description": "A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for." }, "keywords": { "type": "array", "items": { "anyOf": [ { "type": "string" } ] }, "description": "Additional search terms to be used when the component is indexed so that others can find it more easily." }, "author": { "type": "string", "description": "The name or handle of the author of the component as a developer contact." }, "homepage": { "type": "string", "description": "The url that serves as the informational homepage of the component (i.e. a github repo)." }, "secrets": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/SecretDefinitionSpec" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec", "additionalProperties": false }, "outputs": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/OutputDefinitionSpec" }, { "type": "null" } ] }, "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/OutputDefinitionSpec" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.", "additionalProperties": false } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.", "additionalProperties": false }, "databases": { "type": "object", "patternProperties": { "^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?[\\w][\\w\\.-]{0,127}))?$": { "anyOf": [ { "type": "string", "pattern": "^[\\w][\\w\\.-]{0,127}$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } }, { "$ref": "#/definitions/DependencySpec" } ] } }, "errorMessage": { "additionalProperties": "must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": "A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)", "additionalProperties": false }, "interfaces": { "type": "object", "patternProperties": { "^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?: (e.g. postgres:13)" }, "connection_string": { "anyOf": [ { "format": "uri", "type": "string" }, { "type": "null" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The connection uri of an existing database to use instead of provisioning a new one" } }, "type": "object", "required": [ "type" ], "description": "Component databases let you quickly spin up a database for your service", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#databasespec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "description": { "type": "string", "description": "Human readable description" }, "type": { "type": "string", "anyOf": [ { "type": "string", "enum": [ "postgres:10", "postgres:11", "postgres:12", "postgres:13", "postgres:14", "postgres:15", "mysql:5", "mysql:6", "mysql:7", "mysql:8", "mariadb:10" ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The type engine and version of database software needed for data storage.", "errorMessage": "must be of the format : (e.g. postgres:13)" }, "connection_string": { "anyOf": [ { "format": "uri", "type": "string" }, { "type": "null" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The connection uri of an existing database to use instead of provisioning a new one" } }, "type": "object", "required": [ "type" ], "description": "Component databases let you quickly spin up a database for your service", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#databasespec" }, "patternProperties": {} } ] } } }, "SecretDefinitionSpec": { "properties": { "required": { "type": "boolean", "description": "Denotes whether the secret is required." }, "description": { "type": "string", "description": "A human-friendly description of the secret." }, "default": { "anyOf": [ { "anyOf": [ { "type": "array" }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" }, { "type": "null" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Sets a default value for the secret if one is not provided" } }, "type": "object", "description": "Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#secretdefinitionspec" } }, "LivenessProbeSpec": { "properties": { "success_threshold": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The number of times to retry a health check before the container is considered healthy.", "default": 1 }, "failure_threshold": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The number of times to retry a failed health check before the container is considered unhealthy.", "default": 3 }, "timeout": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s", "default": "5s" }, "interval": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The time period in seconds between each health check execution. You may specify any value between: 5s and 300s", "default": "30s" }, "initial_delay": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Delays the check from running for the specified amount of time", "default": "0s" }, "path": { "deprecated": true, "anyOf": [ { "type": "string", "pattern": "^\\/.*$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "[Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set)." }, "command": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ], "description": "Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set)." }, "port": { "deprecated": true, "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "[Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set)." } }, "type": "object", "allOf": [ { "oneOf": [ { "type": "object", "required": [ "command" ] }, { "type": "object", "required": [ "path", "port" ] } ] }, { "not": { "type": "object", "required": [ "command", "port" ] } }, { "not": { "type": "object", "required": [ "command", "path" ] } } ], "description": "Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#livenessprobespec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "success_threshold": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The number of times to retry a health check before the container is considered healthy.", "default": 1 }, "failure_threshold": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The number of times to retry a failed health check before the container is considered unhealthy.", "default": 3 }, "timeout": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s", "default": "5s" }, "interval": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The time period in seconds between each health check execution. You may specify any value between: 5s and 300s", "default": "30s" }, "initial_delay": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Delays the check from running for the specified amount of time", "default": "0s" }, "path": { "deprecated": true, "anyOf": [ { "type": "string", "pattern": "^\\/.*$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "[Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set)." }, "command": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ], "description": "Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set)." }, "port": { "deprecated": true, "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "[Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set)." } }, "type": "object", "allOf": [ { "oneOf": [ { "type": "object", "required": [ "command" ] }, { "type": "object", "required": [ "path", "port" ] } ] }, { "not": { "type": "object", "required": [ "command", "port" ] } }, { "not": { "type": "object", "required": [ "command", "path" ] } } ], "description": "Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#livenessprobespec" }, "patternProperties": {} } ] } } }, "VolumeSpec": { "properties": { "mount_path": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Directory at which the volume will be mounted inside the container." }, "host_path": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set)." }, "key": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).", "externalDocs": { "url": "https://docs.architect.io/components/services/#volumes" } }, "description": { "type": "string", "description": "Human-readable description of volume" }, "readonly": { "anyOf": [ { "type": "boolean" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Marks the volume as readonly.", "default": false } }, "type": "object", "not": { "type": "object", "required": [ "host_path", "key" ] }, "errorMessage": { "not": "Only one of host_path, key is allowed, or none should exist" }, "description": "Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#volumespec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "mount_path": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Directory at which the volume will be mounted inside the container." }, "host_path": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set)." }, "key": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).", "externalDocs": { "url": "https://docs.architect.io/components/services/#volumes" } }, "description": { "type": "string", "description": "Human-readable description of volume" }, "readonly": { "anyOf": [ { "type": "boolean" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Marks the volume as readonly.", "default": false } }, "type": "object", "not": { "type": "object", "required": [ "host_path", "key" ] }, "errorMessage": { "not": "Only one of host_path, key is allowed, or none should exist" }, "description": "Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#volumespec" }, "patternProperties": {} } ] } } }, "BuildSpec": { "properties": { "context": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path to the directory containing the source code relative to the `architect.yml` file." }, "buildpack": { "type": "boolean", "description": "Option to use buildpack to build an image." }, "args": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_]+$": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "type": "object", "patternProperties": { "^[a-zA-Z0-9_]+$": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": "Build args to be passed into `docker build`.", "additionalProperties": false } ] } }, "errorMessage": { "additionalProperties": "must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": "Build args to be passed into `docker build`.", "additionalProperties": false }, "dockerfile": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path to the Dockerfile relative to the `build.context`", "default": "Dockerfile" }, "target": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The stage to build in the Dockerfile" } }, "type": "object", "description": "An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.", "not": { "type": "object", "required": [ "buildpack", "dockerfile" ] }, "errorMessage": { "not": "Only one of buildpack, dockerfile is allowed, or none should exist" }, "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#buildspec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "context": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path to the directory containing the source code relative to the `architect.yml` file." }, "buildpack": { "type": "boolean", "description": "Option to use buildpack to build an image." }, "args": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_]+$": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "type": "object", "patternProperties": { "^[a-zA-Z0-9_]+$": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": "Build args to be passed into `docker build`.", "additionalProperties": false } ] } }, "errorMessage": { "additionalProperties": "must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": "Build args to be passed into `docker build`.", "additionalProperties": false }, "dockerfile": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path to the Dockerfile relative to the `build.context`", "default": "Dockerfile" }, "target": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The stage to build in the Dockerfile" } }, "type": "object", "description": "An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.", "not": { "type": "object", "required": [ "buildpack", "dockerfile" ] }, "errorMessage": { "not": "Only one of buildpack, dockerfile is allowed, or none should exist" }, "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#buildspec" }, "patternProperties": {} } ] } } }, "IngressTlsSpec": { "properties": { "crt": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Custom certificate." }, "key": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Custom certificate key." }, "ca": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Custom certificate ca." } }, "type": "object", "required": [ "crt", "key" ], "description": "Configuration for custom certificate.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#ingresstlsspec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "crt": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Custom certificate." }, "key": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Custom certificate key." }, "ca": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Custom certificate ca." } }, "type": "object", "required": [ "crt", "key" ], "description": "Configuration for custom certificate.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#ingresstlsspec" }, "patternProperties": {} } ] } } }, "IngressSpec": { "properties": { "enabled": { "type": "boolean", "description": "Marks the interface as an ingress." }, "subdomain": { "anyOf": [ { "type": "string", "pattern": "^([A-Za-z0-9](?:[A-Za-z0-9\\-]{0,61}[A-Za-z0-9])|[^\\W\\D\\s\\t\\n\\r\\/]+|[\\@\\*]?)$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.", "errorMessage": "must contain alphanumeric characters ([a-z0-9A-Z]), could contain dashes (-) and alphanumerics between." }, "tls": { "$ref": "#/definitions/IngressTlsSpec" }, "path": { "anyOf": [ { "type": "string", "pattern": "^\\/.*$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path of the interface used for path based routing" }, "ip_whitelist": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string", "format": "cidrv4" }, { "type": "string", "pattern": "\\${{\\s*secrets\\.[\\w-]+\\s*}}" } ] } }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}|(?:\\d{1,3}\\.){3}\\d{1,3}(?:\\/\\d\\d?)?,?", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}, or a comma-delimited list of cidr/ip addresses ex 8.8.8.8,8.8.4.4/24" } } ], "description": "IP addresses that are allowed to access the interface" }, "private": { "anyOf": [ { "type": "boolean" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Marks the ingress as private behind Architect authentication" } }, "type": "object", "description": "An ingress exposes an interface to external network traffic through an architect-deployed gateway.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#ingressspec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "enabled": { "type": "boolean", "description": "Marks the interface as an ingress." }, "subdomain": { "anyOf": [ { "type": "string", "pattern": "^([A-Za-z0-9](?:[A-Za-z0-9\\-]{0,61}[A-Za-z0-9])|[^\\W\\D\\s\\t\\n\\r\\/]+|[\\@\\*]?)$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.", "errorMessage": "must contain alphanumeric characters ([a-z0-9A-Z]), could contain dashes (-) and alphanumerics between." }, "tls": { "$ref": "#/definitions/IngressTlsSpec" }, "path": { "anyOf": [ { "type": "string", "pattern": "^\\/.*$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path of the interface used for path based routing" }, "ip_whitelist": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string", "format": "cidrv4" }, { "type": "string", "pattern": "\\${{\\s*secrets\\.[\\w-]+\\s*}}" } ] } }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}|(?:\\d{1,3}\\.){3}\\d{1,3}(?:\\/\\d\\d?)?,?", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}, or a comma-delimited list of cidr/ip addresses ex 8.8.8.8,8.8.4.4/24" } } ], "description": "IP addresses that are allowed to access the interface" }, "private": { "anyOf": [ { "type": "boolean" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Marks the ingress as private behind Architect authentication" } }, "type": "object", "description": "An ingress exposes an interface to external network traffic through an architect-deployed gateway.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#ingressspec" }, "patternProperties": {} } ] } } }, "ScalingMetricsSpec": { "properties": { "cpu": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The cpu usage required to trigger scaling.", "externalDocs": { "url": "https://docs.architect.io/components/services/#cpu--memory" } }, "memory": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The memory usage required to trigger scaling.", "externalDocs": { "url": "https://docs.architect.io/components/services/#cpu--memory" } } }, "type": "object", "anyOf": [ { "type": "object", "required": [ "cpu" ] }, { "type": "object", "required": [ "memory" ] } ], "description": "Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#scalingmetricsspec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "cpu": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The cpu usage required to trigger scaling.", "externalDocs": { "url": "https://docs.architect.io/components/services/#cpu--memory" } }, "memory": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The memory usage required to trigger scaling.", "externalDocs": { "url": "https://docs.architect.io/components/services/#cpu--memory" } } }, "type": "object", "anyOf": [ { "type": "object", "required": [ "cpu" ] }, { "type": "object", "required": [ "memory" ] } ], "description": "Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#scalingmetricsspec" }, "patternProperties": {} } ] } } }, "ScalingSpec": { "properties": { "min_replicas": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The target minimum number of service replicas." }, "max_replicas": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The target maximum number of service replicas." }, "metrics": { "$ref": "#/definitions/ScalingMetricsSpec" } }, "type": "object", "required": [ "min_replicas", "max_replicas", "metrics" ], "description": "Configuration that dictates the scaling behavior of a service.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#scalingspec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "min_replicas": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The target minimum number of service replicas." }, "max_replicas": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The target maximum number of service replicas." }, "metrics": { "$ref": "#/definitions/ScalingMetricsSpec" } }, "type": "object", "required": [ "min_replicas", "max_replicas", "metrics" ], "description": "Configuration that dictates the scaling behavior of a service.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#scalingspec" }, "patternProperties": {} } ] } } }, "KubernetesDeploySpec": { "properties": { "deployment": {} }, "type": "object", "required": [ "deployment" ], "description": "Configuration that dictates the kubernetes deploy overrides.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#kubernetesdeployspec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "deployment": {} }, "type": "object", "required": [ "deployment" ], "description": "Configuration that dictates the kubernetes deploy overrides.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#kubernetesdeployspec" }, "patternProperties": {} } ] } } }, "DeploySpec": { "properties": { "kubernetes": { "$ref": "#/definitions/KubernetesDeploySpec" } }, "type": "object", "required": [ "kubernetes" ], "description": "Configuration that dictates the deploy overrides.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#deployspec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "kubernetes": { "$ref": "#/definitions/KubernetesDeploySpec" } }, "type": "object", "required": [ "kubernetes" ], "description": "Configuration that dictates the deploy overrides.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#deployspec" }, "patternProperties": {} } ] } } }, "ServiceInterfaceSpec": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A human-readable description of the interface." }, "host": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host." }, "port": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Port on which the service is listening for traffic." }, "protocol": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Protocol that the interface responds to", "default": "http" }, "username": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A Basic Auth username required to access the interface" }, "password": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A Basic Auth password required to access the interface" }, "path": { "anyOf": [ { "type": "string", "pattern": "^\\/.*$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path of the interface" }, "url": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url." }, "sticky": { "anyOf": [ { "anyOf": [ { "type": "boolean" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Denotes that if this interface is made external, the gateway should use sticky sessions", "default": false }, "ingress": { "$ref": "#/definitions/IngressSpec" } }, "type": "object", "required": [ "port" ], "oneOf": [ { "type": "object", "required": [ "port" ] }, { "type": "object", "required": [ "url" ] } ], "description": "A service interface exposes service functionality over the network to other services within the same component. If you would like to expose services on the network to external components, see the ComponentInterfaceSpec", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#serviceinterfacespec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A human-readable description of the interface." }, "host": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host." }, "port": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Port on which the service is listening for traffic." }, "protocol": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Protocol that the interface responds to", "default": "http" }, "username": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A Basic Auth username required to access the interface" }, "password": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A Basic Auth password required to access the interface" }, "path": { "anyOf": [ { "type": "string", "pattern": "^\\/.*$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path of the interface" }, "url": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url." }, "sticky": { "anyOf": [ { "anyOf": [ { "type": "boolean" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Denotes that if this interface is made external, the gateway should use sticky sessions", "default": false }, "ingress": { "$ref": "#/definitions/IngressSpec" } }, "type": "object", "required": [ "port" ], "oneOf": [ { "type": "object", "required": [ "port" ] }, { "type": "object", "required": [ "url" ] } ], "description": "A service interface exposes service functionality over the network to other services within the same component. If you would like to expose services on the network to external components, see the ComponentInterfaceSpec", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#serviceinterfacespec" }, "patternProperties": {} } ] } } }, "ServiceSpec": { "properties": { "enabled": { "type": "boolean", "description": "Determines if the service should be running.", "default": true }, "debug": { "$ref": "#/definitions/_DebugServiceSpec" }, "interfaces": { "type": "object", "patternProperties": { "^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?[\\w][\\w\\.-]{0,127}))?$", "errorMessage": "must contain only lower alphanumeric and single hyphens in the middle; max length 32", "description": "Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": { "type": "string", "description": "A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for." }, "keywords": { "type": "array", "items": { "anyOf": [ { "type": "string" } ] }, "description": "Additional search terms to be used when the component is indexed so that others can find it more easily." }, "author": { "type": "string", "description": "The name or handle of the author of the component as a developer contact." }, "homepage": { "type": "string", "description": "The url that serves as the informational homepage of the component (i.e. a github repo)." }, "secrets": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/SecretDefinitionSpec" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec", "additionalProperties": false }, "outputs": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/OutputDefinitionSpec" }, { "type": "null" } ] }, "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/OutputDefinitionSpec" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.", "additionalProperties": false } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.", "additionalProperties": false }, "databases": { "type": "object", "patternProperties": { "^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?[\\w][\\w\\.-]{0,127}))?$": { "anyOf": [ { "type": "string", "pattern": "^[\\w][\\w\\.-]{0,127}$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } }, { "$ref": "#/definitions/DependencySpec" } ] } }, "errorMessage": { "additionalProperties": "must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": "A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)", "additionalProperties": false }, "interfaces": { "type": "object", "patternProperties": { "^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?[\\w][\\w\\.-]{0,127}))?$", "errorMessage": "must contain only lower alphanumeric and single hyphens in the middle; max length 32", "description": "Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": { "type": "string", "description": "A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for." }, "keywords": { "type": "array", "items": { "anyOf": [ { "type": "string" } ] }, "description": "Additional search terms to be used when the component is indexed so that others can find it more easily." }, "author": { "type": "string", "description": "The name or handle of the author of the component as a developer contact." }, "homepage": { "type": "string", "description": "The url that serves as the informational homepage of the component (i.e. a github repo)." }, "secrets": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/SecretDefinitionSpec" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec", "additionalProperties": false }, "outputs": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/OutputDefinitionSpec" }, { "type": "null" } ] }, "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/OutputDefinitionSpec" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.", "additionalProperties": false } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.", "additionalProperties": false }, "databases": { "type": "object", "patternProperties": { "^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?[\\w][\\w\\.-]{0,127}))?$": { "anyOf": [ { "type": "string", "pattern": "^[\\w][\\w\\.-]{0,127}$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } }, { "$ref": "#/definitions/DependencySpec" } ] } }, "errorMessage": { "additionalProperties": "must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": "A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)", "additionalProperties": false }, "interfaces": { "type": "object", "patternProperties": { "^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?: (e.g. postgres:13)" }, "connection_string": { "anyOf": [ { "format": "uri", "type": "string" }, { "type": "null" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The connection uri of an existing database to use instead of provisioning a new one" } }, "type": "object", "description": "Component databases let you quickly spin up a database for your service", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#databasespec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "description": { "type": "string", "description": "Human readable description" }, "type": { "type": "string", "anyOf": [ { "type": "string", "enum": [ "postgres:10", "postgres:11", "postgres:12", "postgres:13", "postgres:14", "postgres:15", "mysql:5", "mysql:6", "mysql:7", "mysql:8", "mariadb:10" ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The type engine and version of database software needed for data storage.", "errorMessage": "must be of the format : (e.g. postgres:13)" }, "connection_string": { "anyOf": [ { "format": "uri", "type": "string" }, { "type": "null" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The connection uri of an existing database to use instead of provisioning a new one" } }, "type": "object", "description": "Component databases let you quickly spin up a database for your service", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#databasespec" }, "patternProperties": {} } ] } } }, "_DebugSecretDefinitionSpec": { "properties": { "required": { "type": "boolean", "description": "Denotes whether the secret is required." }, "description": { "type": "string", "description": "A human-friendly description of the secret." }, "default": { "anyOf": [ { "anyOf": [ { "type": "array" }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" }, { "type": "null" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Sets a default value for the secret if one is not provided" } }, "type": "object", "description": "Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#secretdefinitionspec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "required": { "type": "boolean", "description": "Denotes whether the secret is required." }, "description": { "type": "string", "description": "A human-friendly description of the secret." }, "default": { "anyOf": [ { "anyOf": [ { "type": "array" }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" }, { "type": "null" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Sets a default value for the secret if one is not provided" } }, "type": "object", "description": "Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#secretdefinitionspec" }, "patternProperties": {} } ] } } }, "_DebugLivenessProbeSpec": { "properties": { "success_threshold": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The number of times to retry a health check before the container is considered healthy.", "default": 1 }, "failure_threshold": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The number of times to retry a failed health check before the container is considered unhealthy.", "default": 3 }, "timeout": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s", "default": "5s" }, "interval": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The time period in seconds between each health check execution. You may specify any value between: 5s and 300s", "default": "30s" }, "initial_delay": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Delays the check from running for the specified amount of time", "default": "0s" }, "path": { "deprecated": true, "anyOf": [ { "type": "string", "pattern": "^\\/.*$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "[Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set)." }, "command": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ], "description": "Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set)." }, "port": { "deprecated": true, "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "[Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set)." } }, "type": "object", "description": "Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#livenessprobespec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "success_threshold": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The number of times to retry a health check before the container is considered healthy.", "default": 1 }, "failure_threshold": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The number of times to retry a failed health check before the container is considered unhealthy.", "default": 3 }, "timeout": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s", "default": "5s" }, "interval": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The time period in seconds between each health check execution. You may specify any value between: 5s and 300s", "default": "30s" }, "initial_delay": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Delays the check from running for the specified amount of time", "default": "0s" }, "path": { "deprecated": true, "anyOf": [ { "type": "string", "pattern": "^\\/.*$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "[Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set)." }, "command": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string" } ], "description": "Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set)." }, "port": { "deprecated": true, "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "[Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set)." } }, "type": "object", "description": "Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#livenessprobespec" }, "patternProperties": {} } ] } } }, "_DebugVolumeSpec": { "properties": { "mount_path": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Directory at which the volume will be mounted inside the container." }, "host_path": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set)." }, "key": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).", "externalDocs": { "url": "https://docs.architect.io/components/services/#volumes" } }, "description": { "type": "string", "description": "Human-readable description of volume" }, "readonly": { "anyOf": [ { "type": "boolean" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Marks the volume as readonly.", "default": false } }, "type": "object", "not": { "type": "object", "required": [ "host_path", "key" ] }, "errorMessage": { "not": "Only one of host_path, key is allowed, or none should exist" }, "description": "Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#volumespec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "mount_path": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Directory at which the volume will be mounted inside the container." }, "host_path": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set)." }, "key": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).", "externalDocs": { "url": "https://docs.architect.io/components/services/#volumes" } }, "description": { "type": "string", "description": "Human-readable description of volume" }, "readonly": { "anyOf": [ { "type": "boolean" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Marks the volume as readonly.", "default": false } }, "type": "object", "not": { "type": "object", "required": [ "host_path", "key" ] }, "errorMessage": { "not": "Only one of host_path, key is allowed, or none should exist" }, "description": "Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#volumespec" }, "patternProperties": {} } ] } } }, "_DebugBuildSpec": { "properties": { "context": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path to the directory containing the source code relative to the `architect.yml` file." }, "buildpack": { "type": "boolean", "description": "Option to use buildpack to build an image." }, "args": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_]+$": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "type": "object", "patternProperties": { "^[a-zA-Z0-9_]+$": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": "Build args to be passed into `docker build`.", "additionalProperties": false } ] } }, "errorMessage": { "additionalProperties": "must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": "Build args to be passed into `docker build`.", "additionalProperties": false }, "dockerfile": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path to the Dockerfile relative to the `build.context`", "default": "Dockerfile" }, "target": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The stage to build in the Dockerfile" } }, "type": "object", "description": "An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.", "not": { "type": "object", "required": [ "buildpack", "dockerfile" ] }, "errorMessage": { "not": "Only one of buildpack, dockerfile is allowed, or none should exist" }, "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#buildspec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "context": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path to the directory containing the source code relative to the `architect.yml` file." }, "buildpack": { "type": "boolean", "description": "Option to use buildpack to build an image." }, "args": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_]+$": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "type": "object", "patternProperties": { "^[a-zA-Z0-9_]+$": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": "Build args to be passed into `docker build`.", "additionalProperties": false } ] } }, "errorMessage": { "additionalProperties": "must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": "Build args to be passed into `docker build`.", "additionalProperties": false }, "dockerfile": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path to the Dockerfile relative to the `build.context`", "default": "Dockerfile" }, "target": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The stage to build in the Dockerfile" } }, "type": "object", "description": "An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.", "not": { "type": "object", "required": [ "buildpack", "dockerfile" ] }, "errorMessage": { "not": "Only one of buildpack, dockerfile is allowed, or none should exist" }, "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#buildspec" }, "patternProperties": {} } ] } } }, "_DebugIngressTlsSpec": { "properties": { "crt": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Custom certificate." }, "key": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Custom certificate key." }, "ca": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Custom certificate ca." } }, "type": "object", "description": "Configuration for custom certificate.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#ingresstlsspec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "crt": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Custom certificate." }, "key": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Custom certificate key." }, "ca": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Custom certificate ca." } }, "type": "object", "description": "Configuration for custom certificate.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#ingresstlsspec" }, "patternProperties": {} } ] } } }, "_DebugIngressSpec": { "properties": { "enabled": { "type": "boolean", "description": "Marks the interface as an ingress." }, "subdomain": { "anyOf": [ { "type": "string", "pattern": "^([A-Za-z0-9](?:[A-Za-z0-9\\-]{0,61}[A-Za-z0-9])|[^\\W\\D\\s\\t\\n\\r\\/]+|[\\@\\*]?)$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.", "errorMessage": "must contain alphanumeric characters ([a-z0-9A-Z]), could contain dashes (-) and alphanumerics between." }, "tls": { "$ref": "#/definitions/_DebugIngressTlsSpec" }, "path": { "anyOf": [ { "type": "string", "pattern": "^\\/.*$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path of the interface used for path based routing" }, "ip_whitelist": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string", "format": "cidrv4" }, { "type": "string", "pattern": "\\${{\\s*secrets\\.[\\w-]+\\s*}}" } ] } }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}|(?:\\d{1,3}\\.){3}\\d{1,3}(?:\\/\\d\\d?)?,?", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}, or a comma-delimited list of cidr/ip addresses ex 8.8.8.8,8.8.4.4/24" } } ], "description": "IP addresses that are allowed to access the interface" }, "private": { "anyOf": [ { "type": "boolean" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Marks the ingress as private behind Architect authentication" } }, "type": "object", "description": "An ingress exposes an interface to external network traffic through an architect-deployed gateway.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#ingressspec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "enabled": { "type": "boolean", "description": "Marks the interface as an ingress." }, "subdomain": { "anyOf": [ { "type": "string", "pattern": "^([A-Za-z0-9](?:[A-Za-z0-9\\-]{0,61}[A-Za-z0-9])|[^\\W\\D\\s\\t\\n\\r\\/]+|[\\@\\*]?)$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.", "errorMessage": "must contain alphanumeric characters ([a-z0-9A-Z]), could contain dashes (-) and alphanumerics between." }, "tls": { "$ref": "#/definitions/_DebugIngressTlsSpec" }, "path": { "anyOf": [ { "type": "string", "pattern": "^\\/.*$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path of the interface used for path based routing" }, "ip_whitelist": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string", "format": "cidrv4" }, { "type": "string", "pattern": "\\${{\\s*secrets\\.[\\w-]+\\s*}}" } ] } }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}|(?:\\d{1,3}\\.){3}\\d{1,3}(?:\\/\\d\\d?)?,?", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}, or a comma-delimited list of cidr/ip addresses ex 8.8.8.8,8.8.4.4/24" } } ], "description": "IP addresses that are allowed to access the interface" }, "private": { "anyOf": [ { "type": "boolean" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Marks the ingress as private behind Architect authentication" } }, "type": "object", "description": "An ingress exposes an interface to external network traffic through an architect-deployed gateway.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#ingressspec" }, "patternProperties": {} } ] } } }, "_DebugScalingMetricsSpec": { "properties": { "cpu": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The cpu usage required to trigger scaling.", "externalDocs": { "url": "https://docs.architect.io/components/services/#cpu--memory" } }, "memory": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The memory usage required to trigger scaling.", "externalDocs": { "url": "https://docs.architect.io/components/services/#cpu--memory" } } }, "type": "object", "description": "Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#scalingmetricsspec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "cpu": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The cpu usage required to trigger scaling.", "externalDocs": { "url": "https://docs.architect.io/components/services/#cpu--memory" } }, "memory": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The memory usage required to trigger scaling.", "externalDocs": { "url": "https://docs.architect.io/components/services/#cpu--memory" } } }, "type": "object", "description": "Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#scalingmetricsspec" }, "patternProperties": {} } ] } } }, "_DebugScalingSpec": { "properties": { "min_replicas": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The target minimum number of service replicas." }, "max_replicas": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The target maximum number of service replicas." }, "metrics": { "$ref": "#/definitions/_DebugScalingMetricsSpec" } }, "type": "object", "description": "Configuration that dictates the scaling behavior of a service.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#scalingspec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "min_replicas": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The target minimum number of service replicas." }, "max_replicas": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The target maximum number of service replicas." }, "metrics": { "$ref": "#/definitions/_DebugScalingMetricsSpec" } }, "type": "object", "description": "Configuration that dictates the scaling behavior of a service.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#scalingspec" }, "patternProperties": {} } ] } } }, "_DebugKubernetesDeploySpec": { "properties": { "deployment": {} }, "type": "object", "description": "Configuration that dictates the kubernetes deploy overrides.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#kubernetesdeployspec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "deployment": {} }, "type": "object", "description": "Configuration that dictates the kubernetes deploy overrides.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#kubernetesdeployspec" }, "patternProperties": {} } ] } } }, "_DebugDeploySpec": { "properties": { "kubernetes": { "$ref": "#/definitions/_DebugKubernetesDeploySpec" } }, "type": "object", "description": "Configuration that dictates the deploy overrides.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#deployspec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "kubernetes": { "$ref": "#/definitions/_DebugKubernetesDeploySpec" } }, "type": "object", "description": "Configuration that dictates the deploy overrides.", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#deployspec" }, "patternProperties": {} } ] } } }, "_DebugServiceInterfaceSpec": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A human-readable description of the interface." }, "host": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host." }, "port": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Port on which the service is listening for traffic." }, "protocol": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Protocol that the interface responds to", "default": "http" }, "username": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A Basic Auth username required to access the interface" }, "password": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A Basic Auth password required to access the interface" }, "path": { "anyOf": [ { "type": "string", "pattern": "^\\/.*$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path of the interface" }, "url": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url." }, "sticky": { "anyOf": [ { "anyOf": [ { "type": "boolean" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Denotes that if this interface is made external, the gateway should use sticky sessions", "default": false }, "ingress": { "$ref": "#/definitions/_DebugIngressSpec" } }, "type": "object", "description": "A service interface exposes service functionality over the network to other services within the same component. If you would like to expose services on the network to external components, see the ComponentInterfaceSpec", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#serviceinterfacespec" }, "patternProperties": { "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A human-readable description of the interface." }, "host": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host." }, "port": { "anyOf": [ { "type": "number" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Port on which the service is listening for traffic." }, "protocol": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Protocol that the interface responds to", "default": "http" }, "username": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A Basic Auth username required to access the interface" }, "password": { "anyOf": [ { "anyOf": [ { "type": "null" }, { "type": "string" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "A Basic Auth password required to access the interface" }, "path": { "anyOf": [ { "type": "string", "pattern": "^\\/.*$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The path of the interface" }, "url": { "anyOf": [ { "type": "string" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url." }, "sticky": { "anyOf": [ { "anyOf": [ { "type": "boolean" } ] }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } } ], "description": "Denotes that if this interface is made external, the gateway should use sticky sessions", "default": false }, "ingress": { "$ref": "#/definitions/_DebugIngressSpec" } }, "type": "object", "description": "A service interface exposes service functionality over the network to other services within the same component. If you would like to expose services on the network to external components, see the ComponentInterfaceSpec", "additionalProperties": false, "externalDocs": { "url": "https://docs.architect.io/reference/architect-yml#serviceinterfacespec" }, "patternProperties": {} } ] } } }, "_DebugServiceSpec": { "properties": { "enabled": { "type": "boolean", "description": "Determines if the service should be running.", "default": true }, "interfaces": { "type": "object", "patternProperties": { "^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?[\\w][\\w\\.-]{0,127}))?$", "errorMessage": "must contain only lower alphanumeric and single hyphens in the middle; max length 32", "description": "Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": { "type": "string", "description": "A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for." }, "keywords": { "type": "array", "items": { "anyOf": [ { "type": "string" } ] }, "description": "Additional search terms to be used when the component is indexed so that others can find it more easily." }, "author": { "type": "string", "description": "The name or handle of the author of the component as a developer contact." }, "homepage": { "type": "string", "description": "The url that serves as the informational homepage of the component (i.e. a github repo)." }, "secrets": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/_DebugSecretDefinitionSpec" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec", "additionalProperties": false }, "outputs": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/_DebugOutputDefinitionSpec" }, { "type": "null" } ] }, "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/_DebugOutputDefinitionSpec" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.", "additionalProperties": false } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.", "additionalProperties": false }, "databases": { "type": "object", "patternProperties": { "^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?[\\w][\\w\\.-]{0,127}))?$": { "anyOf": [ { "type": "string", "pattern": "^[\\w][\\w\\.-]{0,127}$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } }, { "$ref": "#/definitions/_DebugDependencySpec" } ] } }, "errorMessage": { "additionalProperties": "must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": "A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)", "additionalProperties": false }, "interfaces": { "type": "object", "patternProperties": { "^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?[\\w][\\w\\.-]{0,127}))?$", "errorMessage": "must contain only lower alphanumeric and single hyphens in the middle; max length 32", "description": "Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": { "type": "string", "description": "A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for." }, "keywords": { "type": "array", "items": { "anyOf": [ { "type": "string" } ] }, "description": "Additional search terms to be used when the component is indexed so that others can find it more easily." }, "author": { "type": "string", "description": "The name or handle of the author of the component as a developer contact." }, "homepage": { "type": "string", "description": "The url that serves as the informational homepage of the component (i.e. a github repo)." }, "secrets": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/_DebugSecretDefinitionSpec" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec", "additionalProperties": false }, "outputs": { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/_DebugOutputDefinitionSpec" }, { "type": "null" } ] }, "^\\${{\\s*if(.*?)\\s*}}$": { "anyOf": [ { "type": "object", "patternProperties": { "^[a-zA-Z0-9_-]+$": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/definitions/_DebugOutputDefinitionSpec" }, { "type": "null" } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.", "additionalProperties": false } ] } }, "errorMessage": { "additionalProperties": "must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between." }, "description": "A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.", "additionalProperties": false }, "databases": { "type": "object", "patternProperties": { "^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?[\\w][\\w\\.-]{0,127}))?$": { "anyOf": [ { "type": "string", "pattern": "^[\\w][\\w\\.-]{0,127}$" }, { "type": "string", "pattern": "\\${{\\s*(.*?)\\s*}}", "errorMessage": { "pattern": "must be an interpolation ref ex. $__arc__{{ secrets.example }}" } }, { "$ref": "#/definitions/_DebugDependencySpec" } ] } }, "errorMessage": { "additionalProperties": "must contain only lower alphanumeric and single hyphens in the middle; max length 32" }, "description": "A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)", "additionalProperties": false }, "interfaces": { "type": "object", "patternProperties": { "^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?