diff --git a/modules/reference/nav.adoc b/modules/reference/nav.adoc index 4642c5bba..f23327915 100644 --- a/modules/reference/nav.adoc +++ b/modules/reference/nav.adoc @@ -1,3 +1,4 @@ * Reference ** {crd-docs}[CRD Reference {external-link-icon}^] -** xref:duration.adoc[] \ No newline at end of file +** xref:glossary.adoc[] +** xref:duration.adoc[] diff --git a/modules/reference/pages/glossary.adoc b/modules/reference/pages/glossary.adoc new file mode 100644 index 000000000..4cf84099d --- /dev/null +++ b/modules/reference/pages/glossary.adoc @@ -0,0 +1,57 @@ += Glossary +:li: pass:[] + +// refined styling for the glossary +++++ + +++++ + +// syntax explanation: +// - the [[...]] creates an anchor at the list item +// - The <<...>> creates a link to the achor +// - The {li} references the pass that you can find at the top of the document, it is a FontAwesome icon +// - The ...:: is the syntax for a definition list item +// - The {empty} followed by the + means that there is no "normal" list item, instead there is a block +// - The period followed by text is the summary of a details block that is collapsed +// - Inside the "====" is the details of the details block. +// +// Please create new entries the same way! This allows easy linking to glossary items. +// Antora generates dl, dt and dd tages for the definition list, which is great because these are +// semantic HTML tags. + +[[role]]Role <>:: {empty} ++ +.A <> is made up of multiple roles, which refer to the different processes that make up the service. +[%collapsible%open] +==== +For example HDFS consists of 3 roles: Name nodes, journal nodes and data nodes. +Learn more about xref:concepts:roles-and-role-groups.adoc[]. +==== + +[[role-group]]Role group <>:: {empty} ++ +.A <> is made up of multiple role groups. +[%collapsible%open] +==== +A role group can override configuration set at role level, allowing for different configurations for sets of processes. +Learn more about xref:concepts:roles-and-role-groups.adoc[]. +==== + +[[stacklet]]Stacklet <>:: {empty} ++ +.A deployed service or product instance that is managed by a Stackable operator. +[%collapsible%open] +==== +A Stacklet is defined by a custom resource like AirflowCluster or DruidCluster. +The term refers to the defining resource and all the resources that belong to it, which are created by the operator, such as StatefulSets, Services, Secrets and ConfigMaps. +All objects together are the Stacklet. +==== \ No newline at end of file