openlakeforge AGENTS.md

A contributor guide for OpenLakeForge, a self-hosted data platform that runs open-source lakehouse components on Kubernetes. A lakehouse stores and processes data in layers, from raw CSV files through validated, modeled data to query and reporting tools.

In plain words
What is it for?
Use it when deploying, testing, documenting, or changing OpenLakeForge. It is especially relevant to teams running their own data platform with Terraform, Helm, Dagster, Trino, Iceberg, dbt, and Superset.
Why use it?
It explains the project's architecture, intended users, and required reading order before code changes. This helps agents understand how the many data, deployment, and orchestration components fit together.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/malon64/openlakeforge/agents-md
Clone the repo
git clone --depth 1 https://github.com/malon64/openlakeforge

Made for: Codex, OpenCode.

Per session 2,648 This file is loaded in full into every session.
When invoked 2,648 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.02648 $0.02648
Opus 5 $0.01324 $0.01324
Sonnet 5 $0.00530 $0.00530
Haiku 4.5 $0.00265 $0.00265

Measured 2d ago against content hash a8d23d75b067, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

openlakeforge AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 209 lines

How it starts

The opening of the file, as written. The whole thing — 209 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Agent and contributor guide

This is the working guide for anyone changing OpenLakeForge — human or coding agent. It records what the repository actually enforces today. If a statement here disagrees with the code, the code wins and this file is a bug.

CLAUDE.md points here. There is one copy of these rules on purpose.

What this project is

OpenLakeForge is a cloud-agnostic, self-hostable lakehouse platform: open-source components assembled on Kubernetes with Terraform and Helm. The data path is CSV → Bronze → Floe validation → Silver Iceberg through Polaris → dbt-trino Gold → Trino → Superset, orchestrated by Dagster.

The audience is small data teams self-hosting a complete lakehouse. Runtime footprint, onboarding friction, and recoverability are product features here, not polish — a team without a platform engineer cannot absorb a stack that needs one. v0.2-alpha is scoped around exactly that; see the roadmap.

Orientation — read in this order

  1. README.md — stack, deployment targets, local workflow
  2. docs/industrialization-roadmap.md — milestones, release gates, what is delivered and what is not
  3. docs/architecture/overview.md and docs/architecture/provider-contracts.md
  4. docs/adr/README.md — the decision log index; each ADR describes what binds today, all worth reading
  5. docs/technical-debt.md — the live debt register with a fix path per item
  6. docs/architecture/diagrams/README.md — pod census and runtime topology

Current work is tracked in GitHub milestones. Issues carry priority: P0/P1/P2 labels expressing intended sequence within a milestone.

Repository map

Path Contains
lakehouse_code/bronze/<source>/ Source-owned: source.yaml descriptor plus dlt extract
lakehouse_code/silver/<domain>/ Domain-owned: Floe contracts and transformations
lakehouse_code/gold/<product>/ Product-owned: dbt project
lakehouse_code/dashboards/superset/<dashboard>/ Consumption-owned: Superset reports
lakehouse_code/pipelines/dagster/ User-maintained Dagster orchestration code
lakehouse_code/lakehouse.yaml Canonical domain/product business metadata descriptor
openlakeforge.yaml Project-root Deployment Profile v1; parsed and resolved by olf profile validate/resolve (ADR 0011)
libs/ Shared runtime Python imported by the project-code image
packages/domain-model/ Canonical provider-neutral descriptor and inventory package
tools/olf/ The olf CLI — uv-managed deploy tooling, contracts, artifacts, scaffolding, e2e
infra/terraform/environments/ Per-environment wiring; contracts.tf is the contract surface
infra/terraform/foundations/ Cluster and registry creation (kind, AKS, EKS)
infra/terraform/modules/ Component modules grouped by capability
infra/helm/values/local/ Helm values for the local profile
images/project-code/ The Dagster runtime image
release/component-catalog.yaml Immutable version, digest pins, and the distribution version contract both pyproject.toml files must match
docs/schema/lakehouse.schema.json, docs/schema/source.schema.json Schemas lakehouse.yaml and source.yaml validate against
docs/schema/deployment-profile.schema.json Schema openlakeforge.yaml validates against

Read the full file on GitHub · 209 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 209 lines · 2,648 tokens per session scan A a8d23d75b067

Subscribe to this mod's changes

openlakeforge AGENTS.md is an instructions file published in the GitHub repository malon64/openlakeforge (22 stars, last pushed 2d ago), licensed Apache-2.0. It adds 2,648 tokens to every session, about $0.0132 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.