Orkestia
Blog
Cockpit app

App modules

The Modules tab of an app in Apps mode — the feature modules of an app, how each is released (a rollout flag, a minimum plan), and how to create or edit one

A module bundles one feature of an app: the permissions it adds, the audit events it records, and how it is released. The Modules tab of an app in Apps mode lists them and lets owners and admins create and edit them. It is for apps people sign in to, and it is the same registry as the Modules page of the web console.

Find it under Build, next to How it's built and Flags.

The list

A line counts the modules, how many are behind a flag and how many are plan gated. With modules to show, Search modules matches the name, the identifier, the flag and the plan, and the filter shows All modules, Behind a flag, Plan gated or Available to all.

Each card shows:

PartShows
Name and identifierThe name, and the identifier with its version (reports · v3)
CountsHow many capabilities and audit events it has
ReleaseFlag: when a feature flag guards it (it opens the app's Flags), or Always available, and From the plan when a minimum plan applies

An app with no modules says so and offers Create module.

Create or edit a module

New module (or Manage on a card) opens a sheet. Owners and admins can save; everyone else gets Details, read-only.

FieldMeaning
NameWhat people call it. Creating a module fills the identifier from it
IdentifierWhat integrations use. Lowercase letters, numbers and dashes, starting with a letter or number. It cannot be renamed, and a new module cannot reuse another's
Feature flagOptional. Names a flag that must be on for the module. Blank means no rollout flag
Minimum planEvery plan, Free, Starter, Pro, Business or Enterprise
CapabilitiesPermissions the module adds, such as documents.review. Type one and press Enter or Add; paste several separated by commas or new lines
Audit eventsEvents it records, such as document.reviewed
Advanced metadataA JSON object read by integrations

Problems show after the first attempt to save: a missing name, an identifier that is not valid or is taken, metadata that is not a JSON object. Saving is validated again by the platform, which says why when it refuses.

The platform has no way to delete a module. You can change one, and you can clear its flag or plan, but not remove it.

Modules and flags

A module's feature flag is a key; whether it is on for the app is set in Flags. Clearing the flag of a module makes it available without a rollout flag, and a missing flag is not off. Only an explicit off denies the module.