Skip to content

Manifest reference

mithran.yaml is the committed app contract read by Forge and validated by aegis forge init. Version 0.9.4 validates map.mithran/v1 and retains valid forge.mithran/v1 manifests for existing repositories.

Shape

apiVersion: map.mithran/v1
kind: MithranApp
metadata:
  app_id: my-app
  name: my app
  description: optional short description
  tags: [optional, tags]
identity:
  project_ref: owner/my-app
capabilities:
  - kind: http
    route: /
    runtime: static
    startup:
      command: python3 -m http.server 8000

Fields

Field Required Meaning
apiVersion yes Must be map.mithran/v1.
kind yes Must be MithranApp.
metadata.app_id yes Stable application identifier.
metadata.name yes Display name.
metadata.description, metadata.tags, metadata.domain, metadata.labels no Descriptive metadata.
identity.project_ref yes Repository identity, normally owner/repo.
identity.environment no Environment label, when the app declares one.
capabilities no List of runtime capabilities.
capabilities[].kind yes http, worker or scheduler.
capabilities[].route for http and scheduler Route the capability serves.
capabilities[].runtime yes Runtime name, such as static.
capabilities[].startup.command yes Command that starts the process.
resources.requests, resources.limits, resources.concurrency, resources.replicas no Optional resource declarations.
non_secret_env no Non-secret environment variables as name/value pairs.
secret_bindings no Bindings to secrets held outside the repository.
oauth_api, public_edge, app_env no Typed exposure, OAuth and per-environment declarations.

Metadata and nested objects reject unknown fields. An unknown top-level field is also an error.

Removed legacy fields

These were part of an earlier manifest and are refused with a specific finding:

  • public_api — use oauth_api.
  • public — use oauth_api and typed public_edge.
  • body_size_limit_mb — has no direct v1 equivalent.
  • live_grants, roles, grants — live access belongs to control-plane state, not the manifest.

What the manifest does not select

The manifest does not choose environment, tenant, account, installation or app identity. Authorization and repository context derive those values, and the CLI exposes no selector for them. Automation may select only repository, ref or commit.

The public v1 contract has no port field and no readiness-probe field. The runtime name and startup.command describe how the process starts; see HTTP app contract.

Do not store credentials or private keys in the manifest. Use the approved secret channel when a runtime needs a secret, and review the manifest with the source and the commit you deploy.