ize.toml

1.1.5

Schema URL

https://catalog.lintel.tools/schemas/schemastore/ize-toml/versions/1.1.5.json
← Back to ize.toml
Type: object

Properties

aws_profile string required

(optional) AWS Profile can be specified here (but normally it's specified via AWS_PROFILE env var)

aws_region string required

(required) AWS Region of this environment should be specified here. Can be overridden by AWS_PROFILE env var or --aws-region flag.

env string required

(optional) Environment name can be specified here. Normally it should be passed via ENV variable or --env flag.

env_dir string required

(optional) Environment directory can be specified here. Normally it's calculated automatically based on the directory structure convention.

home string required

(optional) User home directory can be specified here. Normally $HOME is used.

ize_dir string required

(optional) Ize directory can be specified here. Normally it's assumed to be .infra or .ize in the current repo.

namespace string required

(required) Namespace of the project can be specified here. It is used as a base for all naming. It can be overridden by NAMESPACE env var or --namespace flag.

prefer_runtime string required

(optional) Prefer a specific runtime. (native or docker) (default 'native')

root_dir string required

(optional) Project directory can be set here. By default it's the current directory, but in case you prefer to run ize from the outside of repo it may be useful (uncommon).

config_file string

(optional) Path to ize.toml config file can be specified, but normally it's read from the environment's directory automatically.

log_level string

(optional) Log level can be specified here. Possible levels: info, debug, trace, panic, warn, error, fatal(default). Can be overridden via IZE_LOG_LEVEL env var or via --log-level flag.

plain_text string | boolean

(optional) Plain text output can be enabled here. Default is false. Can be overridden by IZE_PLAIN_TEXT env var or --plain-text flag.

apps_path string

(optional) Path to apps directory can be set. By default apps are searched in 'apps' and 'projects' directories. This is needed in case your repo structure is not purely ize-structured (let's say you have 'src' repo in your dotnet app, as an example)

terraform_version string

(optional) Terraform version can be set here. 1.1.3 by default

docker_registry string

(optional) Docker registry can be set here. By default it uses ECR repo with the name of the service.

tf_log_path string

(optional) TF_LOG_PATH can be set here.

tag string

(optional) Tag can be set statically. Normally it is being constructed automatically based on the git revision.

tf_log string

(optional) Terraform TF_LOG can be set here. Can be TRACE, DEBUG, INFO, WARN or ERROR.

custom_prompt string | boolean

(optional) Custom prompt can be enabled here for all console connections. Default: false.

tunnel object

Tunnel configuration.

2 nested properties
bastion_instance_id string

Bastion instance ID.

forward_host string[]
app object

Apps configuration.

ecs object

Ecs apps configuration.

serverless object

Serverless apps configuration.

alias object

(optional) Alias mode can be enabled here. This can be used to combine various apps via depends_on parameter.

terraform object

Terraform configuration.

infra object

Infrastructure configuration.

2 nested properties
terraform object required

Infrastructure configuration.

8 nested properties
version string

(optional) Terraform version can be set here. 1.1.3 by default.

terraform_version string
state_bucket_region string

(optional) Terraform state bucket region can be specified here. Normally AWS_REGION is used here. Can be overridden via env vars or flags.

state_bucket_name string

(optional) Terraform state bucket name can be specified here. Normally it's generated and defaults to -tf-state

state_name string

(optional) Terraform state name that will be used in the .tfstate file. Normally it's 'terraform' or state name.

root_domain_name string

(optional) Root domain name can be set here. This is the main domain that will be passed to the terraform. Generally if your app lives at 'api.dev.nutcorp.net' the root domain is nutcorp.net

aws_region string

(optional) Terraform-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.

aws_profile string

(optional) Terraform-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).

tunnel object

Tunnel configuration.

2 nested properties
bastion_instance_id string

Bastion instance ID.

forward_host string[]

Definitions

app object

App configuration.

type string

app type

file string

(optional) Path to serverless file can be specified here. Normally it's serverless.yml in the app directory.

node_version string

(optional) Node version that will be used by nvm can be specified here that. Default is v14.

create_domain boolean

(optional) Create domain for the serverless domain manager during the deployment.

path string

(optional) Path to ecs app folder can be specified here. By default it's derived from apps path and app name.

sls_node_modules_cache_mount string

(optional) SLS node_modules cache mount path can be specified here. It's used to store cache during CI/CD process.

env string[]

environments

unsafe boolean

(optional) Enables unsafe mode that increases deploy time on a cost of shorter healthcheck.

image string

(optional) Docker image can be specified here. By default it's derived from the app name.

cluster string

(optional) ECS cluster can be specified here. By default it's derived from env & namespace

task_definition_revision string

(optional) Task definition revision can be specified here. By default latest revision is used to perform a deployment. Normally this parameter can be used via cli during specific deployment needs.

timeout integer

(optional) ECS deployment timeout can be specified here.

docker_registry string

(optional) Docker registry can be set here. By default it uses ECR repo with the name of the service.

skip_deploy boolean

(optional) skip deploy app.

depends_on array

(optional) expresses startup and shutdown dependencies between apps

ecs object

Ecs app configuration.

path string

(optional) Path to ecs app folder can be specified here. By default it's derived from apps path and app name.

unsafe boolean

(optional) Enables unsafe mode that increases deploy time on a cost of shorter healthcheck.

image string

(optional) Docker image can be specified here. By default it's derived from the app name.

cluster string

(optional) ECS cluster can be specified here. By default it's derived from env & namespace

task_definition_revision string

(optional) Task definition revision can be specified here. By default latest revision is used to perform a deployment. Normally this parameter can be used via cli during specific deployment needs.

timeout integer

(optional) ECS deployment timeout can be specified here.

docker_registry string

(optional) Docker registry can be set here. By default it uses ECR repo with the name of the service.

skip_deploy boolean

(optional) skip deploy app.

icon string

(optional) set icon

aws_region string

(optional) ECS-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.

aws_profile string

(optional) ECS-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).

depends_on array

(optional) expresses startup and shutdown dependencies between apps

serverless object

Serverless app configuration.

file string

(optional) Path to serverless file can be specified here. Normally it's serverless.yml in the app directory.

node_version string

(optional) Node version that will be used by nvm can be specified here that. Default is v14.

create_domain boolean

(optional) Create domain for the serverless domain manager during the deployment.

path string

(optional) Path to the serverless app directory can be specified here. Normally it's derived from app directory and app name.

sls_node_modules_cache_mount string

(optional) SLS node_modules cache mount path can be specified here. It's used to store cache during CI/CD process.

env string[]

environments

icon string

(optional) set icon

aws_region string

(optional) Serverless-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.

aws_profile string

(optional) Serverless-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).

depends_on array

(optional) expresses startup and shutdown dependencies between apps

alias object

Alias configuration.

icon string

(optional) set icon

depends_on array

(optional) expresses startup and shutdown dependencies between apps

terraform object

Terraform configuration

version string

(optional) Terraform version can be set here. 1.1.3 by default.

state_bucket_region string

(optional) Terraform state bucket region can be specified here. Normally AWS_REGION is used here. Can be overridden via env vars or flags.

state_bucket_name string

(optional) Terraform state bucket name can be specified here. Normally it's generated and defaults to -tf-state

state_name string

(optional) Terraform state name that will be used in the .tfstate file. Normally it's 'terraform' or state name.

root_domain_name string

(optional) Root domain name can be set here. This is the main domain that will be passed to the terraform. Generally if your app lives at 'api.dev.nutcorp.net' the root domain is nutcorp.net

aws_region string

(optional) Terraform-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.

aws_profile string

(optional) Terraform-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).