Skip to main content

platform.yaml Schema

platform.yaml is the single source of truth for a SmoothGlue installation. Generated by smoothglue configure, consumed by smoothglue install. Check this file into version control.


Top-Level Fields

FieldTypeRequiredDescription
templatebuild | run | edgeYesPlatform template
provideraws | kvmYesInfrastructure provider
versionstringYesSmoothGlue version to install (e.g. 7.3.0)
domainstringYesBase domain (e.g. example.mil)
regionstringAWS onlyAWS region (e.g. us-east-1)
cluster.namestringYesCluster name (slug)
cluster.node_typestringAWS onlyEC2 instance type (e.g. m5.4xlarge)
cluster.node_countintegerYesNumber of worker nodes
cluster.habooleanNoEnable HA control plane (default: false)
appslist of stringsYesApp IDs to install beyond template defaults
fipsbooleanNoEnable FIPS 140-2/3 mode (default: true)

Example

template: run
provider: aws
version: "7.3.0"
domain: myplatform.example.mil
region: us-east-1
cluster:
name: my-platform
node_type: m5.4xlarge
node_count: 3
ha: false
apps:
- jira
- mattermost
- confluence
fips: true