Modules

Introduction

Introduction to Facets modules: what they are, why they exist, and how they fit in the platform.

Module anatomy

This section explains the building blocks of a Facets module. You’ll learn how modules declare what they offer, what they require, and how they connect with others using a shared type system.

This section explains how to turn a module concept into a working Facets module. You'll define the module interface using `facets.yaml`, connect it to Terraform logic, and use the Facets CLI to scaffold and validate your work.

Form UI (X-UI Tags)

Use x-ui-* tags in module YAML to customise the Facets UI form for module configuration.

Defining Module Resource Actions

Define custom actions a module exposes: backup, restore, and custom workflows for the resource.

Versioning Strategy

Version modules safely: semantic versioning, breaking changes, and module promotion.

Module Registry

The module registry: where modules are stored, versioned, and discovered across teams.

Continuous Integration

Set up CI for module repositories to enforce quality across module updates.

Generate Modules via AI

This section explains how to turn a module concept into a working Facets Module in minutes.