Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 3.44 KB

installing-embedded-automation.mdx

File metadata and controls

64 lines (42 loc) · 3.44 KB

import ConfigValuesExample from "../partials/configValues/_configValuesExample.mdx" import ConfigValuesProcedure from "../partials/configValues/_config-values-procedure.mdx"

Automating Installation with Embedded Cluster

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.

Overview

A common use case for installing with Embedded Cluster from the command line is to automate installation, such as performing headless installations as part of CI/CD pipelines.

With headless installation, you provide all the necessary installation assets, such as the license file and the application config values, with the installation command rather than through the Admin Console UI. Any preflight checks defined for the application run automatically during headless installations from the command line rather than being displayed in the Admin Console.

Prerequisite

Create a ConfigValues YAML file to define the configuration values for the application release. The ConfigValues file allows you to pass the configuration values for an application from the command line with the install command, rather than through the Admin Console UI. For air-gapped environments, ensure that the ConfigValues file can be accessed from the installation environment.

The KOTS ConfigValues file includes the fields that are defined in the KOTS Config custom resource for an application release, along with the user-supplied and default values for each field, as shown in the example below:

Online (Internet-Connected) Installation

To install with Embedded Cluster in an online environment:

  1. Follow the steps provided in the Vendor Portal to download and untar the Embedded Cluster installation assets. For more information, see Online Installation with Embedded Cluster.

  2. Run the following command to install:

    sudo ./APP_SLUG install --license-file PATH_TO_LICENSE \
  --config-values PATH_TO_CONFIGVALUES \
  --admin-console-password ADMIN_CONSOLE_PASSWORD

    Replace:

    • APP_SLUG with the unique slug for the application.
    • LICENSE_FILE with the customer license.
    • ADMIN_CONSOLE_PASSWORD with a password for accessing the Admin Console.
    • PATH_TO_CONFIGVALUES with the path to the ConfigValues file.

Air Gap Installation

To install with Embedded Cluster in an air-gapped environment:

  1. Follow the steps provided in the Vendor Portal to download and untar the Embedded Cluster air gap installation assets. For more information, see Air Gap Installation with Embedded Cluster.

  2. Ensure that the Embedded Cluster installation assets are available on the air-gapped machine, then run the following command to install:

    sudo ./APP_SLUG install --license-file PATH_TO_LICENSE \
  --config-values PATH_TO_CONFIGVALUES \
  --admin-console-password ADMIN_CONSOLE_PASSWORD \
  --airgap-bundle PATH_TO_AIRGAP_BUNDLE

    Replace:

    • APP_SLUG with the unique slug for the application.
    • LICENSE_FILE with the customer license.
    • PATH_TO_CONFIGVALUES with the path to the ConfigValues file.
    • ADMIN_CONSOLE_PASSWORD with a password for accessing the Admin Console.
    • PATH_TO_AIRGAP_BUNDLE with the path to the Embedded Cluster .airgap bundle for the release.