diff --git a/src/agent/SUMMARY.md b/src/agent/SUMMARY.md index 048fc23..f9bb913 100644 --- a/src/agent/SUMMARY.md +++ b/src/agent/SUMMARY.md @@ -18,6 +18,7 @@ - [Purge, Delete](agent/apps.deploy.delete.md) - [Operate Apps](agent/apps.operate.md) - [Design Apps](agent/apps.design.md) + - [References](agent/agent.service.references.md) - [Internals](agent/internals.md) - [Installed Files](agent/internals.installed_files.md) - [Daemon]() diff --git a/src/agent/agent.service.references.md b/src/agent/agent.service.references.md new file mode 100644 index 0000000..58dd3bb --- /dev/null +++ b/src/agent/agent.service.references.md @@ -0,0 +1,106 @@ +# References + +A reference is a marker in the value of a configuration keyword, replaced during evaluation. + +A reference is formatted as `{}`. + +A reference can contain arithmetic evaluations. + +An arithmetic evaluation can contain references. + +References can be used to: + +* Abstract changing parts of a configuration, so this configuration can be used as a template + Example: The object name, object id, the devices that hosts the data + +* Factorize information, so changing it is easier and safer + Example: A project name used to format the name of different resources (volume group, filesystem path, ...) + +* Contextualize part of a configuration with information known to the agent + Example: The cluster nodes, cluster dns ip addresses, ... + +## Intra-Configuration References + +The reference format is `{[
.]