IBM · isumitsolanki · Jul 30, 2026 · Jul 30, 2026
diff --git a/.ansible-lint b/.ansible-lint
@@ -9,6 +9,7 @@ profile: null # min, basic, moderate, safety, shared, production
 exclude_paths:
   - .github/
   - docs/
+  - mkdocs.yaml
 # parseable: true
 # quiet: true
 # strict: true

diff --git a/docs/ABI_KVM_QUICK_REFERENCE.md b/docs/ABI_KVM_QUICK_REFERENCE.md
@@ -0,0 +1,6 @@
+
+
+> **⚠️ Important Note**: This is a quick reference guide focusing on KVM-specific ABI configuration. For a complete setup, you must also configure all other required variables. See:
+> - **Complete Variable Reference**: [set-variables-group-vars.md](set-variables-group-vars.md) and [set-variables-host-vars.md](set-variables-host-vars.md)
+> - **Full Setup Instructions**: [run-the-playbooks-for-abi.md](run-the-playbooks-for-abi.md)
+> - **LPAR Quick Reference**: [ABI_LPAR_QUICK_REFERENCE.md](ABI_LPAR_QUICK_REFERENCE.md)
diff --git a/docs/ABI_LPAR_QUICK_REFERENCE.md b/docs/ABI_LPAR_QUICK_REFERENCE.md
@@ -0,0 +1,196 @@
+# ABI LPAR Quick Reference Card
+
+## 🚀 Quick Start
+
+### Step 1: Set Installation Type
+**File**: `inventories/default/group_vars/all.yaml`
+```yaml
+installation_type: lpar
+
+abi:
+  flag: True
+  boot_method: pxe
+```
+
+### Step 2: Configure Storage for Each Node
+**File**: `inventories/default/host_vars/{node-name}.yaml`
+```yaml
+lpar:
+  storage_group_1:
+    type: fcp
+    dev_num: "1a00"
+    storage_wwpn:
+      - "0x500507680b2a5f7e"
+    lun_name: "0x4000000000000000"
+```
+
+### Step 3: Run Playbook
+```bash
+ansible-playbook playbooks/master_playbook_for_abi.yaml
+```
+
+---
+
+## 📋 Configuration Checklist
+
+- [ ] Set `installation_type: lpar` in all.yaml
+- [ ] Set `abi.flag: True` in all.yaml
+- [ ] Configure `lpar.storage_group_1` in each node's host_vars
+- [ ] Verify `storage_group_1.type: fcp`
+- [ ] Ensure dev_num, storage_wwpn, and lun_name are set
+- [ ] Node names in all.yaml match host_vars filenames
+
+---
+
+## 🔧 Storage Configuration Format
+
+### Required Fields
+| Field | Format | Example |
+|-------|--------|---------|
+| `dev_num` | 4-digit hex (no prefix) | `"1a00"` |
+| `storage_wwpn[0]` | Hex with 0x prefix | `"0x500507680b2a5f7e"` |
+| `lun_name` | Hex with 0x prefix | `"0x4000000000000000"` |
+
+### Generated Device Path
+```
+/dev/disk/by-path/ccw-0.0.{dev_num}-fc-{wwpn}-lun-{lun_name}
+```
+
+**Example Output**:
+```
+/dev/disk/by-path/ccw-0.0.1a00-fc-0x500507680b2a5f7e-lun-0x4000000000000000
+```
+
+---
+
+## 📝 Example Configurations
+
+### Control Node
+**File**: `host_vars/control-1.yaml`
+```yaml
+lpar:
+  storage_group_1:
+    name: storage_group_1
+    type: fcp
+    storage_wwpn:
+      - "0x500507680b2a5f7e"
+      - "0x500507680b2a5f7f"
+    dev_num: "1a00"
+    lun_name: "0x4000000000000000"
+```
+
+### Compute Node
+**File**: `host_vars/compute-1.yaml`
+```yaml
+lpar:
+  storage_group_1:
+    name: storage_group_1
+    type: fcp
+    storage_wwpn:
+      - "0x500507680b2a5f7e"
+      - "0x500507680b2a5f7f"
+    dev_num: "1a00"
+    lun_name: "0x4002000000000000"  # Different LUN
+```
+
+---
+
+## 🔍 Verification
+
+### Check Generated agent-config.yaml
+**Location**: `~/ansible_workdir/agent-config.yaml` on bastion
+
+**Expected for LPAR**:
+```yaml
+hosts:
+  - hostname: "control-1"
+    role: master
+    rootDeviceHints:
+      deviceName: /dev/disk/by-path/ccw-0.0.1a00-fc-...
+```
+
+**Expected for KVM**:
+```yaml
+hosts:
+  - hostname: "control-1"
+    role: master
+    # No rootDeviceHints
+```
+
+---
+
+## ⚠️ Common Issues
+
+### Issue: No rootDeviceHints in agent-config.yaml
+**Solution**:
+- ✅ Verify `installation_type: lpar`
+- ✅ Check `lpar.storage_group_1.type: fcp`
+- ✅ Ensure host_vars file exists for each node
+
+### Issue: Wrong device path
+**Solution**:
+- ✅ dev_num: Use "1a00" NOT "0.0.1a00"
+- ✅ wwpn: Include "0x" prefix
+- ✅ lun_name: Include "0x" prefix
+
+### Issue: Template error loading host_vars
+**Solution**:
+- ✅ Node name in `env.cluster.nodes.control.vm_name` must match host_vars filename
+- ✅ Example: `vm_name: control-1` → file: `host_vars/control-1.yaml`
+
+---
+
+## 🎯 Key Differences: KVM vs LPAR
+
+| Feature | KVM | LPAR |
+|---------|-----|------|
+| rootDeviceHints | ❌ Not needed | ✅ Required |
+| Storage Config | Virtual disks | FCP/DASD |
+| Device Path | Auto-detected | Must specify |
+| host_vars Required | Optional | **Required** |
+
+---
+
+## 📚 Related Documentation
+
+- **Full Guide**: `docs/abi-lpar-configuration.md`
+- **Implementation Details**: `docs/IMPLEMENTATION_SUMMARY_ABI_LPAR.md`
+- **Main Docs**: https://ibm.github.io/Ansible-OpenShift-Provisioning/
+
+---
+
+## 🔗 Playbook Flow
+
+```
+master_playbook_for_abi.yaml
+  ├─ 0_setup.yaml (Setup environment)
+  ├─ 4_create_bastion.yaml (Create bastion)
+  ├─ 5_setup_bastion.yaml (Setup bastion)
+  ├─ create_abi_cluster.yaml
+  │   ├─ prepare_configs (Generate agent-config.yaml with rootDeviceHints)
+  │   ├─ create_agent (Generate installation images)
+  │   └─ boot_abi_agents (Boot nodes)
+  └─ monitor_create_abi_cluster.yaml (Monitor installation)
+```
+
+---
+
+## 💡 Pro Tips
+
+1. **Reuse Configuration**: The same `lpar.storage_group_1` is used for both booting and ABI installation
+2. **Multiple Nodes**: Each node can have different storage configuration
+3. **Multipath**: List all WWPNs in `storage_wwpn` array, but only first is used for rootDeviceHints
+4. **Validation**: Check generated agent-config.yaml before running create_agent role
+
+---
+
+## 🆘 Need Help?
+
+- **Troubleshooting**: See `docs/abi-lpar-configuration.md` → Troubleshooting section
+- **GitHub Issues**: https://github.com/IBM/Ansible-OpenShift-Provisioning/issues
+- **Documentation**: https://ibm.github.io/Ansible-OpenShift-Provisioning/
+
+---
+
+**Version**: 2.3.0+  
+**Last Updated**: 2026-04-05