Deploy docs preview for PR #274 a790730

Author: AbdelrhmanHamouda

pr-274/contribute/index.html

@@ -971,7 +971,7 @@ <h2 id="project-status">Project Status<a class="headerlink" href="#project-statu
 <h2 id="technology-stack">Technology Stack<a class="headerlink" href="#technology-stack" title="Anchor link to this section for reference">⚓</a></h2>
 <p>The operator is built with <strong>Go</strong> using the <a href="https://github.com/kubernetes-sigs/controller-runtime">controller-runtime</a> framework. Key technologies:</p>
 <ul>
-<li><strong>Language</strong>: Go 1.23+</li>
+<li><strong>Language</strong>: Go 1.24+</li>
 <li><strong>Framework</strong>: controller-runtime / Operator SDK</li>
 <li><strong>Testing</strong>: envtest, Ginkgo, Kind</li>
 <li><strong>Build</strong>: Make, Docker</li>
@@ -1006,7 +1006,7 @@ <h2 id="development-documentation">Development Documentation<a class="headerlink
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="January 23, 2026 13:11:16 UTC">January 23, 2026</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="February 10, 2026 21:43:03 UTC">February 10, 2026</span>
   </span>
 
 

pr-274/getting_started/index.html

@@ -596,6 +596,17 @@
     </span>
   </a>
 
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#step-52-access-the-locust-web-ui" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Step 5.2: Access the Locust web UI
+      
+    </span>
+  </a>
+  
 </li>
 
       </ul>
@@ -1160,11 +1171,20 @@ <h5 id="step-by-step-instructions">Step-by-step instructions<a class="headerlink
 </div>
 <h3 id="step-5-start-the-test-by-deploying-the-locusttest-custom-resource"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 20c-4.41 0-8-3.59-8-8s3.59-8 8-8 8 3.59 8 8-3.59 8-8 8m0-18A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2m-2 14.5 6-4.5-6-4.5z"/></svg></span> Step 5: Start the test by deploying the <em>LocustTest</em> custom resource.<a class="headerlink" href="#step-5-start-the-test-by-deploying-the-locusttest-custom-resource" title="Anchor link to this section for reference">⚓</a></h3>
 <p>Deploying a <em>custom resource</em>, signals to the <em>Operator</em> the desire to start a test and thus the <em>Operator</em> starts creating and scheduling
-all needed resources.<br />
+all needed resources.
 To do that, deploy the custom resource following this template <code>kubectl apply -f &lt;valid_cr&gt;.yaml</code>:</p>
 <ul>
 <li><code>kubectl apply -f locusttest-cr.yaml</code></li>
 </ul>
+<div class="admonition warning">
+<p class="admonition-title">Tests are immutable</p>
+<p>LocustTest CRs are <strong>immutable after creation</strong>. If you need to change test parameters (image, command, replicas, etc.), delete the CR and recreate it:</p>
+<div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>delete<span class="w"> </span>-f<span class="w"> </span>locusttest-cr.yaml
+<span class="c1"># Edit locusttest-cr.yaml with your changes</span>
+kubectl<span class="w"> </span>apply<span class="w"> </span>-f<span class="w"> </span>locusttest-cr.yaml
+</code></pre></div>
+<p>See <a href="../how_does_it_work/#immutable-tests">How does it work</a> for more details on this design decision.</p>
+</div>
 <h4 id="step-51-check-cluster-for-running-resources">Step 5.1: Check cluster for running resources<a class="headerlink" href="#step-51-check-cluster-for-running-resources" title="Anchor link to this section for reference">⚓</a></h4>
 <p>At this point, it is possible to check the cluster and all required resources will be running based on the passed configuration in the
 custom resource.</p>
@@ -1174,6 +1194,19 @@ <h4 id="step-51-check-cluster-for-running-resources">Step 5.1: Check cluster for
 <li>A kubernetes <em>Job</em> to manage the <em>master</em> node.</li>
 <li>A kubernetes <em>Job</em> to manage the <em>worker</em> node.</li>
 </ul>
