README
¶
Nuon
Nuon is an open-source platform for software vendors to deploy and operate their software in their customers' cloud accounts.
This software category is called Bring Your Own Cloud (BYOC).
What is Nuon?
Historically there have been two ways to deploy any software vendor's product: SaaS (in the vendor's cloud) and self-hosted (the customer manually installs the vendor's software in their cloud).
But some customers have compliance and regulatory reasons that require some or all of the vendor's software be installed in the customers' cloud accounts. Customers who self-host would also prefer if the software vendor installed and managed their software versus managing the complexity themselves.
Now there is an emerging deployment alternative called Bring Your Own Cloud (BYOC) where the software vendor installs and manages their software - in their customers' cloud accounts.
Nuon is a platform that software vendors can use to quickly and securely offer BYOC to their customers.
Getting started
The fastest way to get started with Nuon is to sign up for a free trial on Nuon Cloud.
The docs for creating your first app are here. Nuon maintains a list of example apps to test Nuon and install them into AWS. We will add more examples that install into Azure and Google Cloud.
Deployment options
Nuon supports three deployment models:
- Nuon Cloud — Fully managed, multi-tenant SaaS hosted by Nuon. The fastest way to get started; sign up for a free trial.
- Nuon BYOC — Single-tenant Nuon control plane deployed into your AWS account, managed remotely by Nuon. You own the infrastructure and data. See the BYOC docs.
- Nuon Self-Hosted — Deploy and operate Nuon entirely within your own infrastructure, with no dependency on Nuon Cloud. Supported on AWS. See the self-hosted docs.
See the full deployment options guide for a detailed comparison.
Documentation
Browse our docs here or visit a specific section below:
- Concepts: apps, components, actions, inputs, installs, workflows
- Architecture: control plane, runner, CLI, API
- Deployment options: Nuon Cloud, Nuon BYOC, and Nuon Self-Hosted
- Guides: technical info on component types, actions, variables, and more
Also browse the Nuon blog for technical posts on specific features and example app guides.
Support
Have a technical question? Instead of opening a GitHub issue, please ask in
our Community Slack in
particular the help channel.
Enterprise
Dedicated support and additional security and governance features are available for an annual license fee. Check out our enterprise features here.
Changelog
When Nuon does a promotion to Nuon Cloud, we publish a changelog of new features.
Contributors
Review our contributing guidelines here.
Made with contrib.rocks.
Directories
¶
| Path | Synopsis |
|---|---|
|
bins
|
|
|
cli
command
|
|
|
cli/internal/services/labels
Package labels provides a shared parser for kubectl-style label arguments used by `nuon installs label`, `nuon components label`, and `nuon actions label`.
|
Package labels provides a shared parser for kubectl-style label arguments used by `nuon installs label`, `nuon components label`, and `nuon actions label`. |
|
cli/internal/services/orgs/subscriptiontui
pickers.go houses the data-driven entity pickers that fire after the main subscription form (tui.go) when the user selects "specific" for a given kind.
|
pickers.go houses the data-driven entity pickers that fire after the main subscription form (tui.go) when the user selects "specific" for a given kind. |
|
cli/internal/ui/bubbles
Package bubbles owns the CLI's small reusable terminal-UI primitives.
|
Package bubbles owns the CLI's small reusable terminal-UI primitives. |
|
cli/internal/ui/v3
command
|
|
|
cli/internal/ui/v3/action/run/steps
This run.go file contains a stub used to render the step component in a standalone way.
|
This run.go file contains a stub used to render the step component in a standalone way. |
|
cli/internal/ui/v3/common
Package common provides utilities for v3 UI components.
|
Package common provides utilities for v3 UI components. |
|
lsp
command
|
|
|
runner
command
|
|
|
runner/internal/pkg/op
Package op provides the primitive used to wrap individual tool / SDK call sites so the runner can build a tool-call graph for each job execution.
|
Package op provides the primitive used to wrap individual tool / SDK call sites so the runner can build a tool-call graph for each job execution. |
|
composite_error
Package composite_error defines the typed, catalogable error abstraction used across the Nuon platform.
|
Package composite_error defines the typed, catalogable error abstraction used across the Nuon platform. |
|
composite_error/catalog
Package catalog is the in-memory registry for CompositeError types and Parsers, populated via init() blocks in per-type packages.
|
Package catalog is the in-memory registry for CompositeError types and Parsers, populated via init() blocks in per-type packages. |
|
composite_error/unknown
Package unknown is the always-last fallback CompositeError type, shipped as a builtin so that every recorded incident has a typed, catalog-registered representation even when no parser matches.
|
Package unknown is the always-last fallback CompositeError type, shipped as a builtin so that every recorded incident has a typed, catalog-registered representation even when no parser matches. |
|
gen/markdown-docs
command
|
|
|
gen/temporal-gen-v2
command
|
|
|
gen/temporal-gen-v2/lib
Package temporalgen provides a library interface for temporal-gen-v2.
|
Package temporalgen provides a library interface for temporal-gen-v2. |
|
helm/operations
TODO: Is this file needed?
|
TODO: Is this file needed? |
|
labels
Package labels' match.go defines the SubscriptionMatch shape persisted as a nullable JSONB column on slack_channel_subscriptions.
|
Package labels' match.go defines the SubscriptionMatch shape persisted as a nullable JSONB column on slack_channel_subscriptions. |
|
oci/dockerhub
Package dockerhub provides utilities for working with Docker Hub references.
|
Package dockerhub provides utilities for working with Docker Hub references. |
|
policies
Package policies derives stable filenames for Kubernetes policy manifests shipped through the Nuon sandbox Terraform module.
|
Package policies derives stable filenames for Kubernetes policy manifests shipped through the Nuon sandbox Terraform module. |
|
principal
Principal package contains operations related to nuon entity principals like components, actions, sandboxes etc
|
Principal package contains operations related to nuon entity principals like components, actions, sandboxes etc |
|
terraform/binary/local
Package local implements a binary.Binary that points at an existing terraform CLI binary on disk.
|
Package local implements a binary.Binary that points at an existing terraform CLI binary on disk. |
|
ui
1.
|
1. |
|
wasm/wrt
Package wrt provides Nuon's standard WASM runtime for executing WebAssembly modules.
|
Package wrt provides Nuon's standard WASM runtime for executing WebAssembly modules. |
|
sdks
|
|
|
nuon-go
module
|
|
|
nuon-runner-go
module
|
|
|
services
|
|
|
ctl-api
command
|
|
|
ctl-api/cmd/gen
command
|
|
|
ctl-api/cmd/nuontest
command
|
|
|
ctl-api/internal/app/slack/service
Package service exposes the org-scoped, dashboard-facing public API for the Slack integration: enumerating installations linked to an org, listing / creating channel subscriptions, and kicking off the OAuth install flow.
|
Package service exposes the org-scoped, dashboard-facing public API for the Slack integration: enumerating installations linked to an org, listing / creating channel subscriptions, and kicking off the OAuth install flow. |
|
ctl-api/internal/pkg/interests
Package interests defines the shared "what events do you want?" model used by both Slack channel subscriptions and webhooks.
|
Package interests defines the shared "what events do you want?" model used by both Slack channel subscriptions and webhooks. |
|
ctl-api/internal/pkg/operation-roles
operationroles implements various rules around what role to use for a particular operation
|
operationroles implements various rules around what role to use for a particular operation |
|
ctl-api/internal/pkg/queue/catalog/allsignals
Package allsignals imports all signal packages to trigger their init() registrations into the signal catalog.
|
Package allsignals imports all signal packages to trigger their init() registrations into the signal catalog. |
|
ctl-api/internal/pkg/queue/signal/hooks/slackrender
Package slackrender renders Slack message text and blocks for Nuon workflow / workflow_step / workflow_step_approval lifecycle events.
|
Package slackrender renders Slack message text and blocks for Nuon workflow / workflow_step / workflow_step_approval lifecycle events. |
|
ctl-api/internal/pkg/slack/client
Package client is a thin Slack Web API client scoped to the surface area the Nuon slackbot integration needs:
|
Package client is a thin Slack Web API client scoped to the surface area the Nuon slackbot integration needs: |
|
ctl-api/internal/pkg/slack/signing
Package signing implements verification of incoming Slack webhooks.
|
Package signing implements verification of incoming Slack webhooks. |
|
ctl-api/internal/pkg/slack/statejwt
Package statejwt encodes and decodes the OAuth `state` parameter used in the Slack install / link flows.
|
Package statejwt encodes and decodes the OAuth `state` parameter used in the Slack install / link flows. |
|
ctl-api/internal/pkg/stacks/aws
Package aws renders the install-stacks/aws Terraform module's tfvars file for an AWS install.
|
Package aws renders the install-stacks/aws Terraform module's tfvars file for an AWS install. |
|
dashboard-ui/server
command
|
|
Click to show internal directories.
Click to hide internal directories.