Conventions¶
This section explains several conventions used in the chart schema documentation.
Symbols¶
This documentation use some symbols for illustration purposes. Before you read on, please make sure you've made yourself familiar with the following list of conventions:
– Version¶
The tag symbol in conjunction with a version number denotes when a specific feature or behavior was added. Make sure you're at least on this version if you want to use it.
– Default value¶
Some properties in the schemas have default values. The default value of the property is always included.
– Default value is computed¶
Some default values are not set to static values but computed from other values.
– Default value is empty¶
Some properties do not contain default values. This means that the functionality that is associated with them is not available unless explicitly enabled.
– Optional feature¶
Some features are optional and must be explicitly enabled by setting the property.
– Experimental¶
Some newer features are still considered experimental, which means they might (although rarely) change at any time, including their complete removal.
– Required value¶
Some properties are required, which means they must be explicitly set in the values.yaml
.
– Type¶
All properties have a type, for example string
, boolean
, object
, etc.
– Enumeration¶
Some properties have a set of allowed values, which are listed in the enum
property.
– Deprecated¶
Some features or properties are deprecated, which means they are no longer recommended for use and may be removed in future versions. It is advised to avoid using deprecated features and to update your configuration to use the recommended alternatives.
– Minimum Length¶
Some properties have a minimum length constraint. This means that the value of the property must be at least the specified length.
– Maximum Length¶
Some properties have a maximum length constraint. This means that the value of the property must not exceed the specified length.
– Pattern¶
Some properties have a pattern constraint. This means that the value of the property must match the specified pattern.