Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

project

Project metadata, corresponding to the project: section of the manifest.

The name field must match the pattern ^[a-z][a-z0-9_-]{0,31}$ and is validated by [Manifest::validate]. It is used by the runtime as a prefix for container and network names, and by lightshuttle-export as the default Helm chart name and Kubernetes namespace.

FieldTypeRequiredDefaultDescription
descriptionstringnoFree-form description displayed in the local dashboard.
namestringyesProject name. Must match ^[a-z][a-z0-9_-]{0,31}$. Used as a prefix for all runtime resource names (containers, networks, volumes) so it must be stable across machines.
versionstringnoFree-form version label. Informational only; not validated.