/docs/configure/ Recent content in Configure optimization settings on StormForge Documentation Hugo en-us /docs/configure/configure-opt-settings/ Mon, 01 Jan 0001 00:00:00 +0000 /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>StormForge 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 StormForge 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> /docs/configure/cluster-defaults/ Mon, 01 Jan 0001 00:00:00 +0000 /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> <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> <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> /docs/configure/annotate-namespaces/ Mon, 01 Jan 0001 00:00:00 +0000 /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> /docs/configure/annotate-workloads/ Mon, 01 Jan 0001 00:00:00 +0000 /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> /docs/configure/optimization-configurations/ Mon, 01 Jan 0001 00:00:00 +0000 /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>