MATERIA-REPOSITORY

Name

materia-repository

Synopsis

A directory containing containing components and manifests for materia to manage.

Description

A directory containing containing components and manifests for materia to manage. Example file layout:

materia-repo/
materia-repo/components
materia-repo/components/hello
materia-repo/components/hello/hello.container.gotmpl
materia-repo/components/hello/MANIFEST.toml
materia-repo/attributes
materia-repo/attributes/vault.age
materia-repo/MANIFEST.toml

Details

component

A collection of one or more resources, where at least one resource is a MANIFEST.toml. Components are assigned to hosts or roles in the repositories MANIFEST.toml.

Example: materia-repo/components/hello

resource

A single file in a component. Resources are either static files or Golang templates and come in the following types:

file: An arbitrary data file. Installed to PREFIX/components/COMPONENT_NAME/RESOURCENAME

service: A systemd unit file. Installed to PREFIX/components/COMPONENT_NAME/RESOURCENAME and MATERIA_SERVICEDIR

container: A .container file. Installed to MATERIA_QUADLETDIR.

volume: A .volume file. Installed to MATERIA_QUADLETDIR.

pod: A .pod file. Installed to MATERIA_QUADLETDIR.

kube: A .kube file. Installed to MATERIA_QUADLETDIR.

build: A .build file. Installed to MATERIA_QUADLETDIR.

image: A .image file. Installed to MATERIA_QUADLETDIR.

manifest: A MANIFEST.TOML file. Installed to PREFIX/components/COMPONENT_NAME/MAINFEST.TOML

volumefile: A data file that should be installed in a Podman volume. Experimental, defined in the components MANIFEST.toml

script: A script file, ending in .sh. Installed in PREFIX/components/COMPONENT_NAME/RESOURCENAMEas well as MATERIA_SCRIPTSDIR

componentscript: A special script file named either setup.sh or cleanup.sh. The former is run when the component is installed and the latter on removal.

If a resource filename ends in .gotmpl it is treated as a Golang template.

Example: materia-repo/components/hello/hello.container.gotmpl

variable

A Golang template variable. Usually defined as either an attribute or in the defaults section of a component manifest

Attributes

A Golang template variable stored encrypted in the repository, like the default age encryption.

Attributes are usually stored in a subdirectory materia-repo/attributes. There are three main types of attributes files:

attributes/vault.(toml|age): A general list of attributes available to all components, hosts, and roles.

attributes/<hostname>.(toml|age): Attributes available only to a specific host

attributes/<role>.(toml|age): Attributes available to a specific role