CUE schema¶

The CUE module github.com/xchangeee/syslet@v0 describes the JSON specs and renders them from a sysdef struct. Its schema is in two packages:

Text Only
1 2 3 4	`import ( sysletcore "github.com/xchangeee/syslet/schema/core@v0" syslettools "github.com/xchangeee/syslet/schema/tools@v0" )`

core¶

#Sysdef¶

Collects a host's entries by type, each keyed by name. The key becomes the spec's name.

Field	Entry type	Spec
`containers`	`#SysdefContainerUnit`	`#ContainerSpec`
`networks`	`#SysdefNetworkUnit`	`#NetworkSpec`
`volumes`	`#SysdefVolumeUnit`	`#VolumeSpec`
`builds`	`#SysdefBuildUnit`	`#BuildSpec`
`secrets`	`#SysdefSecret`	`#SecretSpec`

Every entry has two fields:

Field	Type	Notes
`enabled`	bool	Required. `false` leaves the entry out of the rendered specs.
`spec`	the spec definition	Required. `name` and `type` are set for you.

#SysdefDefaults¶

Unify with #Sysdef to default these fields:

Type	`enabled`	`removalAllowed`	`desiredState`	`reclaimPolicy`
containers	`true`	`true`	`"running"`	—
networks	`true`	`true`	—	`"Delete"`
volumes	`true`	`true`	—	`"Delete"`
builds	`true`	`true`	—	`"Delete"`
secrets	`true`	—	—	—

Spec definitions¶

#ContainerSpec, #NetworkSpec, #VolumeSpec, #BuildSpec and #SecretSpec match the JSON spec schema, with these differences:

Field	CUE	JSON
`apiVersion`	Set to `"v1"`	Required
`removalAllowed`	Required on containers, volumes and networks	Optional, defaults to `true`
`desiredState`	Required, `"running"`, `"stopped"` or `"oneshot"`	Optional, defaults to `"running"`
`reclaimPolicy`	Required on volumes, networks and builds	Optional, defaults to `"Delete"`

#SysdefDefaults provides the required values that have a default. unit is required in both, with no default; use unit: {} for a spec without options.

tools¶

#SysdefLock¶

Field	Type	Notes
`in.containers`	list of names	Sets `removalAllowed: false`.
`in.networks`	list of names	Sets `removalAllowed: false`.
`in.volumes`	list of names	Sets `removalAllowed: false` and `reclaimPolicy: "Retain"`.
`out`	partial `#Sysdef`	Unify with `sysdef`.

Text Only
1	`sysdef: (syslettools.#SysdefLock & {in: volumes: ["site-data"]}).out`

#SysdefAssignNetwork¶

Field	Type	Notes
`in`	map of network name to list of container names
`out`	partial `#Sysdef`	Sets `unit: Container: Network` on each listed container to all networks it's listed under, as `<network>.network`.

Text Only
1	`sysdef: (syslettools.#SysdefAssignNetwork & {in: "app-net": ["app", "cache"]}).out`

#SysdefSecretsFromEmbeddedFiles¶

Field	Type	Notes
`in`	map of file name to file content	The result of `@embed(glob=creds-*.enc.yaml,type=text,allowEmptyGlob)`.
`secrets`	map of `#SysdefSecret`	One entry per file, named after the file without the `creds-` prefix and `.enc.yaml` suffix.

The files must sit in the same directory as the CUE file; a glob into a subdirectory keeps the directory in the name.

Text Only
1	`sysdef: secrets: (syslettools.#SysdefSecretsFromEmbeddedFiles & {in: secretFiles}).secrets`

#SysletJsonFromSysdef¶

Field	Type	Notes
`in`	`#Sysdef`
`specRendered`	string	JSON array of every enabled entry's spec, the input for `syslet --stdin`.

Text Only
1	`syslet: specRendered: (syslettools.#SysletJsonFromSysdef & {in: sysdef}).specRendered`