architect.schema.json

title: Schema for architect.yml. See: https://docs.architect.io/reference/architect-yml

type: string

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: 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.

type: array

description: Additional search terms to be used when the component is indexed so that others can find it more easily.

description: The name or handle of the author of the component as a developer contact.

description: The url that serves as the informational homepage of the component (i.e. a github repo).

type: object

type: boolean

$ref: #/definitions/SecretDefinitionSpec

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: 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: 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.

$ref: #/definitions/DatabaseSpec

additionalProperties: must contain only lower alphanumeric and single hyphens in the middle; max length 32

description: A database represents a stateful service powered by one of several supported database engines.

description: A database represents a stateful service powered by one of several supported database engines.

$ref: #/definitions/ServiceSpec

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

$ref: #/definitions/TaskSpec

description: A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.

pattern: must be an interpolation ref ex. $__arc__{{ secrets.example }}

$ref: #/definitions/DependencySpec

description: A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)

$ref: #/definitions/ComponentInterfaceSpec

description: A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.

description: The top level object of the `architect.yml`; defines a deployable Architect Component.

description: Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32

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.

description: Additional search terms to be used when the component is indexed so that others can find it more easily.

description: The name or handle of the author of the component as a developer contact.

description: The url that serves as the informational homepage of the component (i.e. a github repo).

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: 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.

description: A database represents a stateful service powered by one of several supported database engines.

description: A database represents a stateful service powered by one of several supported database engines.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)

description: The top level object of the `architect.yml`; defines a deployable Architect Component.

description: Human readable description

description: The type engine and version of database software needed for data storage.

errorMessage: must be of the format <engine>:<version> (e.g. postgres:13)

description: The connection uri of an existing database to use instead of provisioning a new one

description: Component databases let you quickly spin up a database for your service

description: Human readable description

description: The type engine and version of database software needed for data storage.

description: The connection uri of an existing database to use instead of provisioning a new one

description: Component databases let you quickly spin up a database for your service

description: Denotes whether the secret is required.

description: A human-friendly description of the secret.

description: Sets a default value for the secret if one is not provided

description: Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).

description: The number of times to retry a health check before the container is considered healthy.

description: The number of times to retry a failed health check before the container is considered unhealthy.

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

description: The time period in seconds between each health check execution. You may specify any value between: 5s and 300s

description: Delays the check from running for the specified amount of time

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).

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).

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).

description: Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.

description: The number of times to retry a health check before the container is considered healthy.

description: The number of times to retry a failed health check before the container is considered unhealthy.

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

description: The time period in seconds between each health check execution. You may specify any value between: 5s and 300s

description: Delays the check from running for the specified amount of time

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).

description: Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.

description: Directory at which the volume will be mounted inside the container.

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).

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).

description: Human-readable description of volume

description: Marks the volume as readonly.

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.

description: Directory at which the volume will be mounted inside the container.

description: Human-readable description of volume

description: Marks the volume as readonly.

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.

description: The path to the directory containing the source code relative to the `architect.yml` file.

description: Option to use buildpack to build an image.

description: Build args to be passed into `docker build`.

description: Build args to be passed into `docker build`.

description: The path to the Dockerfile relative to the `build.context`

description: The stage to build in the Dockerfile

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: Only one of buildpack, dockerfile is allowed, or none should exist

description: The path to the directory containing the source code relative to the `architect.yml` file.

description: Option to use buildpack to build an image.

description: Build args to be passed into `docker build`.

description: Build args to be passed into `docker build`.

description: The path to the Dockerfile relative to the `build.context`

description: The stage to build in the Dockerfile

description: Custom certificate.

description: Custom certificate key.

description: Custom certificate ca.

description: Configuration for custom certificate.

description: Custom certificate.

description: Custom certificate key.

description: Custom certificate ca.

description: Configuration for custom certificate.

description: Marks the interface as an ingress.

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.

description: The path of the interface used for path based routing

description: IP addresses that are allowed to access the interface

description: Marks the ingress as private behind Architect authentication

description: An ingress exposes an interface to external network traffic through an architect-deployed gateway.

description: Marks the interface as an ingress.

description: The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.

description: The path of the interface used for path based routing

description: IP addresses that are allowed to access the interface

description: Marks the ingress as private behind Architect authentication

description: An ingress exposes an interface to external network traffic through an architect-deployed gateway.

description: The cpu usage required to trigger scaling.

description: The memory usage required to trigger scaling.

description: Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.

description: The cpu usage required to trigger scaling.

description: The memory usage required to trigger scaling.

description: Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.

description: The target minimum number of service replicas.

description: The target maximum number of service replicas.

description: Configuration that dictates the scaling behavior of a service.

description: The target minimum number of service replicas.

description: The target maximum number of service replicas.