+<h4 id="step-52-access-the-locust-web-ui">Step 5.2: Access the Locust web UI<a class="headerlink" href="#step-52-access-the-locust-web-ui" title="Anchor link to this section for reference">⚓</a></h4>
+<p>The Locust web UI allows you to monitor test progress, view statistics, and control test execution in real time.</p>
+<p>The web UI runs on port <strong>8089</strong> of the master pod. To access it, use <code>kubectl port-forward</code>:</p>
+<div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>port-forward<span class="w"> </span>job/&lt;test-name&gt;-master<span class="w"> </span><span class="m">8089</span>:8089
+</code></pre></div>
+<p>For the example above, this would be:</p>
+<div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>port-forward<span class="w"> </span>job/demo-test-master<span class="w"> </span><span class="m">8089</span>:8089
+</code></pre></div>
+<p>Then open <a href="http://localhost:8089">http://localhost:8089</a> in your browser.</p>
+<div class="admonition tip">
+<p class="admonition-title">Using autostart</p>
+<p>When <code>master.autostart</code> is enabled (the default), the test begins automatically without interaction via the web UI. The web UI is still useful for monitoring progress and viewing real-time statistics.</p>
+</div>
 <h3 id="step-6-clear-resources-after-test-run"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M6 19a2 2 0 0 0 2 2h8a2 2 0 0 0 2-2V7H6zM8 9h8v10H8zm7.5-5-1-1h-5l-1 1H5v2h14V4z"/></svg></span> Step 6: Clear resources after test run<a class="headerlink" href="#step-6-clear-resources-after-test-run" title="Anchor link to this section for reference">⚓</a></h3>
 <p>In order to remove the cluster resources after a test run, simply remove the custom resource and the <em>Operator</em> will react to this event by
 cleaning the cluster of all <strong>related</strong> resources.<br />
@@ -1201,7 +1234,7 @@ <h3 id="step-6-clear-resources-after-test-run"><span class="twemoji"><svg xmlns=
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="February 10, 2026 11:45:58 UTC">February 10, 2026</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="February 10, 2026 21:43:03 UTC">February 10, 2026</span>
   </span>
 
 

pr-274/helm_deploy/index.html

@@ -1136,11 +1136,6 @@ <h3 id="kubernetes-resources">Kubernetes Resources<a class="headerlink" href="#k
 </thead>
 <tbody>
 <tr>
-<td><code>crd.install</code></td>
-<td>Specifies whether to deploy the <code>LocustTest</code> CRD.</td>
-<td><code>true</code></td>
-</tr>
-<tr>
 <td><code>k8s.clusterRole.enabled</code></td>
 <td>Deploy with a cluster-wide role (<code>true</code>) or a namespaced role (<code>false</code>).</td>
 <td><code>true</code></td>
@@ -1176,7 +1171,7 @@ <h3 id="operator-resources">Operator Resources<a class="headerlink" href="#opera
 <tr>
 <td><code>resources.limits.memory</code></td>
 <td>Operator memory limit.</td>
-<td><code>128Mi</code></td>
+<td><code>256Mi</code></td>
 </tr>
 <tr>
 <td><code>resources.limits.cpu</code></td>
@@ -1599,7 +1594,7 @@ <h2 id="next-steps"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="February 10, 2026 11:45:58 UTC">February 10, 2026</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="February 10, 2026 21:43:03 UTC">February 10, 2026</span>
   </span>
 
 

pr-274/how_does_it_work/index.html

@@ -817,10 +817,19 @@ <h2 id="architecture-overview">Architecture Overview<a class="headerlink" href="
 </code></pre></div>
 <h2 id="key-design-decisions">Key Design Decisions<a class="headerlink" href="#key-design-decisions" title="Anchor link to this section for reference">⚓</a></h2>
 <h3 id="immutable-tests">Immutable Tests<a class="headerlink" href="#immutable-tests" title="Anchor link to this section for reference">⚓</a></h3>
