Skip to main content

Component Root

Properties

PropertyTypeRequiredDescriptionDefaultExample
sourcestringNosource path or URL Optional source path or URL for the component configuration. Supports HTTP(S) URLs, git repositories, file paths, and relative paths (./). Examples: https://example.com/config.ya--
typestring✅ Yescomponent type Type of component to deploy. Determines which configuration block is required (helm_chart, terraform_module, docker_build, container_image, kubernetes_manifest, or job)-"terraform_module"
namestring✅ Yescomponent name Unique identifier for the component within the app. Used for referencing in dependencies and templates-"database"
var_namestringNovariable name for component output Optional name to use when storing component outputs as variables. If not specified, uses the component name-"db_endpoint"
dependenciesarrayNocomponent dependencies List of other components that must be deployed before this component. Automatically extracted from template references-"database"
helm_chartHelmChartComponentConfigNohelm chart component configuration Configuration for Helm chart deployments. Required when type is ‘helm_chart’--
terraform_moduleTerraformModuleComponentConfigNoterraform module component configuration Configuration for Terraform module deployments. Required when type is ‘terraform_module’--
docker_buildDockerBuildComponentConfigNodocker build component configuration Configuration for building and pushing Docker images. Required when type is ‘docker_build’--
jobJobComponentConfigNojob component configuration Configuration for job/batch components. Required when type is ‘job’--
external_imageExternalImageComponentConfigNocontainer image component configuration Configuration for external container images (e.g., from Docker Hub or ECR). Required when type is ‘container_image’ or ‘external_image’--
kubernetes_manifestKubernetesManifestComponentConfigNokubernetes manifest component configuration Configuration for Kubernetes manifest deployments. Required when type is ‘kubernetes_manifest’--

Property Details

type

Examples:
"terraform_module"
"helm_chart"
"docker_build"
"container_image"
"kubernetes_manifest"

name

Examples:
"database"
"api-server"
"frontend"

var_name

Examples:
"db_endpoint"
"api_host"

dependencies

Examples:
"database"
"infrastructure"