User Terms

System Components

Processes

Glossary

Nuon documentation

Nuon is a platform for creating BYOC applications.

Introduction

Get up and running with Nuon in a few minutes.

Quickstart

Learn how to package an app for BYOC distribution.

Create Your First App

Learn how the Nuon platform can help you create a BYOC offering.

Why Nuon?

Learn why BYOC is becoming the standard delivery model for many applications.

Why BYOC?

Learn more about Nuon's usage based pricing model.

Pricing

Runner Architecture

Configure apps using a single `.toml` file

Configuration Files

Integrate with different SDKs to embed Nuon in your product.

SDKs

Concepts

Package your existing application code and infrastructure to create bring-your-own-cloud installable versions of your product.

Apps

Connect and configure your application using your existing container images, infrastructure as code, and DevOps automation.

Components

Installs are instances of an application in a customer cloud account.

Installs

Automate operational tasks and workflows in installs.

Actions

Installers provide a UI your customers can use to install your app.

Installers

You can deploy existing apps that use Kubernetes, AWS ECS, AWS Lambda or anything that can be containerized. We are currently testing Azure support with a handful of early customers.

Supported Platforms

Runners are responsible for deploying, updating and managing installs.

Runners

Sandboxes manage the base layer infrastructure for your application in each customer's cloud account.

Sandboxes

App inputs allow you to define customer provided values that can be used to configure your app.

App Inputs

App secrets allow you to define secrets for an app, that can be used for configuration

App Secrets

Connect your GitHub account to use both public and private repositories in your Nuon apps.

Connect GitHub

Docker build  components allow you to connect a Dockerfile that will be used to build a container image.

Docker Build Components

Container image components allow you to use prebuilt container images.

Container Image Components

Terraform components allow you to provision infrastructure in your customer's cloud account to power your install.

Terraform Components

Helm chart components allow you to connect an existing Helm chart and deploy it into your customer's cloud account.

Helm Chart Components

Component dependencies allow you to create dependencies between components, and model your app as a graph.

Component Dependencies

Remotely execute custom workflows in installs.

Learn how to grant permissions to Nuon create installs in you or your customer's cloud account.

Install Access Permissions

Use your own IAM roles with customers, using install access delegation

Install Access Delegation

Learn how to create and manage installs using installers, sdks, the cli and more.

Create Installs

Create Builds

Create Releases

Using variables with your Nuon configurations.

Using Variables

Use READMEs to support operating installs.

Using READMEs

How to install an app into customer-provided network.

Bring your Own Network

Custom Domains

Create BYOC apps that can be deployed to customer cloud accounts.

Azure Support

How to test your app without creating real cloud resources.

Sandbox Orgs

Team Management

Notifications

Automatically update your apps from GitHub Actions.

GitHub Actions

Get started using the Nuon API endpoints.

Getting Started

get all apps for the current org

create an app

get an app

delete an app

update an app

App input configs allow you to declare the inputs for your application, and do things such as require customer inputs or 
expose configuration knobs in your application.


get latest app input config

create an app sandbox config

get app sandbox configs

get latest app sandbox config

get all components for an app

get all components for an org

get a component

update a component

create component build

get latest build for a component

Returns builds for one or all components in an app.


get a build for a component

get all configs for a component

create a docker build component config

create an external image component config

create a helm component config

get latest config for a component

create a terraform component config

create an installer

get an installer

delete an installer

get all installs for an app

create an app install

Forget an install that has been deleted outside of nuon.

This should only be used in cases where an install was broken in an unordinary way and needs to be manually deleted so the parent resources can be deleted.


get an install

get all installs for an org

delete an install

update an install

get an install component

get an installs components

get an install components deploys

get the latest deploy for an install component

deploy a build to an install

get an install deploy

get install deploy plan

get an installs inputs

create install inputs

Updates install input config for app

get an installs current inputs

get an installs sandbox runs

get all releases for an app

get all releases for a component

create a release

get a release

Get config for cli

Get current user

Return current user's orgs

create a new org

Get an org

Delete an org

