Skip to main content

About Custom Resources

You can include custom resources in releases to control the experience for applications installed with Replicated KOTS.

Custom resources are consumed by KOTS, the Admin Console, or by other kubectl plugins. Custom resources are packaged as part of the application, but are not deployed to the cluster.

KOTS Custom Resources

The following are custom resources in the kots.io API group:

API Group/VersionKindDescription
kots.io/v1beta1ApplicationAdds additional metadata (branding, release notes and more) to an application
kots.io/v1beta1ConfigDefines a user-facing configuration screen in the Admin Console
kots.io/v1beta2HelmChartIdentifies an instantiation of a Helm Chart
kots.io/v1beta1LintConfigCustomizes the default rule levels for the KOTS release linter

Other Custom Resources

The following are custom resources in API groups other than kots.io that can be included in a KOTS release to configure additional functionality:

API Group/VersionKindDescription
app.k8s.io/v1beta1SIG ApplicationDefines metadata about the application
cluster.kurl.sh/v1beta1InstallerDefines a Replicated kURL distribution
troubleshoot.replicated.com/v1beta2PreflightDefines the data to collect and analyze for custom preflight checks
troubleshoot.replicated.com/v1beta2RedactorDefines custom redactors that apply to support bundles and preflight checks
troubleshoot.sh/v1beta2Support BundleDefines the data to collect and analyze for a support bundle
velero.io/v1BackupA Velero backup request, triggered when the user initiates a backup with Replicated snapshots