Skip to main content
Inputs are variable parameters used for configuring your app. Inputs can either be user facing or vendor facing. By default all inputs are vendor facing.

​
Defining Inputs

Inputs are configured in a inputs.toml file inside the root of your app directory. Add inputs to your App using the following configuration block
inputs.toml
# inputs

[[group]]
name = "network"
description = "Configure the install's network settings."
display_name = "Network"

name         = "vpc_id"
display_name = "VPC ID"
group        = "network"
description  = "ID of the VPC to install the app into."
default      = ""
required     = true
sensitive    = false

​
Customer facing inputs

A customer facing input is a parameters that can be tweaked by customer via stack inputs (AWS Cloudformation, Azure Bicep) during install creation or any time after that. To mark an input as customer facing mark the parameter user_configurable = true in the app input config. Example:
inputs.toml
[[input]]
name = "sub_domain"
display_name = "Sub Domain"
description = "The sub domain for the Whoami service"
group = "dns"
default = "whoami"
sensitive = false
type = ""
internal = false

user_configurable = true
Customer facing inputs cannot be modified via the vendor in any way, to modity the input value, customer must go to the install stack and update the input parameter. This triggers a callback to the install which then updates/deploys any/all components which depends on that particular input(s).

​
Configuration Using Inputs

Inputs can be used to configure both sandboxes and components. All inputs are made available via variable configuration. Inputs are defined in a inputs.toml file inside the root of your app directory. All inputs are accessed using {{.nuon.install.inputs.<input-name>}}.

​
Configuring Sandboxes

You can configure Sandboxes by using inputs as vars. For example, to use the root_domain input, as a variable to configure the sandbox:
sandbox.toml

# sandbox
terraform_version = "1.11.3"

[public_repo]
directory = "."
repo      = "nuonco/aws-eks-karpenter-sandbox"
branch    = "main"

[vars]
public_root_domain   = "{{ .nuon.inputs.inputs.root_domain }}"

​
Configuring Components

Depending upon the component type, you can use install inputs to configure components using Helm values, Terraform variables or environment variables. To use Inputs in a Terraform module.
components.database.toml
# terraform
type              = "terraform_module"
name              = "database"
terraform_version = "1.11.3"

[public_repo]
directory = "terraform"
repo      = "your-org/your-repo"
branch    = "main"

[vars]
DATABASE_PASSWORD = "{{.nuon.install.inputs.database_password}}"
DATABASE_HOST     = "{{.nuon.install.inputs.database_host}}"
To use inputs in a Helm chart Component.
components/helm-database.toml
# helm
type   = "helm_chart"
name   = "helm-database"
chart_name = "database"

[public_repo]
directory = "helm"
repo      = "your-org/your-repo"
branch    = "main"

[values]
DATABASE_PASSWORD = "{{.nuon.install.inputs.database_password}}"
DATABASE_HOST     = "{{.nuon.install.inputs.database_host}}"
To use inputs in a Docker image.
components/docker-build.toml
# docker-build
type   = "docker_build"
name   = "docker-build"

[public_repo]
directory = "."
repo      = "your-org/your-repo"
branch    = "main"

# use an input to pass in a docker registry password, when building an image
[vars]
docker_build_registry_password = "{{.nuon.install.inputs.docker_build_registry_password}}"

​
App Input Groups

You can organize inputs into groups, which are useful for structuring how they are visualized in the install. By default, all inputs are created in the default group. To create a group, and add an input to it, simply declare the group in your config or terraform and set the group field on any input belonging to it.
inputs.toml
# inputs
[[group]]
name         = "db"
description  = "Configuration for the database "
display_name = "Database configuration"

[[input]]
name         = "db_password"
description  = "Password to use for the database."
default      = ""
sensitive    = true
display_name = "Password"
group        = "db"

​
Inputs For Customer Resources

Inputs are commonly used to allow a customer to provide access to existing resources. For example, an input can be used for:
  • accepting a database url, or database ID to connect to
  • accepting a VPC ID to install an app into
  • accepting an existing S3 bucket name to use for storage
  • accepting an existing Kubernetes cluster ID to connect to
  • accepting a token to access a third party cloud provider or account
You can even use inputs to manage resources from third party cloud providers.

​
Inputs when Installing an App

When installing an app, the customer is presented with a modal form to fill out the inputs defined in the app’s inputs.toml file. Inputs

​
Updating Inputs

If you add a required input after an install is created, the inputs must be added to the install before it can process any new sandbox updates or component provision/deprovision jobs. Updating inputs
We recommend avoiding adding backwards incompatible input changes in the same app.