Update current org

Add a user to the current org

get all vcs connected repos for an org

public connection to create a vcs connection via a callback

get vcs connection for an org

create a vcs connection for Github

returns a vcs connection for an org

Roadmap

Follow along with features, updates and improvements made to Nuon.

Changelog

Rename apps, add metadata, notifications and more.

011 - App metadata and notifications

Better support for apps with many customer inputs.

010 - Input Groups, App Secrets and more

Split large app configs into multiple files, better variable support and validation.

009 - Config file improvements

Fork our installer UI and customize it, and build it into your product.

008 - Self Hosted Installers

007 - Nuon Installs UI

006 - Config Files

We have reworked our installers, added a new guide, and reworked some internal infrastructure.

005 - All new installer experience

Integrate Nuon into your workflow and product using our GitHub Actions and SDKs.

004 - GitHub Actions and SDKs

Deploy apps without kubernetes, long live kubernetes!

003 - ECS Support

We shipped a new docs site, and cli login.

001 - New Year, New Docs

Support

Setup Nuon's Terraform provider to manage application configuration.

Terraform provider

Concepts for working with the Nuon platform.

Gain a basic understanding of what Nuon is and how it works.

Nuon Actions

Learn how to perform tasks using the Nuon platform.

Guides

Job components are used to execute tasks inside of an install.

Job Components

How to handle migrations with a BYOC app.

Migrations

Manage your application configuration using Terraform.

Terraform Configuration Management

Integrate with the Nuon platform from your application code.

SDK integration

Learn about new product updates, and what we are working on.

Term	Definition
Vendor	A BYOC software provider.
Customer	A BYOC software consumer.
Customer Account	The cloud account where a Vendor deploys a BYOC App. Owned by their Customer.

Term	Definition
Nuon Platform	The software that we provide to Vendors and Customers to support providing and consuming BYOC applications.
Nuon Control Plane	The part of the Nuon platform that orchestrates jobs for runners.
Nuon Runner	The part of the Nuon platform that executes jobs. The runners being orchestrated by the Nuon Control Plane can collectively be considered the Data Plane.
Organization	A business unit that operates Apps and Installs. A Vendor will be given one or more Orgs to use.
App	A BYOC application, composed of a sandbox, inputs, components, and actions. Provided by a Vendor to a Customer.
Build	An OCI artifact packaging a Component. Stored in a private OCI registry alongside the Nuon Control Plane.
Inputs	A Vendor-defined input for an App, that can be set by a Customer when creating an Install. Input values can be used by the Sandbox, Components, and Action Workflows of the App.
Sandbox	The “root” component of an App. Defines the base infrastructure required by the App Components.
Component	Part of an App. Nuon supports Terraform modules, Helm charts, Docker files, and container images. Can be deployed and updated independently of the rest of the app.
Action Workflow	A series of commands, defined by a Vendor, that can be run in an Install.
Build Runner	A Nuon Runner that builds docker images and packages OCI artifacts for Install runners to pull. Deployed alongside the Nuon Control Plane, but technically part of the Data Plane. Single-tenant.
Install Runner	The Nuon Runner deployed in the Customer Account for an Install. It executes tasks to sync artifacts, provision, maintain, and deprovision the sandbox and components, and run actions in the Install. Single-tenant.
Install	A single-tennant deployment of a BYOC app. Typically deployed into a cloud account owned by a Customer.

Term	Definition
Provision	The process of creating an Install in a Customer’s cloud account.
Reprovision	The process of re-creating an Install in a Customer’s account. Basically a factory reset of the Install.
Deprovision	The process of removing an Install from a Customer’s account.
Sync	The process of copying a Build from the Control Plane’s registry to an Install’s registry.
Sandbox Run	The process of provisioning the Sandbox in an Install.
Component Deploy	The process of provisioning a Component in an Install.
Action Workflow Run	The process of executing an Action Workflow in an Install.
Release	A process that orchestrates Deploys of a Component in one or more Installs.

​User Terms

​System Components

​Processes

User Terms

System Components

Processes