-<p>Tests are <strong>immutable by design</strong>. Updates to a LocustTest CR after creation are ignored. To change test parameters, delete and recreate the CR. This ensures:</p>
+<p>Tests are <strong>immutable by design</strong>. Once a LocustTest CR is created, updates to its <code>spec</code> are <strong>ignored</strong> by the operator. The operator sets a <code>SpecDrifted</code> condition on the CR to indicate when spec changes have been detected but not applied.</p>
+<p>To change test parameters (image, commands, replicas, etc.), <strong>delete and recreate</strong> the CR:</p>
+<div class="highlight"><pre><span></span><code><span class="c1"># Delete the existing test</span>
+kubectl<span class="w"> </span>delete<span class="w"> </span>locusttest<span class="w"> </span>&lt;test-name&gt;
+
+<span class="c1"># Edit your CR YAML with the desired changes, then re-apply</span>
+kubectl<span class="w"> </span>apply<span class="w"> </span>-f<span class="w"> </span>locusttest-cr.yaml
+</code></pre></div>
+<p>This design ensures:</p>
 <ul>
-<li>Predictable behavior</li>
-<li>Clean test isolation</li>
+<li><strong>Predictable behavior</strong> — each test run uses exactly the configuration it was created with</li>
+<li><strong>Clean test isolation</strong> — no mid-flight configuration drift</li>
+<li><strong>Simple lifecycle</strong> — create, run, observe, delete</li>
 </ul>
 <h3 id="owner-references">Owner References<a class="headerlink" href="#owner-references" title="Anchor link to this section for reference">⚓</a></h3>
 <p>All created resources (Jobs, Services) have owner references pointing to the LocustTest CR. This enables:</p>
@@ -873,7 +882,7 @@ <h3 id="steps-performed-in-demo">Steps performed in demo<a class="headerlink" hr
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="February 10, 2026 11:45:58 UTC">February 10, 2026</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="February 10, 2026 21:43:03 UTC">February 10, 2026</span>
   </span>
 
 

pr-274/integration-testing/index.html

@@ -1117,7 +1117,7 @@ <h2 id="test-structure">Test Structure<a class="headerlink" href="#test-structur
 </code></pre></div>
 <h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Anchor link to this section for reference">⚓</a></h2>
 <ul>
-<li><strong>Go 1.23+</strong>: Required for running tests</li>
+<li><strong>Go 1.24+</strong>: Required for running tests</li>
 <li><strong>Docker</strong>: Required for E2E tests (Kind)</li>
 <li><strong>Kind</strong>: Required for E2E tests</li>
 </ul>
@@ -1248,7 +1248,7 @@ <h2 id="related-documentation">Related Documentation<a class="headerlink" href="
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="February 10, 2026 11:45:58 UTC">February 10, 2026</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="February 10, 2026 21:43:03 UTC">February 10, 2026</span>
   </span>
 
 

pr-274/local-development/index.html

@@ -983,7 +983,7 @@ <h1 id="local-development-guide">Local Development Guide<a class="headerlink" hr
 <h2 id="development-setup">Development Setup<a class="headerlink" href="#development-setup" title="Anchor link to this section for reference">⚓</a></h2>
 <h3 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Anchor link to this section for reference">⚓</a></h3>
 <ul>
-<li><strong>Go 1.23+</strong>: Required for building the operator</li>
+<li><strong>Go 1.24+</strong>: Required for building the operator</li>
 <li><strong>Docker</strong>: Running Docker daemon for building images</li>
 <li><strong>kubectl</strong>: Kubernetes CLI for cluster interaction</li>
 <li><strong>Kind</strong> or <strong>Minikube</strong>: Local Kubernetes cluster for testing</li>
@@ -1164,7 +1164,7 @@ <h3 id="preview-documentation-locally">Preview Documentation Locally<a class="he
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="February 10, 2026 11:45:58 UTC">February 10, 2026</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="February 10, 2026 21:43:03 UTC">February 10, 2026</span>
   </span>
 
 

pr-274/migration/index.html

@@ -1176,17 +1176,35 @@ <h3 id="backup-recommendations">Backup Recommendations<a class="headerlink" href
 <span class="c1"># Export operator Helm values</span>
 helm<span class="w"> </span>get<span class="w"> </span>values<span class="w"> </span>locust-operator<span class="w"> </span>-n<span class="w"> </span>&lt;namespace&gt;<span class="w"> </span>&gt;<span class="w"> </span>values-backup.yaml
 </code></pre></div>
