Writ

Overview

What Writ is, and where to find each page of the docs.

Writ is an open-source control plane for OpenTofu that you host yourself. You point writ serve at a Git repository of stacks. It plans the commits you or your CI job send it, waits for the approvals your rules require, and applies the plan it kept. Your CI jobs and laptops never hold a cloud credential or a state key.

Writ is at version 0. Status and limits lists what's built, how it's tested, and what's missing. Read it before you rely on Writ.

Start here

New to Writ? Follow the quick start. You'll plan and apply a stack on your own machine, with no cloud account, then set Writ up for a team.

If you want toRead
Try Writ on your machineQuick start
Get the writ binary or the container imageInstall
Run it for your teamRun a control plane, then the server config
Plan and apply from CISet up GitLab CI
Know what it can't do yetStatus and limits
Compare it with what you use todayOther control planes, or OpenTofu in plain GitLab CI

Concepts

How Writ works, and why it's built that way.

  • How the control plane works: how writ serve plans a commit, runs OpenTofu apart from its keys, keeps state, checks drift, and decides who can do what.
  • Repositories: how the control plane reads your code by commit.
  • Approvals: approval rules, who can approve, stale plans, and what each run records.
  • Secrets and the mask: how secrets stay out of everything writ serve stores or shows, and the cases the mask can't catch.
  • Policy: Rego policies that check each plan when it's created and again before its apply.

Guides

One task each, step by step.

Reference

Exact values, flags, routes, and messages.

Contribute

This page is built from docs/README.md in the repository. It is also served as plain Markdown.

On this page