Configuration Canvas

Overview

A configuration (the portal also calls it a canvas) is one versioned, reviewable set of settings for one configuration type of an installed app, for example a Splunk index definition or an Okta group. You author it in a form-style editor, Veltrix validates it with the app's own validator, named reviewers approve it, and only then can it be deployed. Every save is recorded as a version you can compare and restore.

The fields you see in the editor are not fixed by the platform. They come from the app that owns the configuration type (its canvas.yaml template), so each app presents its own sections and field types. This page covers everything that is the same for every app.

Where to find it

• Apps in the sidebar, open an installed app, then pick a configuration type from the app's own navigation. The route is /apps/<app>/config/<configuration-type>.
• The app's Pipeline entry (/apps/<app>/pipeline) lists the configurations of every type in one table; see Pipeline & Environments.
• If a configuration type is not listed, the app is not installed or enabled for your organization. Manage apps from Marketplace.

The lifecycle in one line

Draft, then Validate, then Approve, then Deploy, then Live. Editing a configuration after it has been submitted, approved or deployed sends it back to Draft and clears its approvals, so what was approved is always exactly what is deployed. The full status list is in Statuses and lifecycle.

The configuration list

Opening a configuration type shows its configurations as a table.

Search, filter, sort

• Search matches the configuration name or description.
• Status filter lists only the statuses currently present in the list; Environment filters by an assigned environment. Clear all resets both.
• Sort by Name, Status, Version or Updated, ascending or descending. The default is Updated, newest first.
• Pagination defaults to 10 rows per page and the page size can be changed. The refresh button reloads the list.

Row actions

The details window

Clicking a name opens a window with three tabs, and a footer that repeats the row actions (plus Roll back for Deployed and Deploy failed configurations; Roll back appears when the window is opened from a configuration type page, not from the app's Pipeline page).

• Details: the description, every section and field value, a Deployed resources block when the last deployment produced output (secret values are masked, with reveal and copy buttons), and the Change / Issue tickets panel. A red banner shows the last deployment error when the status is Deploy failed.
• Pipeline: the promotion stages for this configuration. See Deployment flows.
• Drift: drift records for this configuration, with the count of unresolved records in the tab label. See Drift Detection.

Creating and editing

1. Choose New configuration (or Create your first configuration on an empty list), or Edit on a row. The editor opens in place with a Back to <type> button.
2. Fill in the sections and fields.
3. Choose Environments and, where shown, Target Servers or Domain(s) (below).
4. Choose Save. A new configuration is created as Draft at version 1.

Toolbar

Sections, items and fields

• A configuration type can define a repeatable item, such as one index or one rule. The type's label is used on the buttons: Add <item>, Duplicate this <item>, Delete this <item>.
• The type sets limits. If it allows only one item, or a maximum, the add and duplicate buttons are disabled with a reason in the tooltip. Delete is disabled once you are at the type's minimum (at least one item by default).
• Field types the editor supports: text, number, select, multi-select, checkbox, text area, tags, password, path, files, key/value, and remote select and multi-select (options loaded live from the connected tool).
• Fields can be shown or hidden depending on another field's value; hidden fields are not validated.
• Field checks include required, minimum and maximum length or value, and pattern. Messages appear under the field.
• Password fields are masked. Version snapshots never store the secret, only a redaction marker.

Targets

A deployment also needs a connection: a registered server of the type the configuration targets, located in the configuration's environment.

Statuses and lifecycle

Rules that apply to every configuration

• Editing resets approval. A change to values, fields, environments or targets on a configuration that is past Draft returns it to Draft and clears the approval records. Saving with no change does not reset anything.
• Deploy needs an approval, or a retry. Deploy is enabled for Approved, Deploy failed and Rolled back configurations. Organizations on the Free plan, and environments whose Controls turn off Require approval before deploying, do not need the approval step.
• Edits are blocked while over quota. If your plan was downgraded and you hold more configurations than the new limit, existing ones cannot be edited until you delete the excess or upgrade. Reading and deleting still work.

Approvals and reviews

Submit for approval

1. On a Draft configuration choose Submit for approval (a row action, or in the details window).
2. In Target Environment(s) pick at least one environment; any already set on the configuration are preselected.
3. In Approver(s) search your users by name or email and tick at least one. Chosen approvers appear as removable chips.
4. Optionally add a Comment. It is shown to reviewers as the description of the change.
5. Choose Submit for Approval. The status becomes Pending approval.

Approvers must belong to your organization. The submit button stays disabled until an environment and an approver are chosen.

Reviewing

Reviewers open Reviews & comments on the row. The drawer has three parts.

• Reviewers: the description, an Approved N/M badge, and each reviewer's status (pending, approved or rejected), comment, environments and response date. A pending reviewer sees Approve and Request changes. Requesting changes needs a written reason and moves the configuration to Changes requested immediately.
• Commits & Changes: the version timeline and diffs (next section).
• Discussion: threaded comments. Use the version selector to anchor comments to a particular version, reply to a comment, and mark a thread resolved. The author of a comment, or an assigned reviewer, can resolve or delete it.

When the author has made changes, Re-request review opens the same dialog. Reviewers who already approved keep their approval; only those who requested changes are reset to pending, and you can add reviewers.

When does a configuration become Approved?

• The platform finds the approval policy of the target environment (the app's deployment flow settings first, then the environment's own Controls). If there is one, the configuration is approved once at least the minimum number of approvers have approved, every required role is held by at least one approving reviewer, and nobody has requested changes.
• If no policy applies, every assigned reviewer must approve.
• Where to set these: Environments, Controls.

Version history and diffs

Each save, submission, approval, rejection, deployment and restore adds a version. In the Reviews drawer, Commits & Changes shows them as a timeline.

Restoring

• Choose Revert to This Version on an entry that has a restorable snapshot. The server restores only Draft configurations; for any other status you get the message "Only draft canvases can be restored".
• A restore creates a new version rather than rewriting history.
• Password values are never in a snapshot. A restore keeps the live value of a password field that still exists, and clears one that does not.

How long history is kept depends on your plan's audit retention (Starter 30 days, Professional 90 days, Enterprise 365 days).

Plans, permissions and limits

Creating or duplicating a configuration past your limit fails with "Canvas limit reached" for your tier. Your organization's limits can be adjusted by Veltrix, so the usage view in Billing is the authoritative number for your account.

Permissions

The permission can be granted platform-wide or scoped to one app, so a role can be limited to the configurations of a single app. Roles are managed in Access Control. API keys follow the role they are bound to.

Gotchas

• The Deploy button greys out for a reason, shown in its tooltip: approval missing, no environment assigned, no matching connection in that environment, or no domain chosen.
• Deploy targets the first environment on the configuration. Put the intended environment first.
• Validation only runs from Draft or Validation failed. A configuration that is Pending approval or Approved cannot be re-validated until it is edited.
• Only Draft configurations can be deleted from the portal. Use Duplicate to keep a copy before you change something large.