description: Configuration that dictates the scaling behavior of a service.

description: Configuration that dictates the kubernetes deploy overrides.

description: Configuration that dictates the kubernetes deploy overrides.

description: Configuration that dictates the deploy overrides.

description: Configuration that dictates the deploy overrides.

description: A human-readable description of the interface.

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.

description: Port on which the service is listening for traffic.

description: Protocol that the interface responds to

description: A Basic Auth username required to access the interface

description: A Basic Auth password required to access the interface

description: The path of the interface

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.

description: Denotes that if this interface is made external, the gateway should use sticky sessions

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

description: A human-readable description of the interface.

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.

description: Port on which the service is listening for traffic.

description: Protocol that the interface responds to

description: A Basic Auth username required to access the interface

description: A Basic Auth password required to access the interface

description: The path of the interface

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.

description: Denotes that if this interface is made external, the gateway should use sticky sessions

description: Determines if the service should be running.

description: A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field.

description: A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

not: Only one of build, image is allowed, or none should exist

description: Determines if the service should be running.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field.

description: A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: A Task represents a recurring and/or exiting runtime (e.g. crons, schedulers, triggered jobs). Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.

description: A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: An empty object that optionally supports specifying a tag for backwards compatibility.

description: An empty object that optionally supports specifying a tag for backwards compatibility.

description: A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for.

description: The host that the component interface should forward to.

description: The port that the component interface should forward to.

description: The protocol by which the component interface can be connected to.

description: The Basic Auth username by which a component interface can be connected to.

description: The Basic Auth password by which a component interface can be connected to.

description: The url that the component interface should forward to.

description: If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running.

description: Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.

description: A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for.

description: The host that the component interface should forward to.

description: The port that the component interface should forward to.

description: The protocol by which the component interface can be connected to.

description: The Basic Auth username by which a component interface can be connected to.

description: The Basic Auth password by which a component interface can be connected to.

description: The url that the component interface should forward to.

description: If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running.

description: Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.

description: A human-friendly description of the output field.

description: Value of the output to be passed to upstream consumers

description: Components can define output fields that can be used to share configuration with consuming components.

description: A human-friendly description of the output field.

description: Value of the output to be passed to upstream consumers

description: Components can define output fields that can be used to share configuration with consuming components.

description: Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32

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.

description: Additional search terms to be used when the component is indexed so that others can find it more easily.

description: The name or handle of the author of the component as a developer contact.

description: The url that serves as the informational homepage of the component (i.e. a github repo).

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: 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.

description: A database represents a stateful service powered by one of several supported database engines.

description: A database represents a stateful service powered by one of several supported database engines.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)

description: The top level object of the `architect.yml`; defines a deployable Architect Component.

description: Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32

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.

description: Additional search terms to be used when the component is indexed so that others can find it more easily.

description: The name or handle of the author of the component as a developer contact.

description: The url that serves as the informational homepage of the component (i.e. a github repo).

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: 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.

description: A database represents a stateful service powered by one of several supported database engines.

description: A database represents a stateful service powered by one of several supported database engines.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)

description: The top level object of the `architect.yml`; defines a deployable Architect Component.

description: Human readable description

description: The type engine and version of database software needed for data storage.

description: The connection uri of an existing database to use instead of provisioning a new one

description: Component databases let you quickly spin up a database for your service

description: Human readable description

description: The type engine and version of database software needed for data storage.

description: The connection uri of an existing database to use instead of provisioning a new one

description: Component databases let you quickly spin up a database for your service

description: Denotes whether the secret is required.

description: A human-friendly description of the secret.

description: Sets a default value for the secret if one is not provided

description: Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).

description: Denotes whether the secret is required.

description: A human-friendly description of the secret.

description: Sets a default value for the secret if one is not provided

description: Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).

description: The number of times to retry a health check before the container is considered healthy.

description: The number of times to retry a failed health check before the container is considered unhealthy.

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

description: The time period in seconds between each health check execution. You may specify any value between: 5s and 300s

description: Delays the check from running for the specified amount of time

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).

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).

description: Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.

description: The number of times to retry a health check before the container is considered healthy.

description: The number of times to retry a failed health check before the container is considered unhealthy.

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

description: The time period in seconds between each health check execution. You may specify any value between: 5s and 300s

description: Delays the check from running for the specified amount of time

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).

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).

description: Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.

description: Directory at which the volume will be mounted inside the container.

description: Human-readable description of volume

description: Marks the volume as readonly.

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.

description: Directory at which the volume will be mounted inside the container.

description: Human-readable description of volume

description: Marks the volume as readonly.

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.

description: The path to the directory containing the source code relative to the `architect.yml` file.

description: Option to use buildpack to build an image.

description: Build args to be passed into `docker build`.

