mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
31 lines
1.1 KiB
Plaintext
31 lines
1.1 KiB
Plaintext
// Module included in the following assemblies:
|
|
|
|
// *scalability_and_performance/cluster-compare/creating-a-reference-configuration.adoc
|
|
|
|
:_mod-docs-content-type: CONCEPT
|
|
|
|
[id="cluster-compare-metadata-structure_{context}"]
|
|
= Structure of the metadata.yaml file
|
|
|
|
The `metadata.yaml` file provides a central configuration point to define and configure the templates in a reference configuration.
|
|
The file features a hierarchy of `parts` and `components`. `parts` are groups of `components` and `components` are groups of templates.
|
|
Under each component, you can configure template dependencies, validation rules, and add descriptive metadata.
|
|
|
|
.Example metadata.yaml file
|
|
[source,yaml]
|
|
----
|
|
apiVersion: v2
|
|
parts: <1>
|
|
- name: Part1 <2>
|
|
components:
|
|
- name: Component1 <3>
|
|
<component1_configuration> <4>
|
|
- name: Part2
|
|
- name: Component2
|
|
<component2_configuration>
|
|
----
|
|
<1> Every `part` typically describes a workload or a set of workloads.
|
|
<2> Specify a `part` name.
|
|
<3> Specify a `component` name.
|
|
<4> Specify the configuration for a template. For example, define template relationships or configure what fields to use in a comparison.
|