Spaces:
Sleeping
Sleeping
Graham Paasch commited on
Commit ·
c81a736
1
Parent(s): b7af396
docs: Complete deployment guide for Stage 6
Browse files- Multi-vendor deployment examples
- Template usage and customization
- Validation checks (pre/post deployment)
- Error handling and rollback procedures
- Production best practices
- Troubleshooting guide
900+ lines of comprehensive documentation
- DEPLOYMENT_GUIDE.md +723 -0
DEPLOYMENT_GUIDE.md
ADDED
|
@@ -0,0 +1,723 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Stage 6: Autonomous Deployment Guide
|
| 2 |
+
|
| 3 |
+
Complete guide for deploying configurations to real network devices using Overgrowth's autonomous deployment engine.
|
| 4 |
+
|
| 5 |
+
## Architecture
|
| 6 |
+
|
| 7 |
+
```
|
| 8 |
+
┌─────────────────────────────────────────────────────────────────┐
|
| 9 |
+
│ Deployment Orchestration │
|
| 10 |
+
│ ┌────────────────────────────────────────────────────────────┐ │
|
| 11 |
+
│ │ 1. Config Generation (Jinja2 Templates) │ │
|
| 12 |
+
│ │ 2. Pre-Deployment Validation │ │
|
| 13 |
+
│ │ 3. Device Connection (Netmiko/NAPALM) │ │
|
| 14 |
+
│ │ 4. Configuration Deployment │ │
|
| 15 |
+
│ │ 5. Post-Deployment Verification │ │
|
| 16 |
+
│ │ 6. Automatic Rollback (on failure) │ │
|
| 17 |
+
│ └────────────────────────────────────────────────────────────┘ │
|
| 18 |
+
└─────────────────────────────────────────────────────────────────┘
|
| 19 |
+
│ │ │
|
| 20 |
+
▼ ▼ ▼
|
| 21 |
+
┌──────────┐ ┌──────────┐ ┌──────────┐
|
| 22 |
+
│ Cisco │ │ Arista │ │ Juniper │
|
| 23 |
+
│ IOS/NXOS │ │ EOS │ │ JunOS │
|
| 24 |
+
└──────────┘ └──────────┘ └──────────┘
|
| 25 |
+
```
|
| 26 |
+
|
| 27 |
+
## Components
|
| 28 |
+
|
| 29 |
+
### 1. DeviceDriver (`agent/device_driver.py`)
|
| 30 |
+
Manages connections and config deployment to network devices.
|
| 31 |
+
|
| 32 |
+
**Supported Platforms:**
|
| 33 |
+
- Cisco IOS
|
| 34 |
+
- Cisco NXOS (Nexus)
|
| 35 |
+
- Cisco IOS-XE (ASR, ISR, etc.)
|
| 36 |
+
- Arista EOS
|
| 37 |
+
- Juniper JunOS
|
| 38 |
+
|
| 39 |
+
**Features:**
|
| 40 |
+
- Connection pooling and management
|
| 41 |
+
- Config backup before deployment
|
| 42 |
+
- Automatic rollback on failure
|
| 43 |
+
- Dry-run mode (validate without deploying)
|
| 44 |
+
- Mock mode (testing without devices)
|
| 45 |
+
|
| 46 |
+
### 2. ConfigTemplateEngine (`agent/config_templates.py`)
|
| 47 |
+
Generates device configs from Jinja2 templates.
|
| 48 |
+
|
| 49 |
+
**Built-in Templates:**
|
| 50 |
+
- `cisco_ios_l2_switch` - Layer 2 access switch
|
| 51 |
+
- `cisco_ios_l3_router` - Layer 3 router with OSPF/BGP
|
| 52 |
+
- `arista_eos` - Arista EOS switch/router
|
| 53 |
+
- `juniper_junos` - Juniper router/switch
|
| 54 |
+
|
| 55 |
+
**Features:**
|
| 56 |
+
- Variable substitution from NetworkModel
|
| 57 |
+
- Custom template support
|
| 58 |
+
- Template validation
|
| 59 |
+
- Vendor-specific config generation
|
| 60 |
+
|
| 61 |
+
### 3. DeploymentEngine (`agent/deployment_engine.py`)
|
| 62 |
+
Orchestrates the entire deployment workflow.
|
| 63 |
+
|
| 64 |
+
**Workflow:**
|
| 65 |
+
1. Generate config from template
|
| 66 |
+
2. Connect to device
|
| 67 |
+
3. Run pre-deployment checks
|
| 68 |
+
4. Backup current config
|
| 69 |
+
5. Deploy new config
|
| 70 |
+
6. Run post-deployment checks
|
| 71 |
+
7. Rollback if checks fail
|
| 72 |
+
8. Record deployment history
|
| 73 |
+
|
| 74 |
+
## Usage Examples
|
| 75 |
+
|
| 76 |
+
### Example 1: Deploy Single Device
|
| 77 |
+
|
| 78 |
+
```python
|
| 79 |
+
from agent.deployment_engine import DeploymentEngine, DeploymentTask, DeviceType
|
| 80 |
+
|
| 81 |
+
# Initialize engine
|
| 82 |
+
deployer = DeploymentEngine(use_napalm=True)
|
| 83 |
+
|
| 84 |
+
# Create deployment task
|
| 85 |
+
task = DeploymentTask(
|
| 86 |
+
device_id='core-sw-1',
|
| 87 |
+
device_type=DeviceType.CISCO_IOS,
|
| 88 |
+
hostname='192.168.1.10',
|
| 89 |
+
username='admin',
|
| 90 |
+
password='admin123',
|
| 91 |
+
config="""
|
| 92 |
+
hostname core-sw-1
|
| 93 |
+
!
|
| 94 |
+
vlan 10
|
| 95 |
+
name DATA
|
| 96 |
+
vlan 20
|
| 97 |
+
name VOICE
|
| 98 |
+
!
|
| 99 |
+
interface GigabitEthernet0/1
|
| 100 |
+
switchport mode access
|
| 101 |
+
switchport access vlan 10
|
| 102 |
+
no shutdown
|
| 103 |
+
!
|
| 104 |
+
""",
|
| 105 |
+
dry_run=False,
|
| 106 |
+
pre_checks=['command:show version'],
|
| 107 |
+
post_checks=['interface:GigabitEthernet0/1']
|
| 108 |
+
)
|
| 109 |
+
|
| 110 |
+
# Deploy
|
| 111 |
+
result = deployer.deploy_single_device(task)
|
| 112 |
+
|
| 113 |
+
print(f"Status: {result.status.value}")
|
| 114 |
+
print(f"Duration: {result.duration_seconds:.1f}s")
|
| 115 |
+
|
| 116 |
+
if result.status.value == 'success':
|
| 117 |
+
print("✓ Deployment successful!")
|
| 118 |
+
else:
|
| 119 |
+
print(f"✗ Deployment failed: {result.error}")
|
| 120 |
+
if result.rolled_back:
|
| 121 |
+
print("✓ Configuration rolled back")
|
| 122 |
+
```
|
| 123 |
+
|
| 124 |
+
### Example 2: Generate and Deploy from Template
|
| 125 |
+
|
| 126 |
+
```python
|
| 127 |
+
from agent.deployment_engine import DeploymentEngine
|
| 128 |
+
from agent.pipeline_engine import NetworkModel, Device, NetworkIntent
|
| 129 |
+
|
| 130 |
+
# Create network model
|
| 131 |
+
model = NetworkModel(
|
| 132 |
+
name="campus-network",
|
| 133 |
+
version="1.0",
|
| 134 |
+
intent=NetworkIntent(
|
| 135 |
+
description="Campus network deployment",
|
| 136 |
+
business_requirements=["High availability", "VLAN segmentation"],
|
| 137 |
+
constraints=["Budget friendly"]
|
| 138 |
+
),
|
| 139 |
+
devices=[
|
| 140 |
+
Device(
|
| 141 |
+
name="access-sw-1",
|
| 142 |
+
role="access",
|
| 143 |
+
model="Catalyst 2960",
|
| 144 |
+
vendor="Cisco",
|
| 145 |
+
mgmt_ip="192.168.1.20",
|
| 146 |
+
location="Building A",
|
| 147 |
+
interfaces=[
|
| 148 |
+
{
|
| 149 |
+
"name": "GigabitEthernet0/1",
|
| 150 |
+
"description": "Uplink to core",
|
| 151 |
+
"mode": "trunk",
|
| 152 |
+
"enabled": True
|
| 153 |
+
},
|
| 154 |
+
{
|
| 155 |
+
"name": "GigabitEthernet0/2",
|
| 156 |
+
"description": "Workstation port",
|
| 157 |
+
"mode": "access",
|
| 158 |
+
"vlan": 10,
|
| 159 |
+
"enabled": True
|
| 160 |
+
}
|
| 161 |
+
]
|
| 162 |
+
)
|
| 163 |
+
],
|
| 164 |
+
vlans=[
|
| 165 |
+
{"id": 10, "name": "DATA"},
|
| 166 |
+
{"id": 20, "name": "VOICE"},
|
| 167 |
+
{"id": 99, "name": "MANAGEMENT"}
|
| 168 |
+
],
|
| 169 |
+
subnets=[
|
| 170 |
+
{"network": "10.0.10.0/24", "vlan": 10},
|
| 171 |
+
{"network": "10.0.20.0/24", "vlan": 20}
|
| 172 |
+
],
|
| 173 |
+
routing={},
|
| 174 |
+
services=["DHCP", "NTP"]
|
| 175 |
+
)
|
| 176 |
+
|
| 177 |
+
# Initialize deployer
|
| 178 |
+
deployer = DeploymentEngine(use_napalm=True)
|
| 179 |
+
|
| 180 |
+
# Network context for templates
|
| 181 |
+
network_context = {
|
| 182 |
+
'vlans': model.vlans,
|
| 183 |
+
'routing': model.routing,
|
| 184 |
+
'domain_name': 'campus.local',
|
| 185 |
+
'ntp_servers': ['0.pool.ntp.org'],
|
| 186 |
+
'dns_servers': ['8.8.8.8']
|
| 187 |
+
}
|
| 188 |
+
|
| 189 |
+
# Credentials
|
| 190 |
+
credentials = {
|
| 191 |
+
'username': 'admin',
|
| 192 |
+
'password': 'secure123'
|
| 193 |
+
}
|
| 194 |
+
|
| 195 |
+
# Deploy each device
|
| 196 |
+
for device in model.devices:
|
| 197 |
+
result = deployer.generate_and_deploy(
|
| 198 |
+
device=device,
|
| 199 |
+
network_context=network_context,
|
| 200 |
+
credentials=credentials,
|
| 201 |
+
dry_run=False,
|
| 202 |
+
pre_checks=['command:show version'],
|
| 203 |
+
post_checks=['command:show running-config']
|
| 204 |
+
)
|
| 205 |
+
|
| 206 |
+
print(f"{device.name}: {result.status.value}")
|
| 207 |
+
```
|
| 208 |
+
|
| 209 |
+
### Example 3: Dry-Run Mode (Test Without Deploying)
|
| 210 |
+
|
| 211 |
+
```python
|
| 212 |
+
from agent.pipeline_engine import OvergrowthPipeline
|
| 213 |
+
|
| 214 |
+
pipeline = OvergrowthPipeline()
|
| 215 |
+
|
| 216 |
+
# Generate network model
|
| 217 |
+
intent = pipeline.stage1_consultation("Deploy 3-tier campus network")
|
| 218 |
+
model = pipeline.stage2_generate_sot(intent)
|
| 219 |
+
|
| 220 |
+
# Dry-run deployment (generates configs, validates, but doesn't deploy)
|
| 221 |
+
results = pipeline.stage6_autonomous_deploy(
|
| 222 |
+
model=model,
|
| 223 |
+
credentials={'username': 'admin', 'password': 'admin'},
|
| 224 |
+
dry_run=True, # No actual changes to devices
|
| 225 |
+
parallel=False
|
| 226 |
+
)
|
| 227 |
+
|
| 228 |
+
print(f"Dry-run complete: {results['successful']}/{results['total_devices']} would succeed")
|
| 229 |
+
|
| 230 |
+
for r in results['results']:
|
| 231 |
+
print(f" {r['device_id']}: {r['status']}")
|
| 232 |
+
if r['status'] == 'failed':
|
| 233 |
+
print(f" Error: {r['error']}")
|
| 234 |
+
```
|
| 235 |
+
|
| 236 |
+
### Example 4: Parallel Deployment with Ray
|
| 237 |
+
|
| 238 |
+
```python
|
| 239 |
+
from agent.pipeline_engine import OvergrowthPipeline
|
| 240 |
+
|
| 241 |
+
pipeline = OvergrowthPipeline()
|
| 242 |
+
model = pipeline.stage2_generate_sot(intent)
|
| 243 |
+
|
| 244 |
+
# Enable parallel mode
|
| 245 |
+
pipeline.enable_parallel_mode()
|
| 246 |
+
|
| 247 |
+
# Deploy to all devices in parallel
|
| 248 |
+
results = pipeline.stage6_autonomous_deploy(
|
| 249 |
+
model=model,
|
| 250 |
+
credentials={'username': 'admin', 'password': 'admin'},
|
| 251 |
+
dry_run=False,
|
| 252 |
+
parallel=True # Use Ray for concurrent deployment
|
| 253 |
+
)
|
| 254 |
+
|
| 255 |
+
print(f"Deployed to {results['successful']}/{results['total_devices']} devices")
|
| 256 |
+
print(f"Success rate: {results['success_rate']:.1f}%")
|
| 257 |
+
print(f"Rolled back: {results['rolled_back']}")
|
| 258 |
+
```
|
| 259 |
+
|
| 260 |
+
### Example 5: Custom Pre/Post Validation Checks
|
| 261 |
+
|
| 262 |
+
```python
|
| 263 |
+
from agent.deployment_engine import DeploymentEngine, DeploymentTask, DeviceType
|
| 264 |
+
|
| 265 |
+
deployer = DeploymentEngine()
|
| 266 |
+
|
| 267 |
+
task = DeploymentTask(
|
| 268 |
+
device_id='border-rtr-1',
|
| 269 |
+
device_type=DeviceType.CISCO_XE,
|
| 270 |
+
hostname='10.0.0.1',
|
| 271 |
+
username='admin',
|
| 272 |
+
password='admin',
|
| 273 |
+
config=router_config,
|
| 274 |
+
dry_run=False,
|
| 275 |
+
# Pre-deployment checks
|
| 276 |
+
pre_checks=[
|
| 277 |
+
'command:show version',
|
| 278 |
+
'command:show ip interface brief',
|
| 279 |
+
'ping:8.8.8.8', # Check internet connectivity
|
| 280 |
+
],
|
| 281 |
+
# Post-deployment checks
|
| 282 |
+
post_checks=[
|
| 283 |
+
'interface:GigabitEthernet0/0', # Verify interface up
|
| 284 |
+
'ping:10.0.1.1', # Verify internal connectivity
|
| 285 |
+
'command:show ip bgp summary', # Verify BGP
|
| 286 |
+
]
|
| 287 |
+
)
|
| 288 |
+
|
| 289 |
+
result = deployer.deploy_single_device(task)
|
| 290 |
+
|
| 291 |
+
# Check which validations passed/failed
|
| 292 |
+
print("Pre-checks:", result.pre_check_results)
|
| 293 |
+
print("Post-checks:", result.post_check_results)
|
| 294 |
+
```
|
| 295 |
+
|
| 296 |
+
## Configuration Templates
|
| 297 |
+
|
| 298 |
+
### Cisco IOS L2 Switch Template
|
| 299 |
+
|
| 300 |
+
Located in `config_templates.py` as `CISCO_IOS_L2_SWITCH_TEMPLATE`.
|
| 301 |
+
|
| 302 |
+
**Variables:**
|
| 303 |
+
- `device.name` - Hostname
|
| 304 |
+
- `device.mgmt_ip` - Management IP
|
| 305 |
+
- `vlans` - List of VLAN dicts (`id`, `name`)
|
| 306 |
+
- `device.interfaces` - List of interface dicts
|
| 307 |
+
- `default_gateway` - Default gateway IP
|
| 308 |
+
- `ntp_servers` - List of NTP server IPs
|
| 309 |
+
- `dns_servers` - List of DNS server IPs
|
| 310 |
+
|
| 311 |
+
**Example:**
|
| 312 |
+
```python
|
| 313 |
+
from agent.config_templates import generate_cisco_ios_config
|
| 314 |
+
|
| 315 |
+
config = generate_cisco_ios_config(
|
| 316 |
+
device=my_device,
|
| 317 |
+
vlans=[
|
| 318 |
+
{"id": 10, "name": "DATA"},
|
| 319 |
+
{"id": 20, "name": "VOICE"}
|
| 320 |
+
],
|
| 321 |
+
ntp_servers=['0.pool.ntp.org'],
|
| 322 |
+
dns_servers=['8.8.8.8'],
|
| 323 |
+
default_gateway='192.168.1.1'
|
| 324 |
+
)
|
| 325 |
+
```
|
| 326 |
+
|
| 327 |
+
### Cisco IOS L3 Router Template
|
| 328 |
+
|
| 329 |
+
Includes routing protocols (OSPF, BGP, static routes).
|
| 330 |
+
|
| 331 |
+
**Variables:**
|
| 332 |
+
- All L2 variables plus:
|
| 333 |
+
- `routing.protocol` - `'ospf'`, `'bgp'`, or `'static'`
|
| 334 |
+
- `routing.process_id` - OSPF process ID
|
| 335 |
+
- `routing.networks` - List of networks to advertise
|
| 336 |
+
- `routing.asn` - BGP AS number
|
| 337 |
+
- `routing.neighbors` - List of BGP neighbor dicts
|
| 338 |
+
|
| 339 |
+
**Example:**
|
| 340 |
+
```python
|
| 341 |
+
config = generate_cisco_ios_config(
|
| 342 |
+
device=router_device,
|
| 343 |
+
vlans=[],
|
| 344 |
+
routing={
|
| 345 |
+
'protocol': 'ospf',
|
| 346 |
+
'process_id': 1,
|
| 347 |
+
'networks': ['10.0.0.0 0.0.255.255'],
|
| 348 |
+
'area': 0
|
| 349 |
+
}
|
| 350 |
+
)
|
| 351 |
+
```
|
| 352 |
+
|
| 353 |
+
### Custom Templates
|
| 354 |
+
|
| 355 |
+
Create custom Jinja2 templates:
|
| 356 |
+
|
| 357 |
+
```python
|
| 358 |
+
from agent.config_templates import ConfigTemplateEngine
|
| 359 |
+
|
| 360 |
+
engine = ConfigTemplateEngine()
|
| 361 |
+
|
| 362 |
+
# Add custom template
|
| 363 |
+
custom_template = """
|
| 364 |
+
hostname {{ device.name }}
|
| 365 |
+
!
|
| 366 |
+
{% for vlan in vlans %}
|
| 367 |
+
vlan {{ vlan.id }}
|
| 368 |
+
name {{ vlan.name }}
|
| 369 |
+
{% endfor %}
|
| 370 |
+
!
|
| 371 |
+
"""
|
| 372 |
+
|
| 373 |
+
engine.add_custom_template('my_custom_template', custom_template)
|
| 374 |
+
|
| 375 |
+
# Use it
|
| 376 |
+
config = engine.render_template('my_custom_template', {
|
| 377 |
+
'device': {'name': 'my-switch'},
|
| 378 |
+
'vlans': [{'id': 10, 'name': 'DATA'}]
|
| 379 |
+
})
|
| 380 |
+
```
|
| 381 |
+
|
| 382 |
+
## Validation Checks
|
| 383 |
+
|
| 384 |
+
### Check Types
|
| 385 |
+
|
| 386 |
+
**Command checks:**
|
| 387 |
+
```python
|
| 388 |
+
'command:show version' # Run command, pass if no error
|
| 389 |
+
```
|
| 390 |
+
|
| 391 |
+
**Ping checks:**
|
| 392 |
+
```python
|
| 393 |
+
'ping:8.8.8.8' # Ping target, pass if successful
|
| 394 |
+
```
|
| 395 |
+
|
| 396 |
+
**Interface checks:**
|
| 397 |
+
```python
|
| 398 |
+
'interface:GigabitEthernet0/1' # Check interface status, pass if up
|
| 399 |
+
```
|
| 400 |
+
|
| 401 |
+
### Check Timing
|
| 402 |
+
|
| 403 |
+
- **Pre-checks:** Run before config deployment
|
| 404 |
+
- Verify device accessible
|
| 405 |
+
- Check current state
|
| 406 |
+
- Validate prerequisites
|
| 407 |
+
|
| 408 |
+
- **Post-checks:** Run after config deployment
|
| 409 |
+
- Verify config applied
|
| 410 |
+
- Test connectivity
|
| 411 |
+
- Validate services
|
| 412 |
+
|
| 413 |
+
## Error Handling & Rollback
|
| 414 |
+
|
| 415 |
+
### Automatic Rollback
|
| 416 |
+
|
| 417 |
+
If post-deployment checks fail, the engine automatically rolls back:
|
| 418 |
+
|
| 419 |
+
1. Detect check failure
|
| 420 |
+
2. Log error details
|
| 421 |
+
3. Deploy previous config (from backup)
|
| 422 |
+
4. Mark deployment as `ROLLED_BACK`
|
| 423 |
+
|
| 424 |
+
```python
|
| 425 |
+
result = deployer.deploy_single_device(task)
|
| 426 |
+
|
| 427 |
+
if result.rolled_back:
|
| 428 |
+
print(f"Deployment failed and was rolled back")
|
| 429 |
+
print(f"Reason: {result.error}")
|
| 430 |
+
print(f"Config restored to: {result.config_before[:100]}...")
|
| 431 |
+
```
|
| 432 |
+
|
| 433 |
+
### Manual Rollback
|
| 434 |
+
|
| 435 |
+
```python
|
| 436 |
+
from agent.device_driver import DeviceDriver, DeviceCredentials, DeviceType
|
| 437 |
+
|
| 438 |
+
driver = DeviceDriver()
|
| 439 |
+
|
| 440 |
+
# Connect
|
| 441 |
+
creds = DeviceCredentials(
|
| 442 |
+
hostname='192.168.1.10',
|
| 443 |
+
username='admin',
|
| 444 |
+
password='admin',
|
| 445 |
+
device_type=DeviceType.CISCO_IOS
|
| 446 |
+
)
|
| 447 |
+
|
| 448 |
+
conn = driver.connect(creds)
|
| 449 |
+
|
| 450 |
+
# Get current config
|
| 451 |
+
backup = driver.get_config('192.168.1.10', 'running')
|
| 452 |
+
|
| 453 |
+
# ... something goes wrong ...
|
| 454 |
+
|
| 455 |
+
# Rollback
|
| 456 |
+
driver.rollback_config('192.168.1.10', backup)
|
| 457 |
+
```
|
| 458 |
+
|
| 459 |
+
## Multi-Vendor Support
|
| 460 |
+
|
| 461 |
+
### Cisco IOS/IOS-XE
|
| 462 |
+
|
| 463 |
+
```python
|
| 464 |
+
from agent.device_driver import DeviceType
|
| 465 |
+
|
| 466 |
+
# Cisco Catalyst, ISR, ASR
|
| 467 |
+
device_type = DeviceType.CISCO_IOS # or CISCO_XE
|
| 468 |
+
```
|
| 469 |
+
|
| 470 |
+
**Supported Features:**
|
| 471 |
+
- Config merge and replace
|
| 472 |
+
- Running/startup config backup
|
| 473 |
+
- Auto-save on Cisco IOS
|
| 474 |
+
|
| 475 |
+
### Cisco NXOS (Nexus)
|
| 476 |
+
|
| 477 |
+
```python
|
| 478 |
+
device_type = DeviceType.CISCO_NXOS
|
| 479 |
+
```
|
| 480 |
+
|
| 481 |
+
**Features:**
|
| 482 |
+
- Checkpoint/rollback support
|
| 483 |
+
- Config replace via NAPALM
|
| 484 |
+
|
| 485 |
+
### Arista EOS
|
| 486 |
+
|
| 487 |
+
```python
|
| 488 |
+
device_type = DeviceType.ARISTA_EOS
|
| 489 |
+
```
|
| 490 |
+
|
| 491 |
+
**Features:**
|
| 492 |
+
- Config sessions
|
| 493 |
+
- Atomic commits
|
| 494 |
+
- Fast boot times
|
| 495 |
+
|
| 496 |
+
### Juniper JunOS
|
| 497 |
+
|
| 498 |
+
```python
|
| 499 |
+
device_type = DeviceType.JUNIPER_JUNOS
|
| 500 |
+
```
|
| 501 |
+
|
| 502 |
+
**Features:**
|
| 503 |
+
- Candidate config
|
| 504 |
+
- Commit confirmed
|
| 505 |
+
- Rollback points
|
| 506 |
+
|
| 507 |
+
## Testing Without Devices (Mock Mode)
|
| 508 |
+
|
| 509 |
+
All components support mock mode for development/testing:
|
| 510 |
+
|
| 511 |
+
```python
|
| 512 |
+
from agent.device_driver import DeviceDriver
|
| 513 |
+
|
| 514 |
+
# Initialize in mock mode (auto-detected if Netmiko/NAPALM not installed)
|
| 515 |
+
driver = DeviceDriver()
|
| 516 |
+
|
| 517 |
+
print(f"Mock mode: {driver.mock_mode}") # True if no libraries
|
| 518 |
+
|
| 519 |
+
# Mock connections always succeed
|
| 520 |
+
conn = driver.connect(credentials)
|
| 521 |
+
print(f"Connected: {conn.status}") # CONNECTED
|
| 522 |
+
|
| 523 |
+
# Mock deployments simulate success
|
| 524 |
+
result = driver.deploy_config('device-1', config)
|
| 525 |
+
print(f"Deployed: {result.success}") # True
|
| 526 |
+
```
|
| 527 |
+
|
| 528 |
+
## Deployment History & Metrics
|
| 529 |
+
|
| 530 |
+
```python
|
| 531 |
+
from agent.deployment_engine import DeploymentEngine
|
| 532 |
+
|
| 533 |
+
deployer = DeploymentEngine()
|
| 534 |
+
|
| 535 |
+
# ... deploy devices ...
|
| 536 |
+
|
| 537 |
+
# Get summary
|
| 538 |
+
summary = deployer.get_deployment_summary()
|
| 539 |
+
|
| 540 |
+
print(f"Total deployments: {summary['total_deployments']}")
|
| 541 |
+
print(f"Success rate: {summary['success_rate']:.1f}%")
|
| 542 |
+
print(f"Average duration: {summary['avg_duration']:.1f}s")
|
| 543 |
+
|
| 544 |
+
# Recent deployments
|
| 545 |
+
for dep in summary['latest_deployments']:
|
| 546 |
+
print(f"{dep['device_id']}: {dep['status']} ({dep['duration']:.1f}s)")
|
| 547 |
+
```
|
| 548 |
+
|
| 549 |
+
## Troubleshooting
|
| 550 |
+
|
| 551 |
+
### Connection Failures
|
| 552 |
+
|
| 553 |
+
**Symptom:** `Failed to connect: timeout`
|
| 554 |
+
|
| 555 |
+
**Solutions:**
|
| 556 |
+
```python
|
| 557 |
+
# Increase timeout
|
| 558 |
+
credentials = DeviceCredentials(
|
| 559 |
+
hostname='192.168.1.10',
|
| 560 |
+
username='admin',
|
| 561 |
+
password='admin',
|
| 562 |
+
device_type=DeviceType.CISCO_IOS,
|
| 563 |
+
timeout=60 # Increase from default 30s
|
| 564 |
+
)
|
| 565 |
+
|
| 566 |
+
# Check network connectivity
|
| 567 |
+
driver.verify_connectivity('device-id')
|
| 568 |
+
|
| 569 |
+
# Enable session logging for debugging
|
| 570 |
+
credentials.session_log = '/tmp/device-session.log'
|
| 571 |
+
```
|
| 572 |
+
|
| 573 |
+
### Authentication Failures
|
| 574 |
+
|
| 575 |
+
**Symptom:** `Failed to connect: authentication failed`
|
| 576 |
+
|
| 577 |
+
**Solutions:**
|
| 578 |
+
```python
|
| 579 |
+
# For devices requiring enable password
|
| 580 |
+
credentials = DeviceCredentials(
|
| 581 |
+
hostname='192.168.1.10',
|
| 582 |
+
username='admin',
|
| 583 |
+
password='admin',
|
| 584 |
+
secret='enable_password', # Enable secret
|
| 585 |
+
device_type=DeviceType.CISCO_IOS
|
| 586 |
+
)
|
| 587 |
+
```
|
| 588 |
+
|
| 589 |
+
### Config Deployment Failures
|
| 590 |
+
|
| 591 |
+
**Symptom:** `Deployment failed: command error`
|
| 592 |
+
|
| 593 |
+
**Solutions:**
|
| 594 |
+
```python
|
| 595 |
+
# Use dry-run to validate first
|
| 596 |
+
result = deployer.deploy_config(
|
| 597 |
+
device_id='device-1',
|
| 598 |
+
config=config,
|
| 599 |
+
dry_run=True # Test without applying
|
| 600 |
+
)
|
| 601 |
+
|
| 602 |
+
print(f"Would work: {result.success}")
|
| 603 |
+
|
| 604 |
+
# Check diff before deploying
|
| 605 |
+
if result.output:
|
| 606 |
+
print(f"Changes:\n{result.output}")
|
| 607 |
+
```
|
| 608 |
+
|
| 609 |
+
### Post-Check Failures
|
| 610 |
+
|
| 611 |
+
**Symptom:** `Post-deployment check failed: ping:8.8.8.8`
|
| 612 |
+
|
| 613 |
+
**Solutions:**
|
| 614 |
+
```python
|
| 615 |
+
# Add delay before post-checks
|
| 616 |
+
import time
|
| 617 |
+
time.sleep(5) # Wait for config to take effect
|
| 618 |
+
|
| 619 |
+
# Use more specific checks
|
| 620 |
+
post_checks=[
|
| 621 |
+
'command:show ip interface brief', # More specific than ping
|
| 622 |
+
'interface:GigabitEthernet0/1'
|
| 623 |
+
]
|
| 624 |
+
|
| 625 |
+
# Disable rollback for troubleshooting
|
| 626 |
+
# (manually verify and fix)
|
| 627 |
+
```
|
| 628 |
+
|
| 629 |
+
## Production Best Practices
|
| 630 |
+
|
| 631 |
+
### 1. Always Use Dry-Run First
|
| 632 |
+
|
| 633 |
+
```python
|
| 634 |
+
# Test deployment
|
| 635 |
+
dry_result = pipeline.stage6_autonomous_deploy(model, dry_run=True)
|
| 636 |
+
|
| 637 |
+
# Review results
|
| 638 |
+
if dry_result['success_rate'] == 100.0:
|
| 639 |
+
# Now deploy for real
|
| 640 |
+
real_result = pipeline.stage6_autonomous_deploy(model, dry_run=False)
|
| 641 |
+
```
|
| 642 |
+
|
| 643 |
+
### 2. Use Pre-Flight Validation
|
| 644 |
+
|
| 645 |
+
```python
|
| 646 |
+
# Run Stage 0 validation before deployment
|
| 647 |
+
preflight = pipeline.stage0_preflight(model)
|
| 648 |
+
|
| 649 |
+
if not preflight['ready_to_deploy']:
|
| 650 |
+
print("Pre-flight failed - aborting")
|
| 651 |
+
print(f"Errors: {preflight['errors']}")
|
| 652 |
+
exit(1)
|
| 653 |
+
|
| 654 |
+
# Deploy only after validation passes
|
| 655 |
+
pipeline.stage6_autonomous_deploy(model)
|
| 656 |
+
```
|
| 657 |
+
|
| 658 |
+
### 3. Implement Change Windows
|
| 659 |
+
|
| 660 |
+
```python
|
| 661 |
+
from datetime import datetime, time as dt_time
|
| 662 |
+
|
| 663 |
+
def in_change_window():
|
| 664 |
+
"""Check if current time is in approved change window"""
|
| 665 |
+
now = datetime.now()
|
| 666 |
+
# Only deploy between 2 AM - 4 AM
|
| 667 |
+
return dt_time(2, 0) <= now.time() <= dt_time(4, 0)
|
| 668 |
+
|
| 669 |
+
if not in_change_window():
|
| 670 |
+
print("Outside change window - aborting")
|
| 671 |
+
exit(1)
|
| 672 |
+
|
| 673 |
+
# Deploy during approved window
|
| 674 |
+
pipeline.stage6_autonomous_deploy(model)
|
| 675 |
+
```
|
| 676 |
+
|
| 677 |
+
### 4. Use Parallel Deployment Carefully
|
| 678 |
+
|
| 679 |
+
```python
|
| 680 |
+
# Start with small batch
|
| 681 |
+
results = pipeline.parallel_deploy_fleet(
|
| 682 |
+
model=model,
|
| 683 |
+
staggered=True,
|
| 684 |
+
stages=[0.01, 0.05, 0.1, 1.0] # 1%, 5%, 10%, 100%
|
| 685 |
+
)
|
| 686 |
+
|
| 687 |
+
# Circuit breaker stops on high failure rate
|
| 688 |
+
```
|
| 689 |
+
|
| 690 |
+
### 5. Maintain Deployment Audit Trail
|
| 691 |
+
|
| 692 |
+
```python
|
| 693 |
+
deployer = DeploymentEngine()
|
| 694 |
+
|
| 695 |
+
# Deploy
|
| 696 |
+
result = deployer.deploy_single_device(task)
|
| 697 |
+
|
| 698 |
+
# Log to external system
|
| 699 |
+
import json
|
| 700 |
+
with open(f'/var/log/deployments/{result.device_id}.json', 'w') as f:
|
| 701 |
+
json.dump({
|
| 702 |
+
'device_id': result.device_id,
|
| 703 |
+
'status': result.status.value,
|
| 704 |
+
'timestamp': result.timestamp.isoformat(),
|
| 705 |
+
'config_before': result.config_before,
|
| 706 |
+
'config_after': result.config_after,
|
| 707 |
+
'deployed_by': os.environ.get('USER'),
|
| 708 |
+
'duration': result.duration_seconds
|
| 709 |
+
}, f, indent=2)
|
| 710 |
+
```
|
| 711 |
+
|
| 712 |
+
## Next Steps
|
| 713 |
+
|
| 714 |
+
- ✅ Multi-vendor device support
|
| 715 |
+
- ✅ Config templating
|
| 716 |
+
- ✅ Pre/post validation
|
| 717 |
+
- ✅ Automatic rollback
|
| 718 |
+
- 🚧 Full Ray parallel deployment integration
|
| 719 |
+
- 🚧 Advanced validation (pyATS test cases)
|
| 720 |
+
- 🚧 Change request workflow
|
| 721 |
+
- 🚧 Approval gates for production
|
| 722 |
+
|
| 723 |
+
**You're now ready to deploy to real network devices!** 🚀
|