# Replicated Documentation

> Replicated is a commercial software distribution platform. Independent software vendors (ISVs) can use features of the Replicated Platform to distribute modern commercial software into complex, customer-controlled environments, including on-prem and air gap.

## Docs

For a complete archive of all documentation pages, see [llms-full.txt](https://docs.replicated.com/llms-full.txt)

- [About Compatibility Matrix](https://docs.replicated.com/vendor/testing-about.md): This topic describes Replicated Compatibility Matrix, including use cases, billing, limitations, and more.
- [Using Compatibility Matrix](https://docs.replicated.com/vendor/testing-how-to.md): This topic describes how to use Replicated Compatibility Matrix to create ephemeral clusters.
- [Supported Compatibility Matrix Cluster Types](https://docs.replicated.com/vendor/testing-supported-clusters.md): This topic describes the supported Kubernetes distributions, Kubernetes versions, instance types, nodes, limitations, and common use cases for clusters created with Replicated Compatibility Matrix.
- [Managing Multi-Node Clusters with Embedded Cluster](https://docs.replicated.com/enterprise/embedded-manage-nodes.md): This topic describes managing nodes in clusters created with Replicated Embedded Cluster, including how to add nodes and enable high-availability for multi-node clusters.
- [Air Gap Installation with Embedded Cluster](https://docs.replicated.com/enterprise/installing-embedded-air-gap.md): This topic describes how to install applications with Embedded Cluster on a virtual machine (VM) or bare metal server with no outbound internet access.
- [Automating Installation with Embedded Cluster](https://docs.replicated.com/enterprise/installing-embedded-automation.md): This topic describes how to install an application with Replicated Embedded Cluster from the command line, without needing to access the Replicated KOTS Admin Console.
- [Embedded Cluster Installation Requirements](https://docs.replicated.com/enterprise/installing-embedded-requirements.md): This topic lists the installation requirements for Replicated Embedded Cluster.
- [Online Installation with Embedded Cluster](https://docs.replicated.com/enterprise/installing-embedded.md): This topic describes how to install an application in an online (internet-connected) environment with the Replicated Embedded Cluster installer.
- [Embedded Cluster Install Command Options](https://docs.replicated.com/reference/embedded-cluster-install.md): This topic describes the options available with the Embedded Cluster install command.
- [Embedded Cluster Overview](https://docs.replicated.com/vendor/embedded-overview.md): This topic provides an introduction to Replicated Embedded Cluster, including a description of the built-in extensions installed by Embedded Cluster, an overview of the Embedded Cluster single-node and multi-node architecture, and requirements and limitations.
- [Installing and Updating with Helm in Air Gap Environments](https://docs.replicated.com/vendor/helm-install-airgap.md): This topic describes how to use Helm to install releases that contain one or more Helm charts in air-gapped environments.
- [About Helm Installations with Replicated](https://docs.replicated.com/vendor/helm-install-overview.md): This topic provides an introduction to Helm installations for applications distributed with Replicated.
- [Packaging a Helm Chart for a Release](https://docs.replicated.com/vendor/helm-install-release.md): This topic describes how to package a Helm chart and the Replicated SDK into a chart archive that can be added to a release.
- [Installing with Helm](https://docs.replicated.com/vendor/install-with-helm.md): This topic describes how to use Helm to install releases that contain one or more Helm charts.
- [Helm global.replicated Values Schema](https://docs.replicated.com/vendor/helm-install-values-schema.md): This topic describes the `global.replicated` values that are injected in the values file of an application's parent Helm chart during Helm installations with Replicated.
- [Introduction to Replicated](https://docs.replicated.com/intro-replicated.md): This topic provides an introduction to the Replicated Platform, including a platform overview and a list of key features.
- [Replicated FAQs](https://docs.replicated.com/vendor/kots-faq.md): This topic lists frequently-asked questions (FAQs) for different components of the Replicated Platform.
- [Replicated Quick Start](https://docs.replicated.com/vendor/quick-start.md): This topic provides a quick start workflow to help new users learn about the Replicated Platform.
- [Replicated Onboarding ](https://docs.replicated.com/vendor/replicated-onboarding.md): This topic describes how to onboard applications to the Replicated Platform.
- [Installing the KOTS CLI](https://docs.replicated.com/reference/kots-cli-getting-started.md): Users can interact with the Replicated KOTS CLI to install and manage applications with Replicated KOTS.
- [Air Gap Installation in Existing Clusters with KOTS](https://docs.replicated.com/enterprise/installing-existing-cluster-airgapped.md): This topic describes how to use Replicated KOTS to install an application in an existing Kubernetes cluster in an air-gapped environment.
- [KOTS Installation Requirements](https://docs.replicated.com/enterprise/installing-general-requirements.md): This topic describes the requirements for installing in a Kubernetes cluster with Replicated KOTS.
- [Creating and Scheduling Backups](https://docs.replicated.com/enterprise/snapshots-creating.md): This topic describes how to use the Replicated snapshots feature to create backups.
- [Restoring from Backups](https://docs.replicated.com/enterprise/snapshots-restoring-full.md): This topic describes how to restore from full or partial backups using Replicated snapshots.
- [Installing the Velero CLI](https://docs.replicated.com/enterprise/snapshots-velero-cli-installing.md): You install the Velero CLI before installing Velero and configuring a storage destination for backups.
- [Performing Updates in Existing Clusters](https://docs.replicated.com/enterprise/updating-app-manager.md): This topic describes how to perform updates in existing cluster installations with Replicated KOTS.
- [About Custom Resources](https://docs.replicated.com/reference/custom-resource-about.md): You can include custom resources in releases to control the experience for applications installed with Replicated KOTS.
- [Application](https://docs.replicated.com/reference/custom-resource-application.md): The Application custom resource enables features such as branding, release notes, port forwarding, dashboard buttons, app status indicators, and custom graphs.
- [Config](https://docs.replicated.com/reference/custom-resource-config.md): The Config custom resource can be provided by a vendor to specify a Config page in the Replicated Admin Console for collecting customer supplied values and template function rendering.
- [HelmChart v2](https://docs.replicated.com/reference/custom-resource-helmchart-v2.md): This topic describes the KOTS HelmChart v2 custom resource.
- [About Template Functions](https://docs.replicated.com/reference/template-functions-about.md): This topic describes Replicated KOTS template functions, including information about use cases, template function contexts, syntax.
- [Template Function Examples](https://docs.replicated.com/reference/template-functions-examples.md): This topic provides examples of how to use Replicated KOTS template functions in various common use cases.
- [Config Context](https://docs.replicated.com/reference/template-functions-config-context.md): This topic provides a list of the KOTS template functions in the Config context.
- [License Context](https://docs.replicated.com/reference/template-functions-license-context.md): This topic provides a list of the KOTS template functions in the License context.
- [Static Context](https://docs.replicated.com/reference/template-functions-static-context.md): This topic provides a list of the KOTS template functions in the Static context.
- [About Distributing Helm Charts with KOTS](https://docs.replicated.com/vendor/helm-native-about.md): This topic provides an overview of how Replicated KOTS deploys Helm charts, including an introduction to the KOTS HelmChart custom resource, limitations of deploying Helm charts with KOTS, and more.
- [Configuring the HelmChart Custom Resource v2](https://docs.replicated.com/vendor/helm-native-v2-using.md): This topic describes how to configure the Replicated HelmChart custom resource version `kots.io/v1beta2` to support Helm chart installations with Replicated KOTS.
- [Packaging Air Gap Bundles for Helm Charts](https://docs.replicated.com/vendor/helm-packaging-airgap-bundles.md): This topic describes how to package and build air gap bundles for releases that contain one or more Helm charts.
- [Templating Annotations](https://docs.replicated.com/vendor/resources-annotations-templating.md): This topic describes how to use Replicated KOTS template functions to template annotations for resources and objects based on user-supplied values.
- [About Backup and Restore with Snapshots](https://docs.replicated.com/vendor/snapshots-overview.md): This topic provides an introduction to the Replicated KOTS snapshots feature for backup and restore.
- [Introduction to kURL](https://docs.replicated.com/vendor/kurl-about.md): This topic provides an introduction to the Replicated kURL installer, including information about kURL specifications and installations.
- [kURL Installation Requirements](https://docs.replicated.com/enterprise/installing-kurl-requirements.md): This topic lists the installation requirements for Replicated kURL.
- [Online Installation with kURL](https://docs.replicated.com/enterprise/installing-kurl.md): This topic describes how to use Replicated kURL to provision a cluster in a virtual machine (VM) or bare metal server and install an application in the cluster.
- [Air Gap Installation with kURL](https://docs.replicated.com/enterprise/installing-kurl-airgap.md): This topic describes how to use Replicated kURL to provision a cluster in a virtual machine (VM) or bare metal server and install an application in the cluster.
- [Creating a kURL Installer](https://docs.replicated.com/vendor/packaging-embedded-kubernetes.md): This topic describes how to create a kURL installer spec in the Replicated Vendor Portal to support installations with Replicated kURL.
- [Defining Preflight Checks](https://docs.replicated.com/vendor/preflight-defining.md): This topic describes how to define preflight checks in Helm and Kubernetes manifest-based applications.
- [Example Preflight Specs](https://docs.replicated.com/vendor/preflight-examples.md): This section includes common examples of preflight check specifications.
- [Customizing Host Preflight Checks for kURL](https://docs.replicated.com/vendor/preflight-host-preflights.md): This topic provides information about how to customize host preflight checks for installations with Replicated kURL.
- [Running Preflight Checks for Helm Installations](https://docs.replicated.com/vendor/preflight-running.md): This topic describes how to use the preflight kubectl plugin to run preflight checks for applications installed with the Helm CLI.
- [About Preflight Checks and Support Bundles](https://docs.replicated.com/vendor/preflight-support-bundle-about.md): This topic provides an introduction to preflight checks and support bundles, which are provided by the Troubleshoot open source project.
- [Adding and Customizing Support Bundles](https://docs.replicated.com/vendor/support-bundle-customizing.md): This topic describes how to add a default support bundle spec to a release for your application.
- [Example Support Bundle Specs](https://docs.replicated.com/vendor/support-bundle-examples.md): This topic includes common examples of support bundle specifications.
- [Generating Support Bundles](https://docs.replicated.com/vendor/support-bundle-generating.md): This topic describes how to generate support bundles from the command line using the kubectl support-bundle plugin.
- [About the Replicated Proxy Registry](https://docs.replicated.com/vendor/private-images-about.md): This topic describes how the Replicated proxy registry can be used to grant proxy access to your application's private images or allow pull through access of public images.
- [Using the Proxy Registry with Helm Installations](https://docs.replicated.com/vendor/helm-image-registry.md): This topic describes how to use the Replicated proxy registry to proxy images for installations with the Helm CLI.
- [Using the Proxy Registry with KOTS Installations](https://docs.replicated.com/vendor/private-images-kots.md): This topic describes how to use the Replicated proxy registry with applications deployed with Replicated KOTS.
- [Connecting to a Public Registry through the Proxy Registry](https://docs.replicated.com/vendor/packaging-public-images.md): This topic describes how to pull images from public registries using the Replicated proxy registry.
- [Installing the Replicated CLI](https://docs.replicated.com/reference/replicated-cli-installing.md): This topic describes how to install and run the Replicated CLI.
- [Replicated SDK API](https://docs.replicated.com/reference/replicated-sdk-apis.md): The Replicated SDK provides an API that you can use to embed Replicated functionality in your Helm chart application.
- [Installing the Replicated SDK](https://docs.replicated.com/vendor/replicated-sdk-installing.md): This topic describes the methods for distributing and installing the Replicated SDK.
- [About the Replicated SDK](https://docs.replicated.com/vendor/replicated-sdk-overview.md): This topic provides an introduction to using the Replicated SDK with your application.
- [Customizing the Replicated SDK](https://docs.replicated.com/vendor/replicated-sdk-customizing.md): This topic describes various ways to customize the Replicated SDK, including customizing RBAC, setting environment variables, adding tolerations, and more.
- [Using Custom Domains](https://docs.replicated.com/vendor/custom-domains-using.md): This topic describes how to use the Replicated Vendor Portal to add and manage custom domains to alias the Replicated registry, the Replicated proxy registry, the Replicated app service, and the Download Portal.
- [About Custom Domains](https://docs.replicated.com/vendor/custom-domains.md): This topic provides an overview and the limitations of using custom domains to alias the Replicated proxy registry, the Replicated app service, the Replicated Download Portal, and the Replicated registry.
- [Configuring Custom Metrics (Beta)](https://docs.replicated.com/vendor/custom-metrics.md): This topic describes how to configure an application to send custom metrics to the Replicated Vendor Portal.
- [Enabling and Understanding Application Status](https://docs.replicated.com/vendor/insights-app-status.md): This topic describes how to configure your application so that you can view the status of application instances in the Replicated Vendor Portal.
- [About Instance and Event Data](https://docs.replicated.com/vendor/instance-insights-event-data.md): This topic provides an overview of the customer and instance insights that you can view in the Replicated Vendor Portal.
- [About Customers and Licensing](https://docs.replicated.com/vendor/licenses-about.md): This topic provides an overview of customers and licenses in the Replicated Platform.
- [Managing Customer License Fields](https://docs.replicated.com/vendor/licenses-adding-custom-fields.md): This topic describes how to manage customer license fields in the Replicated Vendor Portal, including how to add custom fields and set initial values for the built-in fields.
- [Managing Install Types for a License](https://docs.replicated.com/vendor/licenses-install-types.md): This topic describes how to manage which installation types and options are enabled for a license.
- [Querying Entitlements with the Replicated SDK API](https://docs.replicated.com/vendor/licenses-reference-sdk.md): This topic describes how to query license entitlements at runtime using the Replicated SDK in-cluster API.
- [About Channels and Releases](https://docs.replicated.com/vendor/releases-about.md): This topic describes channels and releases, including information about the **Releases** and **Channels** pages in the Replicated Vendor Portal.
- [Creating and Editing Channels](https://docs.replicated.com/vendor/releases-creating-channels.md): This topic describes how to create and edit channels using the Replicated Vendor Portal.
- [Managing Releases with the CLI](https://docs.replicated.com/vendor/releases-creating-cli.md): This topic describes how to use the Replicated CLI to create and promote releases.
- [Accessing a Customer's Download Portal](https://docs.replicated.com/vendor/releases-share-download-portal.md): This topic describes how to access installation instructions and download installation assets (such as customer license files and air gap bundles) from the Replicated Download Portal.
- [Generating API Tokens](https://docs.replicated.com/vendor/replicated-api-tokens.md): This topic describes the available types of API tokens and how to generate them for use with the Replicated CLI and Replicated Vendor API v3.
- [Configuring RBAC Policies](https://docs.replicated.com/vendor/team-management-rbac-configuring.md): This topic describes how to use role-based access policies (RBAC) to grant or deny team members permissions to use Replicated services in the Replicated Vendor Portal.
- [RBAC Resource Names](https://docs.replicated.com/vendor/team-management-rbac-resource-names.md): This a list of all available resource names for the Replicated vendor role-based access control (RBAC) policy:
- [Managing Team Members](https://docs.replicated.com/vendor/team-management.md): This topic describes how to manage team members in the Replicated Vendor Portal, such as inviting and removing members, and editing permissions.
- [Collecting Telemetry for Air Gap Instances](https://docs.replicated.com/vendor/telemetry-air-gap.md): This topic describes how to collect telemetry for instances in air gap environments.
- [Managing Applications](https://docs.replicated.com/vendor/vendor-portal-manage-app.md): This topic provides information about managing applications, including how to create, delete, and retrieve the slug for applications in the Replicated Vendor Portal and with the Replicated CLI.