Skip to content

MoveBigRocks/instance-template

Repository files navigation

Move Big Rocks Instance Template

This tree is the canonical Move Big Rocks instance-template layout for deploying Move Big Rocks, the AI-native service operations platform.

It is the canonical customer deployment-control-plane starting point inside the public Move Big Rocks core repo.

A private instance repo is the deployment control plane for one live Move Big Rocks installation. It should contain desired state, deployment policy, branding, and extension configuration. It should not contain a long-lived fork of the core source tree.

What This Source Tree Is

This source tree is:

  • the starting point for private instance repos such as acme/mbr-prod
  • the canonical home for the deployment-control-plane shape customers should use
  • the place agents and humans should read when they want to understand what belongs in an instance repo

This source tree is not:

  • the whole public core repo
  • a live DemandOps or customer instance
  • a place to store secrets
  • a place to author first-party paid extension source

Intended Use

  1. Create a private repo from this template structure.
  2. Fill in mbr.instance.yaml.
  3. Add repository and environment secrets.
  4. Open the repo in Codex or Claude Code.
  5. Point the agent at START_HERE.md.
  6. Let the agent deploy and operate the instance.
  7. Use scripts/read-instance-config.sh to validate and inspect the non-secret desired state.
  8. Use scripts/validate-extension-desired-state.sh before changing or deploying extensions/desired-state.yaml.
  9. Review the spec.fleet settings and run the manual Register Fleet workflow if this instance should be registered for support, grandfathering, or future commercial transitions.

See also:

Contents

  • mbr.instance.yaml Canonical desired state for one Move Big Rocks installation.
  • START_HERE.md Single-file handoff for Codex or Claude Code.
  • agents/bootstrap.md The first-run instructions an agent should follow.
  • branding/site.json Customer-owned branding and copy overrides.
  • extensions/desired-state.yaml Installed and planned extension refs.
  • .github/workflows/ Deployment, verification, and explicit fleet-registration workflows owned by the instance repo.
  • deploy/ Deploy scripts, service units, and host bootstrap assets owned by the instance repo.
  • security/ Threat-model and review materials for custom extensions.
  • scripts/read-instance-config.sh Canonical parser and validator for mbr.instance.yaml.
  • scripts/validate-extension-desired-state.sh Verifies that installed extension refs are real before deploy.

Operating Rules

  • Pin core releases instead of tracking arbitrary commits.
  • Pin extension artifact refs instead of storing proprietary extension source here.
  • Validate extension desired-state refs before merge or deploy.
  • Store custom extension source in separate repos.
  • Keep customer-specific secrets in GitHub Actions secrets or another secret manager, not in this repo.
  • Keep hosts, domains, artifact refs, buckets, and provider choices in mbr.instance.yaml.
  • Keep fleet registration explicit. Every instance repo carries spec.fleet, but registration remains a manual control-plane action and the heartbeat stays disclosed, coarse, and optional for the running core platform.
  • Default to one private instance repo only. Add a custom extension repo only when you are building custom extension logic.

Export Status

This tree already includes the deployment workflows, deploy assets, and config reader needed to materialize a working instance repo layout without manual copying.

You can materialize that repo layout locally with:

scripts/export-instance-template.sh /absolute/path/to/acme-mbr-prod

Validate it before or after export with:

make validate-instance-template

About

Template repo for a Move Big Rocks instance deployment control plane.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages