Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions modules/cluster-compare-templating-reference.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
// Module included in the following assemblies:

// *scalability_and_performance/cluster-compare/creating-a-reference-configuration.adoc

:_mod-docs-content-type: REFERENCE

[id="cluster-compare-templating-reference_{context}"]
= Reference template functions

The `cluster-compare` plugin supports all `sprig` library functions, except for the `env` and `expandenv` functions.
See _Additional resources_ for the full list of `sprig` library functions.

The following content describes the additional template functions for the `cluster-compare` plugin.

.Additional cluster-compare template functions
[options="header"]
[cols="2a,3a"]
|====
| Function | Description

|`fromJson`
|Parses the incoming string as a structured JSON object.

|`fromJsonArray`
|Parses the incoming string as a structured JSON array.

|`fromYaml`
|Parses the incoming string as a structured YAML object.

|`fromYamlArray`
|Parses the incoming string as a structured YAML array.

|`toJson`
|Renders incoming data as JSON while preserving object types.

|`toToml`
|Renders the incoming string as structured TOML data.

|`toYaml`
|Renders incoming data as YAML while preserving object types.

|====
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ include::modules/cluster-compare-template-groupings.adoc[leveloffset=+1]

include::modules/cluster-compare-templating.adoc[leveloffset=+1]

include::modules/cluster-compare-templating-reference.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* link:https://masterminds.github.io/sprig/[Sprig Function Documentation]

include::modules/cluster-compare-exclude-metadata.adoc[leveloffset=+1]

include::modules/cluster-compare-configure-inline-diff.adoc[leveloffset=+1]
Expand Down