Inputs
Inputs allow you to define customer provided values that can be used to configure your App.
Inputs are used to collect customer provider values for configuring your App.
Defining Inputs
Inputs are configured in a inputs.toml
file inside the root of your App Config directory.
Add Inputs to your App using the following configuration block
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 Config directory.
All Inputs are accessed using {{.nuon.install.inputs.<input-name>}}
.
Configuring Sandboxes
You can configure Sandboxes by using Inputs as var
s.
For example, to use the root_domain
Input, as a variable to configure the Sandbox:
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.
To use inputs in a Helm chart Component.
To use inputs in a Docker image.
App Input Groups
You can organize Inputs into Groups, which are useful for structuring how they are visualized in the installer. 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 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 a token to access a third party cloud provider or account
You can even use Inputs to manage resources from third party cloud providers.
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.
Currently, updating Inputs is only supported via our api.
We recommend avoiding adding backwards incompatible Input changes in the same App.