Environment configuration

Reference documentation outlining all the available options for configuring environments via the arc.env.json manifest

services

type: object

A block containting objects representing services.

service

type: object

An object where the key should be the namespaced name and tag of the service you're targeting.

ingress

type: object

An object containing ingress details to apply to the service. When present, the service will be assigned a domain and will be accessible to the outside world. This block should include at least the subdomain.

subdomain
type: string
required: true

The subdomain with which to prefix the assigned domain.

debug

type: object

An object containing parameters for local debugging.

path
type: string
required: true

A string representing the directory of the Architect service to be debugged.

dockerfile
type: string

A string representing the name of the Dockerfile to be used to build the Architect service. If not specified, this defaults to "Dockerfile".

volumes
type: string[]

An array of strings mapping local directories to directories inside of the container.

parameters

type: object

An object containing a mapping of environment variable names to values. These values can have three different types:

"parameters": {
  ...
  "A_STRING_PARAMETER": "string_parameter_value",
  "A_VAULT_PARAMETER": {
    "valueFrom": {
      "vault": "my_vault",
      "key": "my_vault/MY_SECRET_KEY"
    }
  },
  "A_FILE_REF_PARAMETER": "file:~/.architect/parameter" // starts with "file:"
  ...
}

datastores

type: object

An object containing the datastores used by the service which can be container images or externally provisioned. This is a top-level key of a service.

datastore

type: object

An object whose key should be the name of the datastore.

host

type: string

The host of the datastore when it is externally provisioned. This will override image of the service config if both exist.

port

type: string

The port of the datastore when it is externally provisioned. Optional if the port is defined in the service config.

image

type: string

A Docker image to use in place of the datastore host if Architect should provision the datastore as a container.

parameters

type: object

An object containing a mapping of environment variable names to values. These values can have three different types:

"parameters": {
  ...
  "A_STRING_PARAMETER": "string_parameter_value",
  "A_VAULT_PARAMETER": {
    "valueFrom": {
      "vault": "my_vault",
      "key": "my_vault/MY_SECRET_KEY"
    }
  },
  "A_FILE_REF_PARAMETER": "file:~/.architect/parameter" // starts with "file:"
  ...
}

vaults

type: object

An object containing objects representing vaults.

vault

type: object

An object where the key should be the name for the vault.

host

type: string
required: true

A string representing the host URL of the vault.

type

type: string
required: true

A string representing the type of the vault.

description

type: string

A string describing the vault and its purpose.

access_token

type: string
required: true

A string representing the access token used to read secrets from the vault.

Next
CLI