Update valet-forecast-lab.md

2022-08-17 16:20:51 -04:00
parent 483df41625
commit 33679df2ce
1 changed files with 89 additions and 6 deletions
@@ -10,17 +10,100 @@ In this lab we will us the `forecast` command to forecast potential GitHub Actio

 1. Followed [steps](../gitlab#readme) to set up your codespace environment.
 2. Completed the [configure lab](../gitlab/valet-configure-lab.md)
+3. Ran the setup script in the terminal to make sure the GitLab instance is ready 
+   ```
+   source gitlab/bootstrap/setup.sh
+   ```

 ## Prepare for forecast
 Before we can run the forecast we need to answer a few questions so we can construct the correct command
-1) What namespace do we want to run the forecast for?  __Valet__. This is the only group in the demo GitLab instance.
-2) What is the date we want to start forecasting from?  __08-02-2022__. This is around but before the time the data was populated on our demo GitLab instance.
-3) Where do we want to store the results? __./tmp/forecast__. This can be any valid path on the system, but for simplicity it is recommend to use a directory in the root of the codespace workspace.
+1) What namespace do we want to run the forecast for?  __valet. This is the only group in the demo GitLab instance.__
+2) What is the date we want to start forecasting from?  __08-02-2022. This is around but before the time the data was populated on our demo GitLab instance.__
+3) Where do we want to store the results? __./tmp/forecast_reports. This can be any valid path on the system, but for simplicity it is recommend to use a directory in the root of the codespace workspace.__

 ## Perform a forecast
-### TBD
-
-
+- Construct the command using the values from the questions above, it should look like:
+```
+gh valet forecast gitlab --output-dir ./tmp/forecast_reports --namespace valet --start-date 08-02-2022
+```
+- Run the command in the codespace terminal
+- Verify that you command outputed a similar result 
+  ![forecast_output](https://user-images.githubusercontent.com/18723510/185232893-1ed46bca-f310-47dc-804c-40c13737f231.png)

 ## Review forecast output
+We will now review the `forecast` outputed files
+### forecast_report.md
+- From the codespace explorer pane find `./tmp/forecast_reports/forecast_report.md` and click to open
+  ![forecast_explorer](https://user-images.githubusercontent.com/18723510/185234641-948a551b-316f-4cce-9e7d-4c078ae11a04.png)
+- The file should be similar to this
+  <details>
+  <summary>example forecast_report.md</summary>
+  
+  ```
+  # Forecast report for [GitLab](http://localhost/valet)
+
+  - Valet version: **0.1.0.13432(03b5bc9370a8f0073c0cc1a4b25f6b81d0005c0f)**
+  - Performed at: **8/17/22 at 20:00**
+  - Date range: **2/8/22 - 8/17/22**
+
+  ## Total
+
+  - Job count: **57**
+  - Pipeline count: **15**
+
+  - Execution time
+
+    - Total: **135 minutes**
+    - Median: **0 minutes**
+    - P90: **7 minutes**
+    - Min: **0 minutes**
+    - Max: **10 minutes**
+
+  - Queue time
+
+    - Median: **0 minutes**
+    - P90: **5 minutes**
+    - Min: **0 minutes**
+    - Max: **42 minutes**
+
+  - Concurrent jobs
+
+    - Median: **0**
+    - P90: **0**
+    - Min: **0**
+    - Max: **9**
+
+  ---
+
+  ## gitlab-runner
+
+  - Job count: **57**
+  - Pipeline count: **15**
+
+  - Execution time
+
+    - Total: **135 minutes**
+    - Median: **0 minutes**
+    - P90: **7 minutes**
+    - Min: **0 minutes**
+    - Max: **10 minutes**
+
+  - Queue time
+
+    - Median: **0 minutes**
+    - P90: **5 minutes**
+    - Min: **0 minutes**
+    - Max: **42 minutes**
+
+  - Concurrent jobs
+
+    - Median: **0**
+    - P90: **0**
+    - Min: **0**
+    - Max: **9**
+
+  > Note: Concurrent jobs are calculated by using a sliding window of 1m 0s.
+  ```
+  
+  </details>
 ### TBD