CLI usage
Configuration reference
Documentation for basic configuration parameters.http
HTTP configuration for the image factory frontend.
http.httpListenAddr
- Type:
string - Env:
HTTP_HTTPLISTENADDR
http.certFile
- Type:
string - Env:
HTTP_CERTFILE
http.keyFile
- Type:
string - Env:
HTTP_KEYFILE
http.externalURL
- Type:
string - Env:
HTTP_EXTERNALURL
http.externalPXEURL
- Type:
string - Env:
HTTP_EXTERNALPXEURL
http.allowedOrigins
- Type:
[]string - Env:
HTTP_ALLOWEDORIGINS
build
Options for building assets used in images, including concurrency and Talos version constraints.
build.minTalosVersion
- Type:
string - Env:
BUILD_MINTALOSVERSION
build.maxConcurrency
- Type:
int - Env:
BUILD_MAXCONCURRENCY
containerSignature
ContainerSignature holds configuration for verifying container image signatures.
containerSignature.subjectRegExp
- Type:
string - Env:
CONTAINERSIGNATURE_SUBJECTREGEXP
containerSignature.issuerRegExp
- Type:
string - Env:
CONTAINERSIGNATURE_ISSUERREGEXP
containerSignature.issuer
- Type:
string - Env:
CONTAINERSIGNATURE_ISSUER
containerSignature.publicKeyFile
- Type:
string - Env:
CONTAINERSIGNATURE_PUBLICKEYFILE
containerSignature.publicKeyHashAlgo
- Type:
string - Env:
CONTAINERSIGNATURE_PUBLICKEYHASHALGO
containerSignature.disabled
- Type:
bool - Env:
CONTAINERSIGNATURE_DISABLED
cache
Cache contains configuration for storing and retrieving boot assets.
cache.oci
OCI contains configuration for using OCI Registry to store cached assets.
This configuration is required.
cache.oci.registry
- Type:
string - Env:
CACHE_OCI_REGISTRY
ghcr.io.
This is where images are stored.
cache.oci.namespace
- Type:
string - Env:
CACHE_OCI_NAMESPACE
sidero-labs.
Some registries allow repositories without a namespace.
cache.oci.repository
- Type:
string - Env:
CACHE_OCI_REPOSITORY
talos.
Combined with Registry and Namespace, it forms the fully qualified repository path.
cache.oci.insecure
- Type:
bool - Env:
CACHE_OCI_INSECURE
cache.signingKeyPath
- Type:
string - Env:
CACHE_SIGNINGKEYPATH
cache.cdn
CDN contains configuration for using a CDN to serve cached assets.
cache.cdn.host
- Type:
string - Env:
CACHE_CDN_HOST
cache.cdn.trimPrefix
- Type:
string - Env:
CACHE_CDN_TRIMPREFIX
cache.cdn.enabled
- Type:
bool - Env:
CACHE_CDN_ENABLED
cache.s3
S3 contains configuration for using S3 to store cached assets.
cache.s3.bucket
- Type:
string - Env:
CACHE_S3_BUCKET
cache.s3.endpoint
- Type:
string - Env:
CACHE_S3_ENDPOINT
cache.s3.region
- Type:
string - Env:
CACHE_S3_REGION
cache.s3.insecure
- Type:
bool - Env:
CACHE_S3_INSECURE
cache.s3.enabled
- Type:
bool - Env:
CACHE_S3_ENABLED
metrics
Metrics holds configuration for the Prometheus metrics endpoint.
metrics.addr
- Type:
string - Env:
METRICS_ADDR
secureBoot
SecureBoot contains configuration for generating SecureBoot-enabled assets.
secureBoot.file
File specifies file-based SecureBoot keys and certificates.
secureBoot.file.signingKeyPath
- Type:
string - Env:
SECUREBOOT_FILE_SIGNINGKEYPATH
secureBoot.file.signingCertPath
- Type:
string - Env:
SECUREBOOT_FILE_SIGNINGCERTPATH
secureBoot.file.pcrKeyPath
- Type:
string - Env:
SECUREBOOT_FILE_PCRKEYPATH
secureBoot.azureKeyVault
AzureKeyVault configures SecureBoot using Azure Key Vault.
secureBoot.azureKeyVault.url
- Type:
string - Env:
SECUREBOOT_AZUREKEYVAULT_URL
secureBoot.azureKeyVault.certificateName
- Type:
string - Env:
SECUREBOOT_AZUREKEYVAULT_CERTIFICATENAME
secureBoot.azureKeyVault.keyName
- Type:
string - Env:
SECUREBOOT_AZUREKEYVAULT_KEYNAME
secureBoot.awsKMS
AWSKMS configures SecureBoot using AWS KMS.
secureBoot.awsKMS.keyID
- Type:
string - Env:
SECUREBOOT_AWSKMS_KEYID
secureBoot.awsKMS.pcrKeyID
- Type:
string - Env:
SECUREBOOT_AWSKMS_PCRKEYID
secureBoot.awsKMS.certPath
- Type:
string - Env:
SECUREBOOT_AWSKMS_CERTPATH
secureBoot.awsKMS.certARN
- Type:
string - Env:
SECUREBOOT_AWSKMS_CERTARN
secureBoot.awsKMS.region
- Type:
string - Env:
SECUREBOOT_AWSKMS_REGION
secureBoot.enabled
- Type:
bool - Env:
SECUREBOOT_ENABLED
artifacts
Artifacts defines names and references for various images used by the factory.
artifacts.core
Core contains configuration for core images used by the image factory.
artifacts.core.registry
- Type:
string - Env:
ARTIFACTS_CORE_REGISTRY
artifacts.core.components
Components defines the names of images used by the image factory.
This typically maps to repositories and tags for core components.
artifacts.core.components.installerBase
- Type:
string - Env:
ARTIFACTS_CORE_COMPONENTS_INSTALLERBASE
artifacts.core.components.installer
- Type:
string - Env:
ARTIFACTS_CORE_COMPONENTS_INSTALLER
artifacts.core.components.imager
- Type:
string - Env:
ARTIFACTS_CORE_COMPONENTS_IMAGER
artifacts.core.components.extensionManifest
- Type:
string - Env:
ARTIFACTS_CORE_COMPONENTS_EXTENSIONMANIFEST
artifacts.core.components.overlayManifest
- Type:
string - Env:
ARTIFACTS_CORE_COMPONENTS_OVERLAYMANIFEST
artifacts.core.components.talosctl
- Type:
string - Env:
ARTIFACTS_CORE_COMPONENTS_TALOSCTL
artifacts.core.insecure
- Type:
bool - Env:
ARTIFACTS_CORE_INSECURE
artifacts.schematic
Schematic is the OCI repository used to store schematic blobs required by the image factory for building images.
artifacts.schematic.registry
- Type:
string - Env:
ARTIFACTS_SCHEMATIC_REGISTRY
ghcr.io.
This is where images are stored.
artifacts.schematic.namespace
- Type:
string - Env:
ARTIFACTS_SCHEMATIC_NAMESPACE
sidero-labs.
Some registries allow repositories without a namespace.
artifacts.schematic.repository
- Type:
string - Env:
ARTIFACTS_SCHEMATIC_REPOSITORY
talos.
Combined with Registry and Namespace, it forms the fully qualified repository path.
artifacts.schematic.insecure
- Type:
bool - Env:
ARTIFACTS_SCHEMATIC_INSECURE
artifacts.installer
Installer contains configuration for storing and accessing installer images.
artifacts.installer.internal
Internal is the internal OCI registry used by the image factory to push installer images.
artifacts.installer.internal.registry
- Type:
string - Env:
ARTIFACTS_INSTALLER_INTERNAL_REGISTRY
ghcr.io.
This is where images are stored.
artifacts.installer.internal.namespace
- Type:
string - Env:
ARTIFACTS_INSTALLER_INTERNAL_NAMESPACE
sidero-labs.
Some registries allow repositories without a namespace.
artifacts.installer.internal.repository
- Type:
string - Env:
ARTIFACTS_INSTALLER_INTERNAL_REPOSITORY
talos.
Combined with Registry and Namespace, it forms the fully qualified repository path.
artifacts.installer.internal.insecure
- Type:
bool - Env:
ARTIFACTS_INSTALLER_INTERNAL_INSECURE
artifacts.installer.external
External is the public OCI registry used for redirects to installer images.
If this field is not set, Image Factory will proxy requests to the internal registry
through itself instead of issuing HTTP redirects to the external registry endpoint.
artifacts.installer.external.registry
- Type:
string - Env:
ARTIFACTS_INSTALLER_EXTERNAL_REGISTRY
ghcr.io.
This is where images are stored.
artifacts.installer.external.namespace
- Type:
string - Env:
ARTIFACTS_INSTALLER_EXTERNAL_NAMESPACE
sidero-labs.
Some registries allow repositories without a namespace.
artifacts.installer.external.repository
- Type:
string - Env:
ARTIFACTS_INSTALLER_EXTERNAL_REPOSITORY
talos.
Combined with Registry and Namespace, it forms the fully qualified repository path.
artifacts.installer.external.insecure
- Type:
bool - Env:
ARTIFACTS_INSTALLER_EXTERNAL_INSECURE
artifacts.talosVersionRecheckInterval
- Type:
time.Duration - Env:
ARTIFACTS_TALOSVERSIONRECHECKINTERVAL
artifacts.refreshInterval
- Type:
time.Duration - Env:
ARTIFACTS_REFRESHINTERVAL