Skip to content

Reference

Reference states exact facts, to look up, and does not teach.

Pages:

  • Artifacts: the @asset options, limits, commands, SDK, REST routes, permissions and audit events of the artifact store.
  • Package indexes: the record, the sources a lock may name, commands, SDK, REST routes, permissions and audit events.
  • Checks: the files, the keys, every refusal at deploy, the outcomes, commands, routes, permissions and audit events of data quality checks.
  • Descriptions: the two sources of a table's and a column's description, commands, SDK, REST routes, rights and audit events.
  • Table health: the numbers of a table's snapshot, its last maintenance, the newest result of each check and who reads it; the fields, the rules, the settings, commands, SDK and routes.

  • Search: what is matched, the ranking, who sees what, the route, the command, the SDK and how the columns of existing tables are filled in.

  • Runs, queries and deploys lists: the filters, the order and the cursor of the three lists, the refusals, commands, SDK and routes.

  • Grants, permissions, principals and groups: the grants list and its filters, a principal's permissions and how they are decided, searching principals and groups, the refusals, commands, SDK and routes.

  • Why did it fail?: the stable failure codes of a task, what each means and what to do, where they appear and what old runs show.

  • Jobs: the triggers of a job, the fields of the job listing, routes, commands and SDK.

  • Command line: every lakana command and sub-command with its arguments and options. Generated from the code.

  • Settings: every LAKANA_* environment variable with its type, default, reader and description. Generated from the code.

  • Project layout: the files a deploy reads and the table names they give.

  • Asset front-matter: every key of the /* lakana */ block of an asset.
  • lakana.yaml: defaults, requirements, jobs, notifications, check defaults, retries and per-environment overrides.
  • Python assets: the rules, what a deploy checks, what a task may do, failures and the operator's settings.
  • Network settings of the worker: git and webhook proxies and CA files.
  • The Compose bundle: the keys of .env, the services and the settings an operator changes most.

Pages are added here as they are written.