build

Author: concourse-bot

docs/operation/administration/index.html

@@ -113,7 +113,7 @@
     <div data-md-component="skip">
 
 
-        <a href="#fly-workers" class="md-skip">
+        <a href="#managing-workers" class="md-skip">
           Skip to content
         </a>
 
@@ -4201,6 +4201,18 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
+  <a href="#managing-workers" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Managing Workers
+      
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="Managing Workers">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
   <a href="#fly-workers" class="md-nav__link">
     <span class="md-ellipsis">
 
@@ -4210,8 +4222,8 @@
   </a>
 
 </li>
-      
-        <li class="md-nav__item">
+        
+          <li class="md-nav__item">
   <a href="#fly-prune-worker" class="md-nav__link">
     <span class="md-ellipsis">
 
@@ -4221,8 +4233,8 @@
   </a>
 
 </li>
-      
-        <li class="md-nav__item">
+        
+          <li class="md-nav__item">
   <a href="#fly-land-worker" class="md-nav__link">
     <span class="md-ellipsis">
 
@@ -4231,20 +4243,87 @@
     </span>
   </a>
 
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
 
         <li class="md-nav__item">
-  <a href="#fly-containers" class="md-nav__link">
+  <a href="#broadcast-message-system" class="md-nav__link">
     <span class="md-ellipsis">
 
-        fly containers
+        Broadcast Message System
+      
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="Broadcast Message System">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#fly-set-wall" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        fly set-wall
 
     </span>
   </a>
 
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#fly-get-wall" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        fly get-wall
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#fly-clear-wall" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        fly clear-wall
+      
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
 
         <li class="md-nav__item">
+  <a href="#diagnostic-troubleshooting" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Diagnostic / Troubleshooting
+      
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="Diagnostic / Troubleshooting">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#fly-containers" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        fly containers
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
   <a href="#fly-volumes" class="md-nav__link">
     <span class="md-ellipsis">
 
@@ -4254,8 +4333,8 @@
   </a>
 
 </li>
-      
-        <li class="md-nav__item">
+        
+          <li class="md-nav__item">
   <a href="#fly-curl" class="md-nav__link">
     <span class="md-ellipsis">
 
@@ -4264,6 +4343,11 @@
     </span>
   </a>
 
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
 
     </ul>
@@ -5684,6 +5768,18 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
+  <a href="#managing-workers" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Managing Workers
+      
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="Managing Workers">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
   <a href="#fly-workers" class="md-nav__link">
     <span class="md-ellipsis">
 
@@ -5693,8 +5789,8 @@
   </a>
 
 </li>
-      
-        <li class="md-nav__item">
+        
+          <li class="md-nav__item">
   <a href="#fly-prune-worker" class="md-nav__link">
     <span class="md-ellipsis">
 
@@ -5704,8 +5800,8 @@
   </a>
 
 </li>
-      
-        <li class="md-nav__item">
+        
+          <li class="md-nav__item">
   <a href="#fly-land-worker" class="md-nav__link">
     <span class="md-ellipsis">
 
@@ -5714,20 +5810,87 @@
     </span>
   </a>
 
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
 
         <li class="md-nav__item">
-  <a href="#fly-containers" class="md-nav__link">
+  <a href="#broadcast-message-system" class="md-nav__link">
     <span class="md-ellipsis">
 
-        fly containers
+        Broadcast Message System
+      
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="Broadcast Message System">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#fly-set-wall" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        fly set-wall
 
     </span>
   </a>
 
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#fly-get-wall" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        fly get-wall
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#fly-clear-wall" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        fly clear-wall
+      
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
 
         <li class="md-nav__item">
+  <a href="#diagnostic-troubleshooting" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        Diagnostic / Troubleshooting
+      
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="Diagnostic / Troubleshooting">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#fly-containers" class="md-nav__link">
+    <span class="md-ellipsis">
+      
+        fly containers
+      
+    </span>
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
   <a href="#fly-volumes" class="md-nav__link">
     <span class="md-ellipsis">
 
@@ -5737,8 +5900,8 @@
   </a>
 
 </li>
-      
-        <li class="md-nav__item">
+        
+          <li class="md-nav__item">
   <a href="#fly-curl" class="md-nav__link">
     <span class="md-ellipsis">
 
@@ -5747,6 +5910,11 @@
     </span>
   </a>
 
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
 
     </ul>
@@ -5784,13 +5952,14 @@
 
   <h1>Administration</h1>
 
-<h2 id="fly-workers"><code>fly workers</code></h2>
+<h2 id="managing-workers">Managing Workers</h2>
+<h3 id="fly-workers"><code>fly workers</code></h3>
 <p>To list the currently registered workers, including additional metadata, run:</p>
 <div class="language-shell highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>fly<span class="w"> </span>-t<span class="w"> </span>example<span class="w"> </span>workers
 </span></code></pre></div>
 <p>This can be useful for monitoring the status of your workers, if you suspect that one keeps dropping out of the pool or
 getting tasked with too many containers, etc.</p>
-<h2 id="fly-prune-worker"><code>fly prune-worker</code></h2>
+<h3 id="fly-prune-worker"><code>fly prune-worker</code></h3>
 <p>To remove a stalled, landing, landed, or retiring worker, run:</p>
 <div class="language-shell highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>fly<span class="w"> </span>-t<span class="w"> </span>example<span class="w"> </span>prune-worker<span class="w"> </span>--worker<span class="w"> </span>worker-name
 </span></code></pre></div>
@@ -5802,30 +5971,53 @@ <h2 id="fly-prune-worker"><code>fly prune-worker</code></h2>
 <p class="admonition-title">Note</p>
 <p>Running workers cannot be pruned, since they'll just re-register themselves anyway.</p>
 </div>
