You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/index.md
+38-19Lines changed: 38 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,50 +2,69 @@
2
2
3
3
Automated performance and load testing for Azure Local clusters — storage, network, database, and system stress — with standardised reporting.
4
4
5
+
!!! tip "Each test is standalone"
6
+
Every tool in this framework runs independently from a PowerShell terminal. No CI/CD pipeline is required. Pick a tool, follow the steps on its page, and run your test.
All scripts consume ConfigManager-generated JSON (never the raw YAML). Results flow from target nodes via SSH/SCP or WinRM to JSON aggregates, then into AsciiDoc report templates. See the [Architecture Overview](architecture/overview.md) for the full breakdown.
52
+
All scripts are in `tools/<tool>/scripts/` and can be called directly from PowerShell. No pipeline setup required.
53
+
54
+
For the full architecture breakdown, see [Architecture Overview](architecture/overview.md).
30
55
31
-
## Tools
56
+
## Want to Automate?
32
57
33
-
| Tool | Target OS | Category | Status | Profiles |
|[fio](tools/fio/overview.md)| Linux | Storage I/O || 5 |
36
-
|[iPerf3](tools/iperf/overview.md)| Linux / Windows | Network || 3 |
37
-
|[HammerDB](tools/hammerdb/overview.md)| Windows | Database || 2 |
38
-
|[stress-ng](tools/stress-ng/overview.md)| Linux | CPU / Memory / I/O || 3 |
39
-
|[VMFleet](tools/vmfleet/overview.md)| Windows (HCI) | VM fleet || — |
58
+
CI/CD pipelines are available as an **optional addition** if you want to run tests on a schedule, trigger them from pull requests, or integrate into your deployment workflow. See [CI/CD Pipelines](operations/ci-cd.md).
40
59
41
60
## Navigation
42
61
43
62
| Section | Description |
44
63
|---------|-------------|
45
64
|[Getting Started](getting-started/introduction.md)| Prerequisites, installation, and first run |
65
+
|[Tools Overview](tools/index.md)| All tools at a glance with selection guide |
46
66
|[Architecture](architecture/overview.md)| Five-layer stack, tool selection, data flow |
The framework includes pipeline definitions for GitHub Actions (primary), Azure DevOps, and GitLab CI.
5
+
!!! info "Pipelines are optional"
6
+
Every test in this framework can be run standalone from a PowerShell terminal. CI/CD pipelines are an **optional addition** for teams that want to automate, schedule, or integrate load testing into their deployment workflows.
6
7
7
-
## GitHub Actions (Primary)
8
+
The framework includes pipeline definitions for GitHub Actions (primary), Azure DevOps, and GitLab CI. These pipelines call the **same scripts** you would run manually — they are not a separate system.
8
9
9
-
### Documentation Build (`build-docs.yml`)
10
+
##When to Use CI/CD
10
11
11
-
Triggers on push to `main` and pull requests. Builds HTML and PDF documentation, exports draw.io diagrams, and publishes artifacts.
12
+
| Use Case | Standalone | CI/CD |
13
+
|----------|-----------|-------|
14
+
| One-off test run from your workstation |:white_check_mark:||
Triggers on changes to `config/`. Validates `variables.yml` against the JSON Schema and verifies solution config generation.
38
66
39
-
Pipeline definitions in `.azuredevops/pipelines/` mirror the GitHub Actions workflows, adapted for Azure DevOps syntax. Use Azure DevOps Service Connections for credential management.
67
+
### Documentation Build (`deploy-docs.yml`)
40
68
41
-
## GitLab CI (Placeholder)
69
+
Triggers on push to `main` and pull requests. Builds MkDocs HTML documentation and publishes to GitHub Pages.
42
70
43
-
Pipeline definition in `.gitlab/.gitlab-ci.yml` provides the same workflow stages, adapted for GitLab CI syntax.
71
+
### Linting (`lint.yml`)
44
72
45
-
## Manual Execution
73
+
Runs PSScriptAnalyzer for PowerShell, yamllint for YAML files.
46
74
47
-
Every pipeline action can also be run manually from a workstation:
Pipeline definitions in `.azuredevops/` mirror the GitHub Actions workflows, adapted for Azure DevOps syntax. Use Azure DevOps Service Connections for credential management.
fio provides fine-grained storage I/O benchmarking with precise control over block sizes, queue depths, I/O engines, and workload patterns. It runs inside Linux VMs on the Azure Local cluster via Ansible deployment.
7
+
8
+
---
9
+
10
+
## Run This Test
11
+
12
+
### Prerequisites
13
+
14
+
- Linux VMs deployed on your Azure Local cluster
15
+
- Ansible 2.14+ installed on your management workstation
| Profile parameters and tuning |[Workload Profiles](workload-profiles.md)|
100
+
| Alert rules during test runs |[Monitoring](monitoring.md)|
101
+
| Report formats and templates |[Reporting](reporting.md)|
102
+
| Common errors and fixes |[Troubleshooting](troubleshooting.md)|
103
+
104
+
---
105
+
106
+
## Automate This Test
107
+
108
+
To run fio tests on a schedule or as part of a CI/CD workflow, see [CI/CD Pipelines](../../operations/ci-cd.md). The pipeline calls the same scripts listed above.
0 commit comments