Getting started¶
Standing up the platform for a customer has two halves: the infrastructure the workflow depends on (identities, state, runner), and the landing-zone repository.
Almost all of it is created for you by the bootstrap in nrit-alz-bootstrap,
which also generates the customer repository from nrit-alz-customer-template.
In practice you run the bootstrap, fill in a handful of customer values, wire the
last few secrets, and open your first pull request.
Order of work¶
- Prerequisites: what must exist before the bootstrap runs, and what rights the operator needs.
- Bootstrap a customer: run the Terraform bootstrap that creates the state backend, OIDC identities, environments, runner, and the customer repository. The bootstrap reference has every variable and posture.
- The PR-ops engine: the two caller workflows, how they pin the engine, and what branch protection to set.
- Self-hosted runner and the engine GitHub App: the private runner, its image, and the App that authenticates the engine checkout.
- Secrets and variables: the full reference to wire up, in one place.
- First plan to first apply: the end-to-end walkthrough, from the bootstrap to an applied foundation.
For a file-by-file tour of the generated repository, see Repository anatomy.
New customer, fast path
Follow First plan to first apply. It runs the whole journey in order and links into the deeper pages only where a decision is needed.