-<h2 id="fly-land-worker"><code>fly land-worker</code></h2>
+<h3 id="fly-land-worker"><code>fly land-worker</code></h3>
 <p>To initiate landing of a worker and eventually (after draining) cause it to exit, run:</p>
 <div class="language-shell highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>fly<span class="w"> </span>-t<span class="w"> </span>example<span class="w"> </span>land-worker<span class="w"> </span>--worker<span class="w"> </span>worker-name
 </span></code></pre></div>
-<h2 id="fly-containers"><code>fly containers</code></h2>
+<h2 id="broadcast-message-system">Broadcast Message System</h2>
+<p>Concourse Admins who operate a big Concourse with many teams often want a way
+to communicate to everyone that the system is unstable/recovering. Setting
+a message on the Wall will result in a banner displaying the wall message in
+the Concourse web UI. The following commands are used to manage the Wall.</p>
+<div class="admonition tip">
+<p class="admonition-title">Fun Fact!</p>
+<p>"Wall" is a reference to the <a href="https://en.wikipedia.org/wiki/Wall_(Unix)">Unix <code>wall</code></a> CLI.</p>
+</div>
+<h3 id="fly-set-wall"><code>fly set-wall</code></h3>
+<p><em>Requires being a member of the main team</em>. To set a new wall with a message and expiration, run:</p>
+<div class="language-shell highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>fly<span class="w"> </span>-t<span class="w"> </span>main<span class="w"> </span>set-wall<span class="w"> </span>--message<span class="o">=</span><span class="s2">"⚠️ Hello World, there is an error ⚠️"</span><span class="w"> </span>--ttl<span class="o">=</span>5m
+</span></code></pre></div>
+<p>This will set a wall of "⚠️ Hello World, there is an error ⚠️" with an expiration of five minutes.</p>
+<h3 id="fly-get-wall"><code>fly get-wall</code></h3>
+<p>To get the current wall, run:</p>
+<div class="language-shell highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>fly<span class="w"> </span>-t<span class="w"> </span>main<span class="w"> </span>get-wall
+</span></code></pre></div>
+<h3 id="fly-clear-wall"><code>fly clear-wall</code></h3>
+<p><em>Requires being a member of the main team</em>. To clear a current wall, run:</p>
+<div class="language-shell highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>fly<span class="w"> </span>-t<span class="w"> </span>main<span class="w"> </span>clear-wall
+</span></code></pre></div>
+<h2 id="diagnostic-troubleshooting">Diagnostic / Troubleshooting</h2>
+<h3 id="fly-containers"><code>fly containers</code></h3>
 <p>To list the active containers across all your workers, run:</p>
-<div class="language-shell highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>fly<span class="w"> </span>-t<span class="w"> </span>example<span class="w"> </span>containers
+<div class="language-shell highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>fly<span class="w"> </span>-t<span class="w"> </span>example<span class="w"> </span>containers
 </span></code></pre></div>
 <p>This can be useful when discovering the containers available for <a href="../../builds/#fly-intercept"><code>fly intercept</code></a>ing.</p>
-<h2 id="fly-volumes"><code>fly volumes</code></h2>
+<h3 id="fly-volumes"><code>fly volumes</code></h3>
 <p>To list the active volumes across all your workers, run:</p>
-<div class="language-shell highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>fly<span class="w"> </span>-t<span class="w"> </span>example<span class="w"> </span>volumes
+<div class="language-shell highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>fly<span class="w"> </span>-t<span class="w"> </span>example<span class="w"> </span>volumes
 </span></code></pre></div>
 <p>This can be useful to observe the caches warming across your cluster, and could be a good indicator of disk use.</p>
-<h2 id="fly-curl"><code>fly curl</code></h2>
+<h3 id="fly-curl"><code>fly curl</code></h3>
 <p>To execute an arbitrary API request, you can run something like the following:</p>
-<div class="language-shell highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>fly<span class="w"> </span>-t<span class="w"> </span>example<span class="w"> </span>curl<span class="w"> </span>/api/v1/info
+<div class="language-shell highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>fly<span class="w"> </span>-t<span class="w"> </span>example<span class="w"> </span>curl<span class="w"> </span>/api/v1/info
 </span></code></pre></div>
 <p>This command is just a shim that runs <code>curl</code> under the hood. To pass flags to <code>curl</code>, pass a <code>--</code> argument after the
 path so that <code>fly</code> can distinguish them from its own flags:</p>
-<div class="language-shell highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>fly<span class="w"> </span>-t<span class="w"> </span>example<span class="w"> </span>curl<span class="w"> </span>/api/v1/builds<span class="w"> </span>--<span class="w"> </span><span class="se">\</span>
-</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="w">    </span>-X<span class="w"> </span>PUT<span class="w"> </span><span class="se">\</span>
-</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="w">    </span>-H<span class="w"> </span><span class="s2">"Content-type: application/json"</span><span class="w"> </span><span class="se">\</span>
-</span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="w">    </span>-d<span class="w"> </span>@plan.json
+<div class="language-shell highlight"><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>fly<span class="w"> </span>-t<span class="w"> </span>example<span class="w"> </span>curl<span class="w"> </span>/api/v1/builds<span class="w"> </span>--<span class="w"> </span><span class="se">\</span>
+</span><span id="__span-10-2"><a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="w">    </span>-X<span class="w"> </span>PUT<span class="w"> </span><span class="se">\</span>
+</span><span id="__span-10-3"><a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a><span class="w">    </span>-H<span class="w"> </span><span class="s2">"Content-type: application/json"</span><span class="w"> </span><span class="se">\</span>
+</span><span id="__span-10-4"><a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a><span class="w">    </span>-d<span class="w"> </span>@plan.json
 </span></code></pre></div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>