Configure optimization using CRDs

StormForge’s optimization configuration options ensure consistent right-sizing across workloads and give teams control over their work.

• Platform teams can set organization-wide default optimization values

• Platform teams can provide different default optimization values for all workloads matching a type or label selector

• Development teams can fine-tune settings further for workloads in their namespaces, or for those matching specific label selectors

Optimization configurations are Custom Resource Definitions (CRDs) consisting of rules evaluated and applied to workloads in definition order.

Types

Define optimization configurations using the following CRD types:

• ClusterOptimizationConfiguration

  • A cluster-scoped resource intended for use by platform teams to define organization-wide optimization policy.

  • ClusterOptimizationConfiguration rules are always evaluated before any OptimizationConfiguration rules.

• OptimizationConfiguration

  • A namespace-scoped resource intended for use by application or development teams that own namespace resources.

  • Apply only to workloads in the defined namespace and are evaluated after ClusterOptimizationConfiguration rules.

ClusterOptimizationConfiguration

Defines a list of cluster-scoped rules. Each rule can include matchConditions, selector, and/or namespaceSelector fields. An order field enables specifying the relative evaluation order of a ClusterOptimizationConfiguration relative to other ClusterOptimizationConfigurations.

apiVersion: optimize.stormforge.io/v1
kind: ClusterOptimizationConfiguration
metadata:
  name: cluster-defaults
spec:
  order: 10
  rules:
  - name: NAME
    matchConditions: []
    selector: {}
    namespaceSelector: {}
    settings: []

OptimizationConfiguration

Defines a list of namespace-scoped rules. Each rule can include matchConditions and selector. An order field enables specifying the relative evaluation order of an OptimizationConfiguration relative to other OptimizationConfigurations.

apiVersion: optimize.stormforge.io/v1
kind: OptimizationConfiguration
metadata:
  name: namespace-defaults
  namespace: default
spec:
  order: 10
  rules:
  - name: NAME
    matchConditions: []
    selector: {}
    settings: []

Ordering

When multiple optimization configurations of the same type exist, spec.order controls their relative evaluation order. The order field follows the Higher = Stronger pattern, where higher numbers are evaluated later, and can override settings specified in lower-order configurations. Configurations with the same spec.order are ordered alphabetically by name.

spec:
  order: 10

Rules

Define cascading rules—or configuration steps—as spec.rules. Each rule applies a new configuration or modifies the previous configuration to all workloads or workloads matching specific criteria.

spec:
  rules:
  - name: NAME

    # CEL expressions enable non-label filtering. Expressions must be truthy.
    matchConditions:
    - name: NAME
      expression: 'object.kind == "Deployment"'

    # Selects workloads based on workload labels. Should be a Kube `metav1.LabelSelector`.
    selector:
      matchLabels:
        "app.kubernetes.io/name": "foobar"

    # Selects workloads based on namespace labels. Should be a Kube `metav1.LabelSelector`.
    # When the CRD is namespace-scoped, the namespace selector is effectively implied.
    namespaceSelector:
      matchLabels:
        "kubernetes.io/metadata.name": "default"

    # A Kube `listMap` keyed on `name`. Any setting string from:
    # https://docs.stormforge.io/optimize-live/configure/settings/
    settings:
    - name: "schedule"
      value: "P2D"
    - name: "memory.optimization-goal"
      value: "Balanced"

Match conditions and selectors

Use matchConditions and selectors to constrain which workloads a rule applies to. For matchConditions, Common Expression Language (CEL) expressions are used to match non-label workload characteristics such as annotations, workload type, or StormForge patch-target type. Namespace and workload selectors can match namespaces and workloads, respectively, by label.

Empty selectors or matchConditions match all workloads.

For a rule to match, a workload must satisfy all of matchConditions, selector, and namespaceSelector.

Common Expression Language variables

CEL is used to evaluate matchConditions. The following variables are available in the evaluation context:

• object: The workload object.

  • apiVersion: The workload’s GroupVersion string (for example, apps/v1).

  • kind: The workload kind (for example, Deployment).

  • metadata.name: The workload name.

  • metadata.namespace: The workload namespace.

  • metadata.labels: A map of the workload’s labels.

  • metadata.annotations: A map of the workload’s annotations.

• namespaceObject: The namespace object containing the workload; ClusterOptimizationConfiguration only.

  • metadata.name: The namespace name.

  • metadata.labels: A map of the namespace’s labels.

  • metadata.annotations: A map of the namespace’s annotations.

Settings

Settings is a listMap keyed on name, consisting of name and value (or list of values), where name must be the name of a StormForge configuration setting, like schedule or containers.cpu.requests.max, and value must be a string.

If all matchConditions and selectors match a workload, settings are applied. Settings defined in later rules can override those from earlier rules.