CRD reference on StormForge Documentation

ClusterOptimizationConfiguration reference

Mon, 01 Jan 0001 00:00:00 +0000

apiVersion: optimize.stormforge.io/v2

Scope: Cluster.

For usage and examples, see Configure optimization using CRDs.

Fields marked * are required.

ClusterOptimizationConfiguration

ClusterOptimizationConfiguration is the Schema for the ClusterOptimizationConfiguration API.

Field	Description
`apiVersion` string	`optimize.stormforge.io/v2`
`kind` string	`ClusterOptimizationConfiguration`
`metadata` ObjectMeta	Standard object metadata.
`spec` ClusterOptimizationConfigurationSpec	ClusterOptimizationConfigurationSpec defines the desired state of ClusterOptimizationConfiguration.

ClusterOptimizationConfigurationSpec

ClusterOptimizationConfigurationSpec defines the desired state of ClusterOptimizationConfiguration.

Field	Description
`match` object	Gating applied to every rule in this configuration. Rules may narrow further with their own match.
`match.anyOf` object array	Terms that are OR-ed together, of which at least one must match. Each term’s own criteria are AND-ed within the term. A null or empty term matches no objects. Must contain at least 1 item.
`match.anyOf.expression` string	CEL expression evaluated against the workload via the `object` variable.
`match.anyOf.namespaceSelector` string	Selector applied to the labels of the workload’s namespace.
`match.anyOf.objectSelector` string	Selector applied to the labels of the workload. Named to align with the CEL `object` variable.
`match.expression` string	CEL expression evaluated against the workload via the `object` variable.
`match.namespaceSelector` string	Selector applied to the labels of the workload’s namespace.
`match.objectSelector` string	Selector applied to the labels of the workload. Named to align with the CEL `object` variable.
`order` integer	Defaults to `0`. Value must be an integer between -1000 and 1000.
`rules` object array	ClusterOptimizationConfig defines a single optimization configuration entry. Entries are keyed on `name`.
`rules.match` object	ClusterMatch is the cluster-scoped counterpart of Match, combining its terms the same way. An empty ClusterMatch matches every workload.
`rules.match.anyOf` object array	Terms that are OR-ed together, of which at least one must match. Each term’s own criteria are AND-ed within the term. A null or empty term matches no objects. Must contain at least 1 item.
`rules.match.anyOf.expression` string	CEL expression evaluated against the workload via the `object` variable.
`rules.match.anyOf.namespaceSelector` string	Selector applied to the labels of the workload’s namespace.
`rules.match.anyOf.objectSelector` string	Selector applied to the labels of the workload. Named to align with the CEL `object` variable.
`rules.match.expression` string	CEL expression evaluated against the workload via the `object` variable.
`rules.match.namespaceSelector` string	Selector applied to the labels of the workload’s namespace.
`rules.match.objectSelector` string	Selector applied to the labels of the workload. Named to align with the CEL `object` variable.
`rules.name` * string
`rules.settings` * object array	ConfigItem represents a single configuration entry with a name and one or more values. Entries are keyed on `name`. Either value or values must be set, but not both.
`rules.settings.name` * string
`rules.settings.value` string
`rules.settings.values` string array

OptimizationConfiguration reference

Mon, 01 Jan 0001 00:00:00 +0000

apiVersion: optimize.stormforge.io/v2

Scope: Namespaced.

For usage and examples, see Configure optimization using CRDs.

Fields marked * are required.

OptimizationConfiguration

OptimizationConfiguration is the Schema for the OptimizationConfiguration API.

Field	Description
`apiVersion` string	`optimize.stormforge.io/v2`
`kind` string	`OptimizationConfiguration`
`metadata` ObjectMeta	Standard object metadata.
`spec` OptimizationConfigurationSpec	OptimizationConfigurationSpec defines the desired state of OptimizationConfiguration.

OptimizationConfigurationSpec

OptimizationConfigurationSpec defines the desired state of OptimizationConfiguration.

