https://docs.stormforge.io/docs/configure/ Recent content in Configure optimization settings on StormForge Documentation Hugo en-us https://docs.stormforge.io/docs/configure/configure-opt-settings/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.stormforge.io/docs/configure/configure-opt-settings/ <h2 id="getting-started">Getting started<a class="td-heading-self-link" href="#getting-started" aria-label="Heading self-link"></a></h2> <p>Optimize Live performs best when it is properly configured with goals, constraints, and requirements appropriate for the workloads it is optimizing. One of the first steps you should take when deploying Optimize Live is to <strong>review the available configuration options, and adjust settings as needed to suit your organization’s requirements.</strong></p> <p>Optimization settings can be applied as cluster-scoped defaults, namespace-scoped defaults, or directly to individual workloads. Making sure your cluster-scoped default values are aligned with your organization’s requirements first provides the most return for your effort. You can carve out exceptions to these settings for particular namespaces or workloads later.</p> https://docs.stormforge.io/docs/configure/cluster-defaults/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.stormforge.io/docs/configure/cluster-defaults/ <p>The purpose of this topic is to describe how to use the <code>cluster-defaults</code> ConfigMap to configure default optimization settings for a cluster.</p> <p><strong>Topics:</strong></p> <ul> <li><a href="#configure-defaults">Configure default optimization settings for all workloads in the cluster</a> <!-- - [Preferred method: Using Helm](#annot-cluster-helm) --> <ul> <li><a href="#defaults-using-kubectl-apply">Using <code>kubectl apply</code></a></li> <li><a href="#defaults-using-kubectl-edit">Using <code>kubectl edit</code></a></li> </ul> </li> </ul> <h2 id="configure-defaults">Configure default optimization settings for all workloads in the cluster<a class="td-heading-self-link" href="#configure-defaults" aria-label="Heading self-link"></a></h2> <p>Cluster-level defaults:</p> <ul> <li>Define the default optimization settings for all workloads in a cluster</li> <li>Are specified in a ConfigMap named <code>cluster-defaults</code> in the <code>stormforge-system</code> namespace</li> <li>Have the lowest configuration precedence and can be overridden by namespace annotations or by annotations on individual workload resources</li> </ul> <!-- You can create this ConfigMap yourself, but it may be easier to have Helm create and manage it for you. ### Setting cluster default values using Helm {#annot-cluster-helm} The `stormforge-agent` Helm chart has values you can pass to define each of the possible cluster-level default settings. Helm then creates and manages the `cluster-defaults` ConfigMap for you. **Preferred method: Helm chart values for cluster default settings** 1. Optional: Check whether any cluster defaults are already set in the cluster-defaults ConfigMap by running: ```shell kubectl describe configmap cluster-defaults -n stormforge-system ``` - If you see an `Error from server (NotFound): configmaps "cluster-defaults" not found` message, no cluster-level defaults are set. Proceed to the next step. - Otherwise, in the **Data > cluster-defaults.yaml** section of the output, notice which annotations are set. If you need to preserve those values, include them in the `cluster-defaults.yaml` file that you create in the next step. 1. Create a .yaml values file (for example, `cluster-defaults.yaml`) that defines the clusterDefaultConfig values you need. - To save time, you can copy the sample on the **Cluster** tab in the [**Copy a template**](#annot-templates) section above. Edit or comment out annotations as needed. As an example, your `cluster-defaults.yaml` file might look something like this when you're done: ```yaml clusterDefaultConfig: schedule: "PT16H" autoDeploy: "true" cpuOptimizationGoal: "Savings" memoryOptimizationGoal: "Savings" containersCpuOptimizationPolicy: "RequestsAndLimits" containersCpuRequestsMin: "20m" containersCpuRequestsMax: "16000m" containersMemoryOptimizationPolicy: "RequestsAndLimits" containersMemoryRequestsMin: "32Mi" containersMemoryRequestsMax: "32Gi" ``` 1. Run `helm install` or `helm upgrade` and include `--values` flag and your filename. For example (remember to replace CLUSTER_NAME and CREDENTIALS_FILE with your own values): ```shell helm upgrade stormforge-agent oci://registry.stormforge.io/library/stormforge-agent \ --namespace stormforge-system \ --set clusterName=CLUSTER_NAME \ --values CREDENTIALS_FILE.yaml \ --values cluster-defaults.yaml ``` **Tip:** If you're setting only a few default values, you pass them as `--set` arguments, as shown below. Be sure to replace the `: ` separator from the template with `=` as shown in the sample command below. ```shell helm upgrade stormforge-agent oci://registry.stormforge.io/library/stormforge-agent \ --namespace stormforge-system \ --set clusterName=CLUSTER_NAME \ --values CREDENTIALS_FILE.yaml \ --set clusterDefaultConfig.autoDeploy=true \ --set clusterDefaultConfig.cpuOptimizationGoal=balanced ``` Any previous cluster-level default values are now removed, and your new defaults are in effect, unless they are overridden at the cluster or workload level. 1. Optional: Confirm your changes by running the following command and then reviewing the annotations in the **Data** section of the output: ```shell kubectl describe configmap cluster-defaults -n stormforge-system `````` --> <h3 id="defaults-using-kubectl-apply">Setting cluster default values using <code>kubectl apply</code><a class="td-heading-self-link" href="#defaults-using-kubectl-apply" aria-label="Heading self-link"></a></h3> <ol> <li> <p>Create a YAML file that defines a ConfigMap called <code>cluster-defaults</code>, with a <code>cluster-defaults.yaml</code> data key, and the settings you want to set in annotation syntax.</p> https://docs.stormforge.io/docs/configure/annotate-namespaces/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.stormforge.io/docs/configure/annotate-namespaces/ <p>The purpose of this topic is to describe how to use annotations to configure optimization settings.</p> <p><strong>Topics:</strong></p> <ul> <li><a href="#annot-ns">Configure default optimization settings for all workloads in a namespace</a> <ul> <li><a href="#annot-ns-yaml">Using YAML manifests</a></li> <li><a href="#annot-ns-kubectl-annotate">Using <code>kubectl annotate</code></a></li> </ul> </li> </ul> <h2 id="annot-ns">Configure default optimization settings for all workloads in a namespace<a class="td-heading-self-link" href="#annot-ns" aria-label="Heading self-link"></a></h2> <p>To configure settings for all workloads in a namespace, edit the Namespace definition or run <code>kubectl annotate</code>.</p> <p>Namespace-level defaults:</p> <ul> <li>Define the default optimization settings for all workloads in a namespace</li> <li>Override any equivalent cluster-level defaults</li> <li>Are specified using annotations on the namespace</li> <li>Fill in any settings not provided by annotations on the workloads themselves</li> </ul> <h3 id="annot-ns-yaml">Using YAML manifests<a class="td-heading-self-link" href="#annot-ns-yaml" aria-label="Heading self-link"></a></h3> <ol> <li> <p>Open the namespace definition in your favorite editor. This is commonly done using commands like these (remember to replace NAMESPACE and FILENAME with your own values):</p> https://docs.stormforge.io/docs/configure/annotate-workloads/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.stormforge.io/docs/configure/annotate-workloads/ <p>The purpose of this topic is to describe how to use annotations to configure optimization settings.</p> <p><strong>Topics:</strong></p> <ul> <li><a href="#annot-wl">Configure optimization settings for a specific workload</a> <ul> <li><a href="#annot-wl-yaml">Using YAML manifests</a></li> <li><a href="#annot-wl-kubectl-annotate">Using <code>kubectl annotate</code></a></li> </ul> </li> </ul> <h2 id="annot-wl">Configure optimization settings for a specific workload<a class="td-heading-self-link" href="#annot-wl" aria-label="Heading self-link"></a></h2> <p>To configure settings an individual workload, edit the resource definition or run <code>kubectl annotate</code>.</p> <p>Workload optimization settings are defined by annotations in the <code>metadata.annotations</code> section of a Deployment, StatefulSet, or other supported workload resource type.</p> https://docs.stormforge.io/docs/configure/optimization-configurations/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.stormforge.io/docs/configure/optimization-configurations/ <p>StormForge&rsquo;s optimization configuration options ensure consistent right-sizing across workloads and give teams control over their work.</p> <ul> <li> <p><strong>Platform teams</strong> can set organization-wide default optimization values</p> </li> <li> <p><strong>Platform teams</strong> can provide different default optimization values for all workloads matching a type or label selector</p> </li> <li> <p><strong>Development teams</strong> can fine-tune settings further for workloads in their namespaces, or for those matching specific label selectors</p> </li> </ul> <p>Optimization configurations are Custom Resource Definitions (CRDs) consisting of <a href="#rules">rules</a> evaluated and applied to workloads in definition order.</p>