What is an Install?

When an Install is created, a Runner is initially created as a VM in the customer’s cloud and is responsible for deploying the Sandbox, Components, and Actions in your App in the correct order defined in the App Config.

Install Lifecycle

When an Install is created, the following are provisioned:
  • Runner - the Nuon-managed Runner as a VM that manages the Install.
  • Sandbox - the base infrastructure for networking and compute. e.g., Kubernetes cluster
  • Components - the parts of your App. e.g., Helm charts, Kubernetes manifests, certificates, load balancers
  • Actions - any operational tasks as shell scripts that can be run in the Install. e.g., health check
When an Install is deleted, each Component will be deleted in reverse order, according to its dependencies, and then the Sandbox is destroyed. The Runner is then deleted by deleting the configuration that was used to create it. e.g., deleting the AWS CloudFormation stack.

Install Management

The primary and recommended way to create and manage Installs is through the Dashboard. The Dashboard outputs the AWS CloudFormation stack link to share with the customer to create the Runner VM and kick off the Install process.

Changing Components

If you change a Component in an App Config that already has Installs, you need to re-deploy the Component to the Install in the Dashboard. A modal will prompt you to select the Build you want to use, which usually is the first one in the list sorted by build date in descending order.

Using the CLI

The cli exposes many operational commands to manage an Install. To see all available commands, run: nuon installs --help.

Pinning an Install

You can pin an Install, which will set it’s ID as a default argument to all Install commands. This is helpful to avoid having to pass -i to each command.
sh nuon nuon installs select
Each example below assumes you have run nuon installs select first.
To show the currently pinned Install:
sh nuon nuon installs current

Install Management Commands

Commands for creating, deleting and viewing Installs. Create an Install - create an Install for an AWS application, passing in one or more Inputs.
Creating Azure Installs is currently only supported using an installer, or our API.
--role=iam-role ```
</CodeGroup>

**List all Installs** - list an Install

<CodeGroup>```sh nuon nuon installs list ```</CodeGroup>

**Get an Install** - get an Install

<CodeGroup>```sh nuon nuon installs get ```</CodeGroup>

**Delete an Install** - Delete an Install

<CodeGroup>```sh nuon nuon installs delete ```</CodeGroup>

### Install Config Commands

Manage Installs with the help of
[Install Config files](/configuration-files#install-config).

**Sync** - syncs Installs defined in config files to Nuon. Existing installs are
updated, otherwise a new install gets created for the app.

<CodeGroup>
```sh nuon
nuon installs sync -a <app-name-or-id> -d <path-to-file-or-dir>
Generate Config - easily generate an Install config file for an existing Install.
nuon installs generate-config -i <install-name-or-id>
The following is an an example Install Config file:
name = "config_demo"
approval_option = "approve-all"

[aws_account] region = "us-east-1"

[inputs] sub_domain = "whoami" app_release = "v2.25.0"

Install Sandbox Commands

Commands for working with an Install’s Sandbox. Show Sandbox updates - show all updates to an Install’s Sandbox.
nuon installs sandbox-runs
Show Sandbox run logs - show logs for a specific Sandbox run.
nuon installs sandbox-run-logs -r <run-id>
Reprovision a Sandbox - reprovision the Sandbox with the latest configured Sandbox version for an App.
sh nuon nuon installs reprovision
Deprovision a Sandbox - Deprovision a Sandbox.
sh nuon nuon installs deprovision

Install Components

Each Component is deployed to an Install when it is first created. When a Component is created after an Install has been provisioned, it will automatically be deployed to it upon the first release. The Nuon CLI provides the following commands to manage install Components:
Each example here assumes you have run nuon installs select first.
Show Deploys - show deploys for an Install.
sh nuon nuon installs list-deploys
Deploy Logs - print logs for a deploy.
nuon installs deploy-logs -d <deploy-id>
Deploy Plan - print a deploy plan for an install.
nuon installs print-deploy-plan -d <deploy-id>