Update valet-forecast-lab.md
This commit is contained in:
@@ -9,14 +9,14 @@ In this lab we will us the `forecast` command to forecast potential GitHub Actio
|
|||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
1. Followed [steps](../gitlab#readme) to set up your codespace environment.
|
1. Followed [steps](../gitlab#readme) to set up your codespace environment.
|
||||||
2. Completed the [configure lab](../gitlab/valet-configure-lab.md)
|
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
|
3. Ran the setup script in the terminal to make sure the GitLab instance is ready .
|
||||||
```
|
```
|
||||||
source gitlab/bootstrap/setup.sh
|
source gitlab/bootstrap/setup.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
## Prepare for forecast
|
## Prepare for forecast
|
||||||
Before we can run the forecast we need to answer a few questions so we can construct the correct command
|
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.__
|
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.__
|
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.__
|
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.__
|
||||||
@@ -26,20 +26,19 @@ Before we can run the forecast we need to answer a few questions so we can const
|
|||||||
```
|
```
|
||||||
gh valet forecast gitlab --output-dir ./tmp/forecast_reports --namespace valet --start-date 08-02-2022
|
gh valet forecast gitlab --output-dir ./tmp/forecast_reports --namespace valet --start-date 08-02-2022
|
||||||
```
|
```
|
||||||
- Run the command in the codespace terminal
|
- Run the command in the codespace terminal.
|
||||||
- Verify that you command outputed a similar result
|
- Verify that you command outputed a similar result.
|
||||||

|

|
||||||
|
|
||||||
## Review forecast output
|
## Review forecast report
|
||||||
We will now review the `forecast` outputed files
|
Lets open the forecast report and look at the calculated metrics.
|
||||||
### forecast_report.md
|
- From the codespace explorer pane find `./tmp/forecast_reports/forecast_report.md` and click to open.
|
||||||
- From the codespace explorer pane find `./tmp/forecast_reports/forecast_report.md` and click to open
|
|
||||||

|

|
||||||
- The file should be similar to this
|
- The file should be similar to this.
|
||||||
<details>
|
<details>
|
||||||
<summary>example forecast_report.md</summary>
|
<summary>example forecast_report.md</summary>
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
# Forecast report for [GitLab](http://localhost/valet)
|
# Forecast report for [GitLab](http://localhost/valet)
|
||||||
|
|
||||||
- Valet version: **0.1.0.13432(03b5bc9370a8f0073c0cc1a4b25f6b81d0005c0f)**
|
- Valet version: **0.1.0.13432(03b5bc9370a8f0073c0cc1a4b25f6b81d0005c0f)**
|
||||||
@@ -104,6 +103,11 @@ We will now review the `forecast` outputed files
|
|||||||
|
|
||||||
> Note: Concurrent jobs are calculated by using a sliding window of 1m 0s.
|
> Note: Concurrent jobs are calculated by using a sliding window of 1m 0s.
|
||||||
```
|
```
|
||||||
|
### Metrics
|
||||||
|
|
||||||
|
### Sections
|
||||||
|
- `Total` shows the metrics using all of the known runners.
|
||||||
|
- `gitlab-runner` shows the metrics for the runners in the gitlab-runner group, if there were other groups they would show here under their own group heading.
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
### TBD
|
### TBD
|
||||||
|
|||||||
Reference in New Issue
Block a user