description: Build args to be passed into `docker build`.

description: The path to the Dockerfile relative to the `build.context`

description: The stage to build in the Dockerfile

description: The path to the directory containing the source code relative to the `architect.yml` file.

description: Option to use buildpack to build an image.

description: Build args to be passed into `docker build`.

description: Build args to be passed into `docker build`.

description: The path to the Dockerfile relative to the `build.context`

description: The stage to build in the Dockerfile

description: Custom certificate.

description: Custom certificate key.

description: Custom certificate ca.

description: Configuration for custom certificate.

description: Custom certificate.

description: Custom certificate key.

description: Custom certificate ca.

description: Configuration for custom certificate.

description: Marks the interface as an ingress.

description: The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.

description: The path of the interface used for path based routing

description: IP addresses that are allowed to access the interface

description: Marks the ingress as private behind Architect authentication

description: An ingress exposes an interface to external network traffic through an architect-deployed gateway.

description: Marks the interface as an ingress.

description: The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.

description: The path of the interface used for path based routing

description: IP addresses that are allowed to access the interface

description: Marks the ingress as private behind Architect authentication

description: An ingress exposes an interface to external network traffic through an architect-deployed gateway.

description: The cpu usage required to trigger scaling.

description: The memory usage required to trigger scaling.

description: Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.

description: The cpu usage required to trigger scaling.

description: The memory usage required to trigger scaling.

description: Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.

description: The target minimum number of service replicas.

description: The target maximum number of service replicas.

description: Configuration that dictates the scaling behavior of a service.

description: The target minimum number of service replicas.

description: The target maximum number of service replicas.

description: Configuration that dictates the scaling behavior of a service.

description: Configuration that dictates the kubernetes deploy overrides.

description: Configuration that dictates the kubernetes deploy overrides.

description: Configuration that dictates the deploy overrides.

description: Configuration that dictates the deploy overrides.

description: A human-readable description of the interface.

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.

description: Port on which the service is listening for traffic.

description: Protocol that the interface responds to

description: A Basic Auth username required to access the interface

description: A Basic Auth password required to access the interface

description: The path of the interface

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.

description: Denotes that if this interface is made external, the gateway should use sticky sessions

description: A human-readable description of the interface.

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.

description: Port on which the service is listening for traffic.

description: Protocol that the interface responds to

description: A Basic Auth username required to access the interface

description: A Basic Auth password required to access the interface

description: The path of the interface

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.

description: Denotes that if this interface is made external, the gateway should use sticky sessions

description: Determines if the service should be running.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field.

description: A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: Determines if the service should be running.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.

description: A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field.

description: A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI.

description: Human readable description

description: The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)

description: The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.

description: The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.

description: The dominant programming language used; this is for informational purposes only.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: A set of key-value pairs or secret definitions that describes environment variables and their values.

description: The cpu required to run a service or a task

description: The memory required to run a service or a task.

description: An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.

description: A specific service name which will override the service name specified in the component.

description: An empty object that optionally supports specifying a tag for backwards compatibility.

description: An empty object that optionally supports specifying a tag for backwards compatibility.

description: A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for.

description: The host that the component interface should forward to.

description: The port that the component interface should forward to.

description: The protocol by which the component interface can be connected to.

description: The Basic Auth username by which a component interface can be connected to.

description: The Basic Auth password by which a component interface can be connected to.

description: The url that the component interface should forward to.

description: If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running.

description: Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.

description: A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for.

description: The host that the component interface should forward to.

description: The port that the component interface should forward to.

description: The protocol by which the component interface can be connected to.

description: The Basic Auth username by which a component interface can be connected to.

description: The Basic Auth password by which a component interface can be connected to.

description: The url that the component interface should forward to.

description: If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running.

description: Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.

description: A human-friendly description of the output field.

description: Value of the output to be passed to upstream consumers

description: Components can define output fields that can be used to share configuration with consuming components.

description: A human-friendly description of the output field.

description: Value of the output to be passed to upstream consumers

description: Components can define output fields that can be used to share configuration with consuming components.

description: Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32

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.

description: Additional search terms to be used when the component is indexed so that others can find it more easily.

description: The name or handle of the author of the component as a developer contact.

description: The url that serves as the informational homepage of the component (i.e. a github repo).

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: 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.

description: A database represents a stateful service powered by one of several supported database engines.

description: A database represents a stateful service powered by one of several supported database engines.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)

description: The top level object of the `architect.yml`; defines a deployable Architect Component.

description: Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32

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.

description: Additional search terms to be used when the component is indexed so that others can find it more easily.

description: The name or handle of the author of the component as a developer contact.

description: The url that serves as the informational homepage of the component (i.e. a github repo).

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: 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.

description: A database represents a stateful service powered by one of several supported database engines.