Field	Description
`match` object	Gating applied to every rule in this configuration. Rules may narrow further with their own match.
`match.anyOf` object array	Terms that are OR-ed together, of which at least one must match. Each term’s own criteria are AND-ed within the term. A null or empty term matches no objects. Must contain at least 1 item.
`match.anyOf.expression` string	CEL expression evaluated against the workload via the `object` variable.
`match.anyOf.objectSelector` string	Selector applied to the labels of the workload. Named to align with the CEL `object` variable.
`match.expression` string	CEL expression evaluated against the workload via the `object` variable.
`match.objectSelector` string	Selector applied to the labels of the workload. Named to align with the CEL `object` variable.
`order` integer	Defaults to `0`. Value must be an integer between -1000 and 1000.
`rules` object array	OptimizationConfig defines a single optimization configuration entry. Entries are keyed on `name`.
`rules.match` object	Match selects the workloads a configuration applies to. The inlined MatchTerm criteria are AND-ed together, and an empty Match matches every workload. When AnyOf is also set at least one of its terms must match, and that result is AND-ed with the inlined criteria.
`rules.match.anyOf` object array	Terms that are OR-ed together, of which at least one must match. Each term’s own criteria are AND-ed within the term. A null or empty term matches no objects. Must contain at least 1 item.
`rules.match.anyOf.expression` string	CEL expression evaluated against the workload via the `object` variable.
`rules.match.anyOf.objectSelector` string	Selector applied to the labels of the workload. Named to align with the CEL `object` variable.
`rules.match.expression` string	CEL expression evaluated against the workload via the `object` variable.
`rules.match.objectSelector` string	Selector applied to the labels of the workload. Named to align with the CEL `object` variable.
`rules.name` * string
`rules.settings` * object array	ConfigItem represents a single configuration entry with a name and one or more values. Entries are keyed on `name`. Either value or values must be set, but not both.
`rules.settings.name` * string
`rules.settings.value` string
`rules.settings.values` string array

ClusterOptimizationConfiguration v1 reference

Mon, 01 Jan 0001 00:00:00 +0000

Deprecated

optimize.stormforge.io/v1 is deprecated; use v2. The v1 representation is reconstructed and is not preserved if the object is modified at v2. See the ClusterOptimizationConfiguration reference.

apiVersion: optimize.stormforge.io/v1

Scope: Cluster.

For usage and examples, see Configure optimization using CRDs.

Fields marked * are required.

ClusterOptimizationConfiguration

ClusterOptimizationConfiguration is the Schema for the ClusterOptimizationConfiguration API.

Field	Description
`apiVersion` string	`optimize.stormforge.io/v1`
`kind` string	`ClusterOptimizationConfiguration`
`metadata` ObjectMeta	Standard object metadata.
`spec` ClusterOptimizationConfigurationSpec	ClusterOptimizationConfigurationSpec defines the desired state of ClusterOptimizationConfiguration.

ClusterOptimizationConfigurationSpec

ClusterOptimizationConfigurationSpec defines the desired state of ClusterOptimizationConfiguration.

OptimizationConfiguration v1 reference

Mon, 01 Jan 0001 00:00:00 +0000

Deprecated

optimize.stormforge.io/v1 is deprecated; use v2. The v1 representation is reconstructed and is not preserved if the object is modified at v2. See the OptimizationConfiguration reference.

apiVersion: optimize.stormforge.io/v1

Scope: Namespaced.

For usage and examples, see Configure optimization using CRDs.

Fields marked * are required.

OptimizationConfiguration

OptimizationConfiguration is the Schema for the OptimizationConfiguration API.

Field	Description
`apiVersion` string	`optimize.stormforge.io/v1`
`kind` string	`OptimizationConfiguration`
`metadata` ObjectMeta	Standard object metadata.
`spec` OptimizationConfigurationSpec	OptimizationConfigurationSpec defines the desired state of OptimizationConfiguration.

OptimizationConfigurationSpec

OptimizationConfigurationSpec defines the desired state of OptimizationConfiguration.