Nuon Extension: render

Nuon Docs | Nuon Extension Docs

Nuon Extension: Utility to render app config files using an install's details from the ctl-api.

Installation

nuon ext install nuonco/nuon-ext-render

Usage

nuon render --file <template-path> [--install-id <id>]

Output is written to stdout:

nuon render --file config.tpl > config.yaml

Environment Variables

Variable	Required	Default	Description
NUON_API_URL	no	https://ctl.prod.nuon.co	API base URL
NUON_API_TOKEN	yes		API auth token
NUON_ORG_ID	yes		Organization ID
NUON_INSTALL_ID	no		Install ID (can also use --install-id with nuon render)

An install context is required to render templates. You must provide an install ID via NUON_INSTALL_ID or --install-id.

Use nuon render --help for all available flags and options.

Template Variables

Templates use Go's text/template syntax. The install state (from GET /v1/installs/{install_id}/state) is loaded under a root .nuon key, matching the convention used across nuon config files.

Example template:

region: "{{ .nuon.install_stack.outputs.region }}"
db_host: "{{ .nuon.components.rds_cluster.outputs.address }}"
image: "{{ .nuon.components.img_app.outputs.image.repository }}:{{ .nuon.components.img_app.outputs.image.tag }}"
auth_url: '{{ or .nuon.inputs.inputs.auth_issuer_url "https://default.auth.com" }}'

All Go template features are supported (or, eq, if/else, pipelines, etc.).

Development

Run locally

The run-local.sh script reads credentials from ~/.nuon (YAML-style key: value pairs) and exports them as NUON_ env vars:

./scripts/run-local.sh --file example.tpl --install-id <id>

Override the config file:

NUON_CONFIG_FILE=~/.nuon-staging ./scripts/run-local.sh --file example.tpl --install-id <id>

Build

./scripts/build.sh

Manual testing with env vars

export NUON_API_URL=https://ctl.prod.nuon.co
export NUON_API_TOKEN=<your-token>
export NUON_ORG_ID=<your-org-id>
export NUON_INSTALL_ID=<your-install-id>

GOWORK=off go run . --file example.tpl

For local extension testing with the Nuon CLI:

nuon render --file example.tpl