description: A database represents a stateful service powered by one of several supported database engines.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.

description: A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)

description: The top level object of the `architect.yml`; defines a deployable Architect Component.


nuget-project.json

$ref: #/definitions/dependencies

description: A list of dependencies.

type: string object

default: default

enum: default build

description: The frameworks on which your project will run.

$ref: #/definitions/configType

description: The Operating System and Architectures on which your application will be running.

description: A list of supported target frameworks.

description: A supported target framework.

title: JSON schema for NuGet project.json files


as-code.latest.schema.json

title: JSON Schema for NeoLoad as-code files

xrequired:
name
because neoload files can be partial

$ref: #/definitions/common/name

$id: #root/includes

title: Includes

$ref: #/definitions/common/text

$id: #root/variables

title: Variables

$ref: #/definitions/variables/constant

$ref: #/definitions/variables/file

$ref: #/definitions/variables/counter

$ref: #/definitions/variables/javascript

$id: #root/servers

title: Servers

$ref: #/definitions/server

title: SLA Profiles

$ref: #/definitions/sla

$id: #root/populations

title: Populations

$ref: #/definitions/populations/population

$id: #root/scenarios

title: Scenarios

$ref: #/definitions/scenario

title: User_paths

$id: #/definitions/common/text

title: Text

title: Positive Number

type: integer

$id: #/definitions/common/duration

title: Duration

$ref: #/definitions/common/time

$ref: #/definitions/common/iterations

title: variation_policy.stop_after values

title: Start after

$id: #/definitions/common/time

title: Time

$id: #/definitions/common/iterations

title: Iterations

pattern: ^(\d+ iterations)$

title: Name

title: Url

default: global

enum: local global unique

enum: sequential random any

$id: #/definitions/variables/generic

$id: #/definitions/variables/constant

title: Constant

$ref: #/definitions/variables/generic

$id: #/definitions/variables/file

title: File

$id: #/definitions/variables/counter

title: Counter

xrequired: start end increment

type: number

title: Random Number

xrequired: min max

$id: #/definitions/variables/javascript

title: Javascript

$id: #/definitions/server

title: Server

xrequired: name host

$id: #root/servers/items/scheme

enum: http https

$ref: #/definitions/authentication/basic

$ref: #/definitions/authentication/ntlm

xrequired: login password

title: Basic Authentication

title: NTLM Authentication

title: Negotiate Authentication

title: SLA Profile

title: Thresholds

title: Threshold

title: Population

value: why do we need the substructure 'name' to denote a string list?

title: Constant Load

title: Ramp-up Load

title: Peaks Load

title: Peak Phase

title: Scenario

title: Scenario Populations

title: User Path

title: Containers

title: Steps

transaction

title: Action: Transaction

title: Steps

title: Action: HTTP/s Request

title: Action: Delay

title: Action: Think Time

title: Action: Javascript

title: Action: If

xcomments: like GWBSR said: 'aint gonna do it', at least not this commit


typewiz.json

description: If given, all the file paths in the collected type info will be resolved relative to this directory.

description: Path to your project's tsconfig file. This is required for several other options like implicit this instrumentation and type inference using static analysis.

description: Try to find even more types by combining static analysis with the runtime analysis. TypeWiz will try to use TypeScript's inferred types when determining the type of a function argument.

description: Find type of this in non-class member functions. Requires common.tsConfig to be set

description: Don't add a declaration of $_$twiz to instrumented files.

description: A prefix that will be added in front of each type applied. You can use a javascript comment to mark the automatically added types. The prefix will be added after the colon character, just before the actual type.

title: Typewiz configuration schema


component-detection-manifest.json

$ref: #/definitions/CGManifest

$ref: #/definitions/Registration

required: registrations version

title: CGManifest

title: Registration

$ref: #/definitions/Component

title: Component

$ref: #/definitions/Cargo

$ref: #/definitions/Git

$ref: #/definitions/Go

$ref: #/definitions/Linux

$ref: #/definitions/Maven

$ref: #/definitions/Npm

$ref: #/definitions/NuGet

$ref: #/definitions/Other

$ref: #/definitions/Pip

$ref: #/definitions/Pod

$ref: #/definitions/RubyGems

$ref: #/definitions/VCPKG

title: Cargo

required: name version

required: type cargo

title: Git

format: uri

required: commitHash repositoryUrl

required: type git

title: Go

required: type go

title: Linux

required: name version distribution release

required: type linux

title: Maven

required: groupId artifactId version

required: type maven

title: Npm

required: type npm

title: NuGet

required: type nuget

title: Other

title: Other

required: name version downloadUrl hash

required: type other

title: Pip

required: type pip

title: Pod

title: RubyGems

title: VCPKG

title: Component Detection manifest