<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
	<channel>
		<title>Reference on StormForge Documentation</title>
		<link>/docs/reference/</link>
		<description>Recent content in Reference on StormForge Documentation</description>
		<generator>Hugo</generator>
		<language>en-us</language>
		
		
		
		
			<atom:link href="/docs/reference/index.xml" rel="self" type="application/rss+xml" />
			<item>
				<title>Best practices</title>
				<link>/docs/reference/best-practices/</link>
				<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
				<guid>/docs/reference/best-practices/</guid>
				<description>&lt;p&gt;Get the most value out of StormForge and minimize unexpected results by following these best practices.&lt;/p&gt;&#xA;&lt;div class=&#34;alert alert-info&#34; role=&#34;alert&#34;&gt;&lt;div class=&#34;h4 alert-heading&#34; role=&#34;heading&#34;&gt;If you&#39;re getting started... &lt;/div&gt;&#xA;&lt;p&gt;Check out the &lt;a href=&#34;/docs/configure/configure-opt-settings/&#34;&gt;Getting started with configuring StormForge&lt;/a&gt; guide, which discusses the five most important settings and whether you need to consider adjusting them to suit your organization&amp;rsquo;s requirements.&lt;/p&gt;&#xA;&lt;/div&gt;&#xA;&lt;h2 id=&#34;workload-settings&#34;&gt;Workload settings&lt;a class=&#34;td-heading-self-link&#34; href=&#34;#workload-settings&#34; aria-label=&#34;Heading self-link&#34;&gt;&lt;/a&gt;&lt;/h2&gt;&#xA;&lt;h3 id=&#34;generate-recommendations-once-daily&#34;&gt;Generate recommendations once daily&lt;a class=&#34;td-heading-self-link&#34; href=&#34;#generate-recommendations-once-daily&#34; aria-label=&#34;Heading self-link&#34;&gt;&lt;/a&gt;&lt;/h3&gt;&#xA;&lt;p&gt;A once-daily recommendation schedule is considered a best practice in stable or production environments (this is the default schedule when you roll out StormForge). For details about this setting, see &lt;a href=&#34;/docs/configure/settings/schedule/&#34;&gt;Recommendation schedule&lt;/a&gt; in the Schedule topic.&lt;/p&gt;</description>
			</item>
			<item>
				<title>User roles</title>
				<link>/docs/reference/user-roles/</link>
				<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
				<guid>/docs/reference/user-roles/</guid>
				<description>&lt;p&gt;StormForge uses role-based access control. Each user in your organization is assigned one of the following roles.&lt;/p&gt;&#xA;&lt;div class=&#34;table-scroll&#34;&gt;&#xA;&lt;div class=&#34;table-responsive&#34;&gt;&#xA;&lt;table class=&#34;td-initial table&#34;&gt;&#xA;  &lt;thead&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;th&gt;Role&lt;/th&gt;&#xA;          &lt;th&gt;Permissions&lt;/th&gt;&#xA;      &lt;/tr&gt;&#xA;  &lt;/thead&gt;&#xA;  &lt;tbody&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;&lt;strong&gt;Viewer&lt;/strong&gt;&lt;/td&gt;&#xA;          &lt;td&gt;View optimization data and export recommendations&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;&lt;strong&gt;Operator&lt;/strong&gt;&lt;/td&gt;&#xA;          &lt;td&gt;Apply and export recommendations; configure workloads&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;&lt;strong&gt;Manager&lt;/strong&gt;&lt;/td&gt;&#xA;          &lt;td&gt;Invite users (not suspend); all Operator permissions&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;&lt;strong&gt;Administrator&lt;/strong&gt;&lt;/td&gt;&#xA;          &lt;td&gt;Invite and suspend users; configure global settings&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;  &lt;/tbody&gt;&#xA;&lt;/table&gt;&#xA;&lt;/div&gt;&#xA;&lt;/div&gt;&#xA;&lt;p&gt;Operators, Managers, and Administrators can also add and revoke Access Credentials under &lt;strong&gt;Settings &amp;gt; Access Credentials&lt;/strong&gt;.&lt;/p&gt;&#xA;&lt;h2 id=&#34;role-comparison&#34;&gt;Role comparison&lt;a class=&#34;td-heading-self-link&#34; href=&#34;#role-comparison&#34; aria-label=&#34;Heading self-link&#34;&gt;&lt;/a&gt;&lt;/h2&gt;&#xA;&lt;div class=&#34;table-scroll&#34;&gt;&#xA;&lt;div class=&#34;table-responsive&#34;&gt;&#xA;&lt;table class=&#34;td-initial table&#34;&gt;&#xA;  &lt;thead&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;th&gt;Action&lt;/th&gt;&#xA;          &lt;th style=&#34;text-align: center&#34;&gt;Viewer&lt;/th&gt;&#xA;          &lt;th style=&#34;text-align: center&#34;&gt;Operator&lt;/th&gt;&#xA;          &lt;th style=&#34;text-align: center&#34;&gt;Manager&lt;/th&gt;&#xA;          &lt;th style=&#34;text-align: center&#34;&gt;Administrator&lt;/th&gt;&#xA;      &lt;/tr&gt;&#xA;  &lt;/thead&gt;&#xA;  &lt;tbody&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;View optimization data&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;Export recommendations&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;Apply recommendations&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;Configure workloads&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;Add/revoke Access Credentials&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;Invite users&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;Suspend users&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;Configure global settings&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;&lt;/td&gt;&#xA;          &lt;td style=&#34;text-align: center&#34;&gt;✓&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;  &lt;/tbody&gt;&#xA;&lt;/table&gt;&#xA;&lt;/div&gt;&#xA;&lt;/div&gt;</description>
			</item>
			<item>
				<title>Workload recommendation statuses</title>
				<link>/docs/reference/statuses/</link>
				<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
				<guid>/docs/reference/statuses/</guid>
				<description>&lt;p&gt;You can view workload recommendation status details in these locations:&lt;/p&gt;&#xA;&lt;ul&gt;&#xA;&lt;li&gt;In workload lists on the Overview and Workloads pages&lt;/li&gt;&#xA;&lt;li&gt;On the Workloads Summary page: Click  &lt;strong&gt;View Summary&lt;/strong&gt; on the Workloads page and drill down by status, error, or warning&lt;/li&gt;&#xA;&lt;li&gt;In the &lt;strong&gt;Recommendation&lt;/strong&gt; section of the workload details page header&#xA; &lt;/li&gt;&#xA;&lt;/ul&gt;&#xA;&lt;div class=&#34;table-scroll&#34;&gt;&#xA;&lt;div class=&#34;table-responsive&#34;&gt;&#xA;&lt;table&gt;&#xA;  &lt;thead&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;th&gt;Icon&lt;/th&gt;&#xA;          &lt;th&gt;Status&lt;/th&gt;&#xA;          &lt;th&gt;Description&lt;/th&gt;&#xA;      &lt;/tr&gt;&#xA;  &lt;/thead&gt;&#xA;  &lt;tbody&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;&lt;img src=&#34;/img/docs/ol-status-wl-learning.png&#34; alt=&#34;&#34;&gt;&lt;/td&gt;&#xA;          &lt;td&gt;Learning&lt;/td&gt;&#xA;          &lt;td&gt;Indicates one of the following: &lt;strong&gt;Preliminary recommendations are available&lt;/strong&gt; based on data collected so far; complete recommendations will be available when the workload&amp;rsquo;s &lt;a href=&#34;/docs/configure/settings/apply-settings/#learning-period&#34;&gt;learning period&lt;/a&gt; is complete. &lt;strong&gt;Waiting for Data&lt;/strong&gt;: A workload (typically a CronJob) has not run yet and StormForge is waiting for data. No action required.&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;&lt;img src=&#34;/img/docs/ol-status-wl-ready.png&#34; alt=&#34;&#34;&gt;&lt;/td&gt;&#xA;          &lt;td&gt;Ready&lt;/td&gt;&#xA;          &lt;td&gt;A recommendation is available to apply to this workload and will be applied if auto-deployment is enabled; otherwise, you can it apply manually.&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;&lt;img src=&#34;/img/docs/ol-status-wl-info.png&#34; alt=&#34;&#34;&gt;&lt;/td&gt;&#xA;          &lt;td&gt;Informational&lt;/td&gt;&#xA;          &lt;td&gt;Provides additional details about a recommendation, for example, the recommendation was constrained by bounds, HPA is at min or max replicas. See the banner on the workload page for details. No action required.&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;&lt;img src=&#34;/img/docs/ol-status-wl-unsup.png&#34; alt=&#34;&#34;&gt;&lt;/td&gt;&#xA;          &lt;td&gt;Unsupported&lt;/td&gt;&#xA;          &lt;td&gt;Recommendations are not provided in these scenarios: corrupt usage data; &lt;code&gt;batch/v1&lt;/code&gt; Jobs that run for less than 10 minutes; when an HPA oscillates between min and max replicas, scales on &amp;gt;1 resource or containerResource metric, or has a &lt;code&gt;target.averageUtilization&lt;/code&gt; &amp;gt;=100. Typically, no action is required. For details see the &lt;a href=&#34;/docs/reference/troubleshooting/#unsup&#34;&gt;Unsupported workloads&lt;/a&gt; section of the Troubleshooting topic.&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;&lt;img src=&#34;/img/docs/warning_amber.png&#34; width=&#34;32&#34;&gt;&lt;/td&gt;&#xA;          &lt;td&gt;Warning&lt;/td&gt;&#xA;          &lt;td&gt;Warning types include scaled to zero, invalid workload annotation, high resource usage variance, and missing patch path configuration. For details and troubleshooting steps, see the &lt;a href=&#34;/docs/reference/troubleshooting/#errors-warnings&#34;&gt;Errors and warnings&lt;/a&gt; section of the Troubleshooting topic.&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;      &lt;tr&gt;&#xA;          &lt;td&gt;&lt;img src=&#34;/img/docs/ol-status-wl-error.png&#34; alt=&#34;&#34;&gt;&lt;/td&gt;&#xA;          &lt;td&gt;Error&lt;/td&gt;&#xA;          &lt;td&gt;Error types include recommendation failure, missing data, expired recommendations, and applier failure. For details and troubleshooting steps, see the &lt;a href=&#34;/docs/reference/troubleshooting/#errors-warnings&#34;&gt;Errors and warnings&lt;/a&gt; section of the Troubleshooting topic.&lt;/td&gt;&#xA;      &lt;/tr&gt;&#xA;  &lt;/tbody&gt;&#xA;&lt;/table&gt;&#xA;&lt;/div&gt;&#xA;&lt;/div&gt;&#xA;&lt;div class=&#34;section-index related-topics&#34;&gt;&#xA;    &#xA;    &lt;hr class=&#34;panel-line&#34;&gt;&#xA;        &lt;h4&gt;Related topics&lt;/h4&gt;&#xA;        &lt;div class=&#34;entry&#34;&gt;&#xA;                &lt;h5&gt;&#xA;                    &#xA;                    Recommendations&lt;span class=&#34;related-topics-divider&#34;&gt;/&lt;/span&gt;&lt;a href=&#34;/docs/recommendations/view/&#34;&gt;View recommendations&lt;/a&gt;&#xA;                &lt;/h5&gt;&#xA;                &lt;p&gt;View recommendations on the Workload Details page or from the command line&lt;/p&gt;&#xA;            &lt;/div&gt;&#xA;        &lt;/div&gt;</description>
			</item>
			<item>
				<title>Applier Kubernetes events</title>
				<link>/docs/reference/applier-events/</link>
				<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
				<guid>/docs/reference/applier-events/</guid>
				<description>&lt;p&gt;The StormForge Applier emits standard Kubernetes Events. If your team uses &lt;code&gt;kubectl&lt;/code&gt;, Lens, k9s, or a cluster event exporter to track cluster activity, you can track Applier activity without any additional configuration.&lt;/p&gt;&#xA;&lt;div class=&#34;alert alert-info&#34; role=&#34;alert&#34;&gt;&#xA;&lt;p&gt;For push-based notifications when the Applier applies a recommendation, see &lt;a href=&#34;/docs/guides/applier-alerts/&#34;&gt;Configure applier alerts&lt;/a&gt;.&lt;/p&gt;&#xA;&lt;/div&gt;&#xA;&lt;h2 id=&#34;view-events&#34;&gt;View events&lt;a class=&#34;td-heading-self-link&#34; href=&#34;#view-events&#34; aria-label=&#34;Heading self-link&#34;&gt;&lt;/a&gt;&lt;/h2&gt;&#xA;&lt;p&gt;Use &lt;code&gt;kubectl&lt;/code&gt; to query events on any Applier-managed workload:&lt;/p&gt;&#xA;&lt;div class=&#34;highlight&#34;&gt;&lt;pre tabindex=&#34;0&#34; style=&#34;color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;&#34;&gt;&lt;code class=&#34;language-sh&#34; data-lang=&#34;sh&#34;&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;&lt;span style=&#34;color:#75715e&#34;&gt;# Events on a specific workload&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;kubectl get events -n &amp;lt;namespace&amp;gt; --field-selector involvedObject.name&lt;span style=&#34;color:#f92672&#34;&gt;=&lt;/span&gt;&amp;lt;workload-name&amp;gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;&lt;span style=&#34;color:#75715e&#34;&gt;# Filter by event reason (substitute any reason from the reference below)&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;kubectl get events -n &amp;lt;namespace&amp;gt; --field-selector reason&lt;span style=&#34;color:#f92672&#34;&gt;=&lt;/span&gt;RecommendationApplied&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;&lt;span style=&#34;color:#75715e&#34;&gt;# Watch for a specific reason in real time&lt;/span&gt;&#xA;&lt;/span&gt;&lt;/span&gt;&lt;span style=&#34;display:flex;&#34;&gt;&lt;span&gt;kubectl get events -n &amp;lt;namespace&amp;gt; -w --field-selector reason&lt;span style=&#34;color:#f92672&#34;&gt;=&lt;/span&gt;RecommendationApplied&#xA;&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;Events also appear in &lt;code&gt;kubectl describe deployment &amp;lt;name&amp;gt;&lt;/code&gt; (or &lt;code&gt;statefulset&lt;/code&gt;, &lt;code&gt;daemonset&lt;/code&gt;, etc.) under the &lt;code&gt;Events:&lt;/code&gt; section.&lt;/p&gt;</description>
			</item>
			<item>
				<title>Security FAQ</title>
				<link>/docs/reference/faq-security/</link>
				<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
				<guid>/docs/reference/faq-security/</guid>
				<description>&lt;p&gt;You asked:&lt;/p&gt;&#xA;&lt;ul&gt;&#xA;&lt;li&gt;&lt;a href=&#34;#soc2-reports&#34;&gt;How does one access StormForge SOC 2 compliance reports?&lt;/a&gt;&lt;/li&gt;&#xA;&lt;li&gt;&lt;a href=&#34;#how-is-stormforge-deployed&#34;&gt;How is StormForge deployed?&lt;/a&gt;&lt;/li&gt;&#xA;&lt;li&gt;&lt;a href=&#34;#what-data-do-you-collect&#34;&gt;What data do you collect?&lt;/a&gt;&lt;/li&gt;&#xA;&lt;li&gt;&lt;a href=&#34;#how-do-you-collect-data-and-where-is-it-stored&#34;&gt;How do you collect data and where is it stored?&lt;/a&gt;&lt;/li&gt;&#xA;&lt;li&gt;&lt;a href=&#34;#how-long-is-data-stored-for&#34;&gt;How long is data stored for?&lt;/a&gt;&lt;/li&gt;&#xA;&lt;li&gt;&lt;a href=&#34;#who-has-access-to-customer-data&#34;&gt;Who has access to customer data?&lt;/a&gt;&lt;/li&gt;&#xA;&lt;li&gt;&lt;a href=&#34;#federated-sso&#34;&gt;Does StormForge support federated single sign-on?&lt;/a&gt;&lt;/li&gt;&#xA;&lt;li&gt;&lt;a href=&#34;#which-stormforge-service-urls-must-be-on-the-organizations-allowlist&#34;&gt;Which StormForge service URLs must be on the organization&amp;rsquo;s allowlist?&lt;/a&gt;&lt;/li&gt;&#xA;&lt;li&gt;&lt;a href=&#34;#metrics&#34;&gt;What metrics does StormForge collect?&lt;/a&gt;&lt;/li&gt;&#xA;&lt;/ul&gt;&#xA;&lt;h2 id=&#34;soc2-reports&#34;&gt;How does one access StormForge SOC 2 compliance reports?&lt;a class=&#34;td-heading-self-link&#34; href=&#34;#soc2-reports&#34; aria-label=&#34;Heading self-link&#34;&gt;&lt;/a&gt;&lt;/h2&gt;&#xA;&lt;p&gt;StormForge is SOC 2 Type 2 compliant as determined by an audit completed by an accredited auditing firm. You can request access to the SOC 2 reports on the &lt;a href=&#34;https://www.cloudbolt.io/report/soc-2-compliance/&#34;&gt;SOC 2 Compliance Reports&lt;/a&gt; page.&lt;/p&gt;</description>
			</item>
	</channel>
</rss>