+<div class="admonition danger">
+<p class="admonition-title">Critical: Webhook Required for v1 API Compatibility</p>
+<p>If you have existing v1 <code>LocustTest</code> CRs, the conversion webhook is <strong>required</strong> for them to continue working after upgrading to v2. Without it, v1 CRs will fail CRD schema validation.</p>
+<p>You <strong>must</strong>:</p>
+<ol>
+<li>Install <a href="https://cert-manager.io/docs/installation/">cert-manager</a> before upgrading</li>
+<li>Enable the webhook during upgrade: <code>--set webhook.enabled=true</code></li>
+<li>Verify the webhook is running after upgrade</li>
+</ol>
+<p>If you only use v2 CRs (or are starting fresh), the webhook is optional.</p>
+</div>
 <hr />
 <h2 id="step-1-update-helm-chart">Step 1: Update Helm Chart<a class="headerlink" href="#step-1-update-helm-chart" title="Anchor link to this section for reference">⚓</a></h2>
 <h3 id="upgrade-command">Upgrade Command<a class="headerlink" href="#upgrade-command" title="Anchor link to this section for reference">⚓</a></h3>
 <div class="highlight"><pre><span></span><code><span class="c1"># Update Helm repository</span>
 helm<span class="w"> </span>repo<span class="w"> </span>update<span class="w"> </span>locust-k8s-operator
 
-<span class="c1"># Upgrade to v2</span>
+<span class="c1"># Upgrade to v2 (with webhook for v1 CR compatibility)</span>
 helm<span class="w"> </span>upgrade<span class="w"> </span>locust-operator<span class="w"> </span>locust-k8s-operator/locust-k8s-operator<span class="w"> </span><span class="se">\</span>
 <span class="w">  </span>--namespace<span class="w"> </span>locust-system<span class="w"> </span><span class="se">\</span>
-<span class="w">  </span>--version<span class="w"> </span><span class="m">2</span>.0.0
+<span class="w">  </span>--version<span class="w"> </span><span class="m">2</span>.0.0<span class="w"> </span><span class="se">\</span>
+<span class="w">  </span>--set<span class="w"> </span>webhook.enabled<span class="o">=</span><span class="nb">true</span>
+
+<span class="c1"># If you don&#39;t need v1 API compatibility, you can omit --set webhook.enabled=true</span>
 </code></pre></div>
+<div class="admonition note">
+<p class="admonition-title">CRD Upgrade</p>
+<p>Helm automatically upgrades the CRD when using <code>helm upgrade</code>. The v2 CRD includes conversion webhook configuration when webhooks are enabled, allowing the API server to convert between v1 and v2 formats transparently.</p>
+</div>
 <h3 id="new-helm-values">New Helm Values<a class="headerlink" href="#new-helm-values" title="Anchor link to this section for reference">⚓</a></h3>
 <p>The v2 chart introduces a cleaner structure. Key changes:</p>
 <table>
@@ -1239,7 +1257,7 @@ <h3 id="operator-resource-defaults">Operator Resource Defaults<a class="headerli
 <p>The Go operator controller requires significantly fewer resources than the Java version:</p>
 <div class="highlight"><pre><span></span><code><span class="nt">resources</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">limits</span><span class="p">:</span>
-<span class="w">    </span><span class="nt">memory</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">128Mi</span>
+<span class="w">    </span><span class="nt">memory</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">256Mi</span>
 <span class="w">    </span><span class="nt">cpu</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">500m</span>
 <span class="w">  </span><span class="nt">requests</span><span class="p">:</span>
 <span class="w">    </span><span class="nt">memory</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">64Mi</span>
@@ -1588,7 +1606,7 @@ <h2 id="rollback-procedure">Rollback Procedure<a class="headerlink" href="#rollb
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="February 10, 2026 11:45:58 UTC">February 10, 2026</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="February 10, 2026 21:43:03 UTC">February 10, 2026</span>
   </span>