About Custom Resources

You can include custom resources in your releases to control the experience for installations with a Replicated installer, add support air gap installations, and configure functionality like preflight checks, support bundles, and disaster recovery.

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

Custom Resources

The following custom resources can be used in releases distributed with Replicated:

API Group/Version	Kind	Description
app.k8s.io/v1beta1	SIG Application	Defines metadata about the application for installations with a Replicated installer (Embedded Cluster, KOTS, kURL)
embeddedcluster.replicated.com/v1beta1	Config	Defines a Replicated Embedded Cluster distribution
cluster.kurl.sh/v1beta1	Installer	Defines a Replicated kURL distribution
kots.io/v1beta1	Application	Adds metadata (such as branding, release notes and more) to the Admin Console for installations with a Replicated installer
kots.io/v1beta1	Config	Defines a user-facing configuration screen in the Admin Console for installations with a Replicated installer
kots.io/v1beta2	HelmChart	Identifies an instantiation of a Helm Chart. Used for installations with a Replicated installer and for air gap installations with the Helm CLI
kots.io/v1beta1	LintConfig	Customizes the default rule levels for the release linter
troubleshoot.sh/v1beta2	Preflight	Defines collectors and analyzers for preflight checks
troubleshoot.sh/v1beta2	Redactor	Defines custom redactors for support bundles and preflight checks. Supported for installations with a Replicated installer
troubleshoot.sh/v1beta2	Support Bundle	Defines collectors and analyzers for support bundles
velero.io/v1	Backup	Defines a Velero backup request. Velero provides backup and restore functionality for installations with a Replicated installer. For more information about Velero, see the Velero documentation.