Packaging an Application

Edit this page

The first step to shipping your application in Replicated is to create a YAML file that defines the properties, containers, optional configuration and more. This section of docs explains how to write this YAML file.

YAML Overview

An overview of the various sections of the Replicated YAML.

Application Properties

The Replicated YAML section `properties` allows several high level items to be defined.

Config Screen

The `config` section of the Replicated YAML creates a dynamic settings page that customers can use to configure their instance.

Test Procs

Test Procs enable customers to easily test the validity of the unsaved configuration parameters they're entering during installation.

Components And Containers

The `components` section of the Replicated YAML defines how the containers will be created and started.

Events and Orchestration

The `events` section of the Replicated YAML allows application vendors to sequence and orchestrate containers based on events from other containers.

Clustering

An implementation guide for using the Replicated built in clustering functionality.

Commands

The `cmds` section of the Replicated YAML allows you to leverage the power of external commands within your application configuration.

Template Functions

The dynamic configuration management functionality available throughout the Replicated YAML.

Admin Commands

Implementation guide for application vendors to provide customers with aliased CLI commands that can be performed in the containers across a cluster.

Support Bundle

Installed instances can generate a support bundle with relevant logs and instance information.

Preflight Checks

A guide to implementing the Preflight Checks feature to analyze customer systems to determine if the environment meets the minimum requirements for installation or update.

Custom Preflight Checks

A guide to implementing the Custom Preflight Checks feature to analyze customer systems to determine if the environment meets the minimum requirements for installation or update.

Snapshots

Guide to enabling application snapshots for backup and restore functionality.

LDAP and Identity Integration

Enabling LDAP and AD user auth and sync in an application through Replicated.

Kubernetes

Packaging a Kubernetes application in Replicated

Docker Swarm

Packaging a Docker Swarm application in Replicated