Skip to main content

Introduction and Setup

This topic provides a summary of the goals and outcomes for the tutorial and also lists the prerequisites to set up your environment before you begin.

Summary​

This tutorial introduces you to preflight checks. The purpose of preflight checks is to provide clear feedback about any missing requirements or incompatibilities in the customer's cluster before they install or upgrade an application. Thorough preflight checks provide increased confidence that an installation or upgrade will succeed and help prevent support escalations.

Preflight checks are part of the Troubleshoot open source project, which is maintained by Replicated.

In this tutorial, you use a sample Helm chart to learn how to:

  • Define custom preflight checks in a Kubernetes Secret in a Helm chart
  • Package a Helm chart and add it to a release in the Replicated vendor platform
  • Run preflight checks using the Helm CLI
  • Run preflight checks in the Replicated KOTS admin console

Set Up the Environment​

Before you begin, do the following to set up your environment:

  • Ensure that you have kubectl access to a Kubernetes cluster. You can use any cloud provider or tool that you prefer to create a cluster, such as Google Kubernetes Engine (GKE), Amazon Web Services (AWS), or minikube.

    For information about installing kubectl and configuring kubectl access to a cluster, see the following in the Kubernetes documentation:

  • Install the Helm CLI. To install the Helm CLI using Homebrew, run:

    brew install helm

    For more information, including alternative installation options, see Install Helm in the Helm documentation.

  • Create a vendor account to access the vendor portal. See Creating a Vendor Portal.

    note

    If you do not yet have a vendor portal team to join, you can sign up for a trial account. By default, trial accounts do not include access to Replicated KOTS. To get access to KOTS with your trial account so that you can complete this and other tutorials, contact Replicated at [email protected].

Next Step​

Get the sample Bitnami Helm chart and test installation with the Helm CLI. See Step 1: Get the Sample Chart and Test