Skip to content

Commit 678ccf6

Browse files
maryamtahhanclaude
andcommitted
docs: add setup-platform.yml reference to prerequisites
Updates README to recommend using the automated setup-platform.yml playbook instead of manual package installation. This provides a more streamlined setup process and ensures all performance tuning configurations are applied. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 9939589 commit 678ccf6

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

automation/test-execution/ansible/readme.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,71 @@
44

55
This directory contains Ansible playbooks for automated vLLM performance testing with CPU core configuration sweeps.
66

7+
## Quick Start
8+
9+
### Prerequisites
10+
11+
#### 1. Ansible Collections (Control Machine)
12+
13+
**On the machine where you run Ansible** (your local machine or jump host), install the required collections:
14+
15+
```bash
16+
# Navigate to the ansible directory
17+
cd automation/test-execution/ansible
18+
19+
# Install required Ansible collections
20+
ansible-galaxy collection install -r requirements.yml
21+
22+
# Or install individually
23+
ansible-galaxy collection install containers.podman ansible.posix
24+
```
25+
26+
**Ansible Version Compatibility:**
27+
- **Ansible 2.14.x**: Uses `requirements.yml` with pinned versions (containers.podman 1.9.x, ansible.posix 1.4.x-1.5.x)
28+
- **Ansible 2.15+**: Recommended for latest features and security updates
29+
30+
To upgrade Ansible:
31+
32+
```bash
33+
# Via DNF (RHEL/CentOS)
34+
sudo dnf upgrade ansible-core
35+
36+
# Via pip
37+
pip3 install --upgrade ansible-core
38+
```
39+
40+
#### 2. System Packages (Target System)
41+
42+
**Option 1: Automated setup (Recommended)**
43+
44+
Use the platform setup playbook to install all required packages and configure optimal performance settings:
45+
46+
```bash
47+
ansible-playbook -i inventory/hosts.yml setup-platform.yml
48+
```
49+
50+
This installs: `podman`, `numactl`, `tuned`, `kernel-tools`, and configures CPU isolation, performance governor, and systemd CPU pinning.
51+
52+
**Option 2: Manual installation**
53+
54+
If you prefer manual setup, install the required packages:
55+
56+
```bash
57+
# Install required system utilities (RHEL/CentOS/Fedora)
58+
sudo dnf install -y podman rsync python3 numactl
59+
```
60+
61+
#### 3. Verify Installation
62+
63+
```bash
64+
# On control machine: Check Ansible collections
65+
ansible-galaxy collection list
66+
67+
# On target system: Verify system packages
68+
podman --version
69+
rsync --version
70+
```
71+
772
## Playbook Hierarchy
873

974
### Single Test Playbooks ✅

0 commit comments

Comments
 (0)