initial commit
This commit is contained in:
Kosta Mushkin
@@ -0,0 +1,52 @@
|
||||
# Exercise 5: VPG Operations
|
||||
|
||||
## Overview
|
||||
This exercise covers the core functionality of VPG management. You'll learn how to create VPGs, manage VMs within them, and handle VPG settings.
|
||||
|
||||
## Objectives
|
||||
- Create new VPGs
|
||||
- Add VMs to VPGs
|
||||
- Remove VMs from VPGs
|
||||
- Manage VPG settings
|
||||
- Validate VPG configurations
|
||||
|
||||
## Time
|
||||
15 minutes
|
||||
|
||||
## Prerequisites
|
||||
- Completed Exercise 4
|
||||
- Working resource discovery
|
||||
- Access to VMs for protection
|
||||
|
||||
## Exercise Steps
|
||||
1. Create a new VPG
|
||||
2. Add VMs to the VPG
|
||||
3. Configure VPG settings
|
||||
4. Validate the VPG
|
||||
5. Remove VMs from VPG
|
||||
|
||||
## Working Directory
|
||||
The `working` directory contains:
|
||||
- `create_vpg.py` - Template for VPG creation
|
||||
- `manage_vms.py` - Template for VM management
|
||||
|
||||
## Solution
|
||||
The `solution` directory contains:
|
||||
- `create_vpg.py` - Complete VPG creation example
|
||||
- `manage_vms.py` - Complete VM management example
|
||||
|
||||
## Key Concepts
|
||||
- VPG creation
|
||||
- VM management
|
||||
- VPG settings
|
||||
- VPG validation
|
||||
- Resource allocation
|
||||
|
||||
## Common Issues
|
||||
- Invalid VPG settings
|
||||
- VM compatibility issues
|
||||
- Resource constraints
|
||||
- Validation failures
|
||||
|
||||
## Next Steps
|
||||
Proceed to Exercise 6: Failover Testing to learn about VPG testing.
|
||||
@@ -0,0 +1,214 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Exercise 5: VPG Operations - Solution (Part 1: VPG Creation)
|
||||
This script demonstrates how to create and configure VPGs in your Zerto environment.
|
||||
|
||||
Prerequisites:
|
||||
1. Install the zvml package in development mode:
|
||||
cd /path/to/zvml-python-sdk
|
||||
pip install -e .
|
||||
2. Update prerequisites/config.py with your ZVM details
|
||||
|
||||
This solution demonstrates:
|
||||
- Creating a new VPG with basic settings
|
||||
- Configuring journal, recovery, and network settings
|
||||
- Adding VMs to the VPG
|
||||
- Proper error handling and logging
|
||||
"""
|
||||
|
||||
import sys
|
||||
import os
|
||||
import logging
|
||||
import json
|
||||
from pathlib import Path
|
||||
|
||||
# Add prerequisites to Python path
|
||||
prerequisites_path = Path(__file__).parent.parent.parent.parent / "prerequisites"
|
||||
sys.path.append(str(prerequisites_path))
|
||||
|
||||
# Import the SDK modules
|
||||
from zvml import ZVMLClient
|
||||
|
||||
# Import configuration
|
||||
try:
|
||||
from config import (
|
||||
ZVM_HOST,
|
||||
ZVM_PORT,
|
||||
ZVM_SSL_VERIFY,
|
||||
CLIENT_ID,
|
||||
CLIENT_SECRET
|
||||
)
|
||||
except ImportError:
|
||||
print("Error: Please copy config.example.py to config.py and update with your values")
|
||||
print("Expected path:", prerequisites_path / "config.py")
|
||||
sys.exit(1)
|
||||
|
||||
def main():
|
||||
"""
|
||||
Main function to demonstrate VPG creation.
|
||||
Shows how to:
|
||||
1. Create a new VPG with basic settings
|
||||
2. Configure journal, recovery, and network settings
|
||||
3. Add VMs to the VPG
|
||||
"""
|
||||
# Set up logging with timestamp
|
||||
logging.basicConfig(
|
||||
level=logging.INFO,
|
||||
format='%(asctime)s - %(levelname)s - %(message)s'
|
||||
)
|
||||
|
||||
try:
|
||||
# Step 1: Create a ZVMLClient instance
|
||||
logging.info(f"Initializing ZVMLClient for ZVM at {ZVM_HOST}")
|
||||
client = ZVMLClient(
|
||||
zvm_address=ZVM_HOST,
|
||||
client_id=CLIENT_ID,
|
||||
client_secret=CLIENT_SECRET,
|
||||
verify_certificate=ZVM_SSL_VERIFY
|
||||
)
|
||||
|
||||
# Step 2: Identify local and peer sites
|
||||
logging.info("Retrieving list of available sites...")
|
||||
sites = client.virtualization_sites.get_virtualization_sites()
|
||||
|
||||
if not sites:
|
||||
logging.warning("No sites found!")
|
||||
sys.exit(1)
|
||||
|
||||
logging.info(f"Found {len(sites)} site(s):")
|
||||
logging.info(f'Sites Info: {json.dumps(sites, indent=4)}')
|
||||
|
||||
# Get local and peer site identifiers
|
||||
local_site = client.localsite.get_local_site()
|
||||
local_site_identifier = local_site.get('SiteIdentifier')
|
||||
logging.info(f"Local site identifier: {local_site_identifier}")
|
||||
|
||||
peer_site = next((site for site in sites if site.get('SiteIdentifier') != local_site_identifier), None)
|
||||
if not peer_site:
|
||||
logging.warning("No peer site found!")
|
||||
sys.exit(1)
|
||||
|
||||
peer_site_identifier = peer_site.get('SiteIdentifier')
|
||||
logging.info(f"Peer site identifier: {peer_site_identifier}")
|
||||
|
||||
# Step 3: Get peer site resources for VPG configuration
|
||||
logging.info("\nRetrieving peer site resources for VPG configuration...")
|
||||
|
||||
# Get peer datastores
|
||||
peer_datastores = client.virtualization_sites.get_virtualization_site_datastores(site_identifier=peer_site_identifier)
|
||||
if not peer_datastores:
|
||||
logging.warning("No datastores found in peer site!")
|
||||
sys.exit(1)
|
||||
target_datastore = peer_datastores[0] # Use first available datastore
|
||||
|
||||
# Get peer folders
|
||||
peer_folders = client.virtualization_sites.get_virtualization_site_folders(site_identifier=peer_site_identifier)
|
||||
if not peer_folders:
|
||||
logging.warning("No folders found in peer site!")
|
||||
sys.exit(1)
|
||||
target_folder = peer_folders[0] # Use first available folder
|
||||
|
||||
# Get peer networks
|
||||
peer_networks = client.virtualization_sites.get_virtualization_site_networks(site_identifier=peer_site_identifier)
|
||||
if not peer_networks:
|
||||
logging.warning("No networks found in peer site!")
|
||||
sys.exit(1)
|
||||
target_network = peer_networks[0] # Use first available network
|
||||
|
||||
# Get peer hosts
|
||||
peer_hosts = client.virtualization_sites.get_virtualization_site_hosts(site_identifier=peer_site_identifier)
|
||||
if not peer_hosts:
|
||||
logging.warning("No hosts found in peer site!")
|
||||
sys.exit(1)
|
||||
target_host = peer_hosts[0] # Use first available host
|
||||
|
||||
# Step 4: Create VPG configuration
|
||||
logging.info("\nCreating VPG configuration...")
|
||||
vpg_name = "Test-VPG-Python"
|
||||
|
||||
# Basic VPG settings
|
||||
basic = {
|
||||
"Name": vpg_name,
|
||||
"VpgType": "Remote",
|
||||
"RpoInSeconds": 300,
|
||||
"JournalHistoryInHours": 24,
|
||||
"Priority": "Medium",
|
||||
"UseWanCompression": True,
|
||||
"ProtectedSiteIdentifier": local_site_identifier,
|
||||
"RecoverySiteIdentifier": peer_site_identifier
|
||||
}
|
||||
|
||||
# Journal settings
|
||||
journal = {
|
||||
"DatastoreIdentifier": target_datastore.get('DatastoreIdentifier'),
|
||||
"Limitation": {
|
||||
"HardLimitInMB": 153600,
|
||||
"WarningThresholdInMB": 115200
|
||||
}
|
||||
}
|
||||
|
||||
# Recovery settings
|
||||
recovery = {
|
||||
"DefaultHostIdentifier": target_host.get('HostIdentifier'),
|
||||
"DefaultDatastoreIdentifier": target_datastore.get('DatastoreIdentifier'),
|
||||
"DefaultFolderIdentifier": target_folder.get('FolderIdentifier')
|
||||
}
|
||||
|
||||
# Network settings
|
||||
networks = {
|
||||
"Failover": {
|
||||
"Hypervisor": {
|
||||
"DefaultNetworkIdentifier": target_network.get('NetworkIdentifier')
|
||||
}
|
||||
},
|
||||
"FailoverTest": {
|
||||
"Hypervisor": {
|
||||
"DefaultNetworkIdentifier": target_network.get('NetworkIdentifier')
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# Step 5: Create VPG
|
||||
logging.info(f"\nCreating VPG '{vpg_name}'...")
|
||||
logging.info("VPG Settings:")
|
||||
logging.info(f"Basic: {json.dumps(basic, indent=4)}")
|
||||
logging.info(f"Journal: {json.dumps(journal, indent=4)}")
|
||||
logging.info(f"Recovery: {json.dumps(recovery, indent=4)}")
|
||||
logging.info(f"Networks: {json.dumps(networks, indent=4)}")
|
||||
|
||||
# Create VPG
|
||||
vpg_id = client.vpgs.create_vpg(basic=basic, journal=journal, recovery=recovery, networks=networks, sync=True)
|
||||
logging.info(f"VPG created successfully with ID: {vpg_id}")
|
||||
|
||||
# Step 6: Get available VMs for protection
|
||||
logging.info("\nRetrieving available VMs for protection...")
|
||||
vms = client.virtualization_sites.get_virtualization_site_vms(site_identifier=local_site_identifier)
|
||||
|
||||
if not vms:
|
||||
logging.warning("No VMs found for protection!")
|
||||
sys.exit(1)
|
||||
|
||||
# Filter out VMs that are already protected
|
||||
available_vms = [vm for vm in vms if not vm.get('IsProtected')]
|
||||
logging.info(f"Found {len(available_vms)} available VM(s) for protection")
|
||||
|
||||
# Step 7: Add VMs to VPG
|
||||
for vm in available_vms[:2]: # Add first two available VMs
|
||||
logging.info(f"\nAdding VM {vm.get('VmName')} to VPG...")
|
||||
vm_payload = {
|
||||
"VmIdentifier": vm.get('VmIdentifier'),
|
||||
"Recovery": {
|
||||
"HostIdentifier": target_host.get('HostIdentifier'),
|
||||
"DatastoreIdentifier": target_datastore.get('DatastoreIdentifier'),
|
||||
"FolderIdentifier": target_folder.get('FolderIdentifier')
|
||||
}
|
||||
}
|
||||
task_id = client.vpgs.add_vm_to_vpg(vpg_name, vm_list_payload=vm_payload)
|
||||
logging.info(f"Task ID: {task_id} to add VM {vm.get('VmName')} to VPG")
|
||||
|
||||
except Exception as e:
|
||||
logging.error(f"VPG creation failed: {str(e)}")
|
||||
sys.exit(1)
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,162 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Exercise 5: VPG Operations - Solution (Part 2: VM Management)
|
||||
This script demonstrates how to manage VMs within VPGs in your Zerto environment.
|
||||
|
||||
Prerequisites:
|
||||
1. Install the zvml package in development mode:
|
||||
cd /path/to/zvml-python-sdk
|
||||
pip install -e .
|
||||
2. Update prerequisites/config.py with your ZVM details
|
||||
3. Run create_vpg.py first to create a VPG
|
||||
|
||||
This solution demonstrates:
|
||||
- Adding VMs to existing VPGs using add_vm_to_vpg
|
||||
- Removing VMs from VPGs using remove_vm_from_vpg
|
||||
- Proper error handling and logging
|
||||
"""
|
||||
|
||||
import sys
|
||||
import os
|
||||
import logging
|
||||
import json
|
||||
from pathlib import Path
|
||||
|
||||
# Add prerequisites to Python path
|
||||
prerequisites_path = Path(__file__).parent.parent.parent.parent / "prerequisites"
|
||||
sys.path.append(str(prerequisites_path))
|
||||
|
||||
# Import the SDK modules
|
||||
from zvml import ZVMLClient
|
||||
|
||||
# Import configuration
|
||||
try:
|
||||
from config import (
|
||||
ZVM_HOST,
|
||||
ZVM_PORT,
|
||||
ZVM_SSL_VERIFY,
|
||||
CLIENT_ID,
|
||||
CLIENT_SECRET
|
||||
)
|
||||
except ImportError:
|
||||
print("Error: Please copy config.example.py to config.py and update with your values")
|
||||
print("Expected path:", prerequisites_path / "config.py")
|
||||
sys.exit(1)
|
||||
|
||||
def main():
|
||||
"""
|
||||
Main function to demonstrate VM management in VPGs.
|
||||
Shows how to:
|
||||
1. Add VMs to an existing VPG using add_vm_to_vpg
|
||||
2. Remove VMs from a VPG using remove_vm_from_vpg
|
||||
"""
|
||||
# Set up logging with timestamp
|
||||
logging.basicConfig(
|
||||
level=logging.INFO,
|
||||
format='%(asctime)s - %(levelname)s - %(message)s'
|
||||
)
|
||||
|
||||
try:
|
||||
# Step 1: Create a ZVMLClient instance
|
||||
logging.info(f"Initializing ZVMLClient for ZVM at {ZVM_HOST}")
|
||||
client = ZVMLClient(
|
||||
zvm_address=ZVM_HOST,
|
||||
client_id=CLIENT_ID,
|
||||
client_secret=CLIENT_SECRET,
|
||||
verify_certificate=ZVM_SSL_VERIFY
|
||||
)
|
||||
|
||||
# Step 2: Find the VPG we created earlier
|
||||
logging.info("\nRetrieving VPGs...")
|
||||
vpgs = client.vpgs.get_vpgs()
|
||||
|
||||
if not vpgs:
|
||||
logging.warning("No VPGs found!")
|
||||
sys.exit(1)
|
||||
|
||||
# Find our test VPG
|
||||
test_vpg = next((vpg for vpg in vpgs if vpg.get('VpgName') == "Test-VPG-Python"), None)
|
||||
if not test_vpg:
|
||||
logging.warning("Test VPG not found! Please run create_vpg.py first.")
|
||||
sys.exit(1)
|
||||
|
||||
vpg_name = test_vpg.get('VpgName')
|
||||
logging.info(f"Found VPG: {json.dumps(test_vpg, indent=4)}")
|
||||
|
||||
# Step 3: Get available VMs for adding to VPG
|
||||
logging.info("\nRetrieving available VMs...")
|
||||
vms = client.virtualization_sites.get_virtualization_site_vms(site_identifier=test_vpg.get('SourceSiteIdentifier'))
|
||||
|
||||
if not vms:
|
||||
logging.warning("No VMs found!")
|
||||
sys.exit(1)
|
||||
|
||||
# Filter out VMs that are already protected
|
||||
available_vms = [vm for vm in vms if not vm.get('IsProtected')]
|
||||
logging.info(f"Found {len(available_vms)} available VM(s)")
|
||||
|
||||
if not available_vms:
|
||||
logging.warning("No available VMs to add!")
|
||||
sys.exit(1)
|
||||
|
||||
# Step 4: Get peer site resources for VM recovery settings
|
||||
logging.info("\nRetrieving peer site resources...")
|
||||
peer_site_identifier = test_vpg.get('TargetSiteIdentifier')
|
||||
|
||||
# Get peer datastores
|
||||
peer_datastores = client.virtualization_sites.get_virtualization_site_datastores(site_identifier=peer_site_identifier)
|
||||
if not peer_datastores:
|
||||
logging.warning("No datastores found in peer site!")
|
||||
sys.exit(1)
|
||||
target_datastore = peer_datastores[0] # Use first available datastore
|
||||
|
||||
# Get peer folders
|
||||
peer_folders = client.virtualization_sites.get_virtualization_site_folders(site_identifier=peer_site_identifier)
|
||||
if not peer_folders:
|
||||
logging.warning("No folders found in peer site!")
|
||||
sys.exit(1)
|
||||
target_folder = peer_folders[0] # Use first available folder
|
||||
|
||||
# Get peer hosts
|
||||
peer_hosts = client.virtualization_sites.get_virtualization_site_hosts(site_identifier=peer_site_identifier)
|
||||
if not peer_hosts:
|
||||
logging.warning("No hosts found in peer site!")
|
||||
sys.exit(1)
|
||||
target_host = peer_hosts[0] # Use first available host
|
||||
|
||||
# Step 5: Add a new VM to the VPG
|
||||
logging.info("\nAdding a new VM to the VPG...")
|
||||
vm_to_add = available_vms[0] # Use first available VM
|
||||
|
||||
vm_payload = {
|
||||
"VmIdentifier": vm_to_add.get('VmIdentifier'),
|
||||
"Recovery": {
|
||||
"HostIdentifier": target_host.get('HostIdentifier'),
|
||||
"DatastoreIdentifier": target_datastore.get('DatastoreIdentifier'),
|
||||
"FolderIdentifier": target_folder.get('FolderIdentifier')
|
||||
}
|
||||
}
|
||||
|
||||
task_id = client.vpgs.add_vm_to_vpg(vpg_name, vm_list_payload=vm_payload)
|
||||
logging.info(f"Task ID: {task_id} to add VM {vm_to_add.get('VmName')} to VPG")
|
||||
|
||||
# Step 6: Remove a VM from the VPG
|
||||
logging.info("\nRemoving a VM from the VPG...")
|
||||
|
||||
# Get VPG VMs
|
||||
vpg_vms = client.vpgs.get_vpg_vms(vpg_name)
|
||||
if len(vpg_vms) > 1: # Keep at least one VM
|
||||
vm_to_remove = vpg_vms[-1] # Remove the last VM
|
||||
vm_identifier = vm_to_remove.get('VmIdentifier')
|
||||
|
||||
task_id = client.vpgs.remove_vm_from_vpg(vpg_name, vm_identifier)
|
||||
logging.info(f"Task ID: {task_id} to remove VM {vm_to_remove.get('VmName')} from VPG")
|
||||
else:
|
||||
logging.info("Skipping VM removal to maintain at least one VM in the VPG")
|
||||
|
||||
except Exception as e:
|
||||
logging.error(f"VM management failed: {str(e)}")
|
||||
sys.exit(1)
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,69 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Exercise 5: VPG Operations - VPG Creation
|
||||
This script demonstrates how to create and configure a VPG.
|
||||
"""
|
||||
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
# Add the parent directory to the Python path to import the SDK
|
||||
sys.path.append(str(Path(__file__).parent.parent.parent.parent))
|
||||
|
||||
# Import the SDK modules
|
||||
from zvml import ZertoClient
|
||||
from zvml.vpgs import VPG
|
||||
from zvml.common import ZertoVPGError
|
||||
|
||||
# Import configuration
|
||||
try:
|
||||
from prerequisites.config import (
|
||||
ZVM_HOST,
|
||||
ZVM_PORT,
|
||||
ZVM_SSL_VERIFY,
|
||||
KEYCLOAK_SERVER_URL,
|
||||
KEYCLOAK_REALM,
|
||||
CLIENT_ID,
|
||||
CLIENT_SECRET
|
||||
)
|
||||
except ImportError:
|
||||
print("Error: Please copy config.example.py to config.py and update with your values")
|
||||
sys.exit(1)
|
||||
|
||||
def main():
|
||||
"""
|
||||
Main function to demonstrate VPG creation.
|
||||
"""
|
||||
# Step 1: Create and authenticate ZertoClient
|
||||
# TODO: Initialize ZertoClient and authenticate
|
||||
# Hint: Reuse the authentication code from previous exercises
|
||||
|
||||
# Step 2: Get source and target sites
|
||||
# TODO: Get local site and a peer site
|
||||
# Hint: Use client.sites.get_local() and client.sites.list()
|
||||
|
||||
# Step 3: Configure VPG settings
|
||||
# TODO: Create VPG settings with required parameters
|
||||
# Required settings:
|
||||
# - VPG name
|
||||
# - Source site
|
||||
# - Target site
|
||||
# - Journal history
|
||||
# - RPO
|
||||
# - Test network
|
||||
# - Recovery network
|
||||
|
||||
# Step 4: Create the VPG
|
||||
# TODO: Create a new VPG with the configured settings
|
||||
# Hint: Use client.vpgs.create() method
|
||||
|
||||
# Step 5: Validate the VPG
|
||||
# TODO: Validate the VPG configuration
|
||||
# Hint: Use vpg.validate() method
|
||||
|
||||
# Step 6: Handle errors
|
||||
# TODO: Add error handling for VPG operations
|
||||
# Hint: Use try/except blocks for ZertoVPGError
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,70 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Exercise 5: VPG Operations - VM Management
|
||||
This script demonstrates how to manage VMs within a VPG.
|
||||
"""
|
||||
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
# Add the parent directory to the Python path to import the SDK
|
||||
sys.path.append(str(Path(__file__).parent.parent.parent.parent))
|
||||
|
||||
# Import the SDK modules
|
||||
from zvml import ZertoClient
|
||||
from zvml.vpgs import VPG
|
||||
from zvml.common import ZertoVPGError
|
||||
|
||||
# Import configuration
|
||||
try:
|
||||
from prerequisites.config import (
|
||||
ZVM_HOST,
|
||||
ZVM_PORT,
|
||||
ZVM_SSL_VERIFY,
|
||||
KEYCLOAK_SERVER_URL,
|
||||
KEYCLOAK_REALM,
|
||||
CLIENT_ID,
|
||||
CLIENT_SECRET
|
||||
)
|
||||
except ImportError:
|
||||
print("Error: Please copy config.example.py to config.py and update with your values")
|
||||
sys.exit(1)
|
||||
|
||||
def main():
|
||||
"""
|
||||
Main function to demonstrate VM management in VPGs.
|
||||
"""
|
||||
# Step 1: Create and authenticate ZertoClient
|
||||
# TODO: Initialize ZertoClient and authenticate
|
||||
# Hint: Reuse the authentication code from previous exercises
|
||||
|
||||
# Step 2: Get the VPG
|
||||
# TODO: Find and get the VPG you want to manage
|
||||
# Hint: Use client.vpgs.list() and client.vpgs.get()
|
||||
|
||||
# Step 3: List current VMs in the VPG
|
||||
# TODO: Get a list of VMs currently in the VPG
|
||||
# Hint: Use vpg.get_vms() method
|
||||
|
||||
# Step 4: Add VMs to the VPG
|
||||
# TODO: Add one or more VMs to the VPG
|
||||
# Required steps:
|
||||
# - Find eligible VMs
|
||||
# - Configure VM settings
|
||||
# - Add VMs to VPG
|
||||
# Hint: Use vpg.add_vms() method
|
||||
|
||||
# Step 5: Remove VMs from the VPG
|
||||
# TODO: Remove one or more VMs from the VPG
|
||||
# Hint: Use vpg.remove_vms() method
|
||||
|
||||
# Step 6: Validate VPG after changes
|
||||
# TODO: Validate the VPG after VM changes
|
||||
# Hint: Use vpg.validate() method
|
||||
|
||||
# Step 7: Handle errors
|
||||
# TODO: Add error handling for VM operations
|
||||
# Hint: Use try/except blocks for ZertoVPGError
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Reference in New Issue
Block a user