Substation Module Catalog¶

Introduction¶

The Substation project uses a modular architecture where each OpenStack service is encapsulated in a dedicated module. These modules provide comprehensive management capabilities through a consistent interface, enabling users to interact with various OpenStack services through a unified terminal UI.

Each module implements the OpenStackModule protocol and provides:

• Service-specific views and forms
• Data fetching and caching through DataProvider interfaces
• Batch operations for multi-resource management
• Input handling for keyboard navigation and actions
• Health monitoring and performance metrics

Module Overview¶

Substation provides 14 specialized modules for managing OpenStack resources:

Module Metadata¶

Module Dependencies¶

Dependency Diagram¶

graph TD
    subgraph "Phase 1 - Independent Modules"
        Images[Images]
        Flavors[Flavors]
        KeyPairs[KeyPairs]
        SecurityGroups[Security Groups]
        ServerGroups[Server Groups]
        Barbican[Barbican]
        Swift[Swift]
    end

    subgraph "Phase 2 - Network Foundation"
        Networks[Networks]
        Subnets[Subnets]
        Routers[Routers]
        Ports[Ports]
        FloatingIPs[Floating IPs]

        Subnets --> Networks
        Routers --> Networks
        Ports --> Networks
        Ports --> Subnets
        FloatingIPs --> Networks
        FloatingIPs --> Ports
    end

    subgraph "Phase 3 - Multi-Dependency Modules"
        Servers[Servers]
        Volumes[Volumes]

        Servers --> Networks
        Servers --> Images
        Servers --> Flavors
        Servers --> KeyPairs
        Servers --> SecurityGroups
        Servers --> ServerGroups
        Servers --> Volumes
        Volumes --> Servers
    end

Initialization Order¶

1. Phase 1 - Independent Modules: Can be initialized in any order

2. Images, Flavors, KeyPairs, SecurityGroups, ServerGroups, Barbican, Swift

3. Phase 2 - Network Dependencies: Must initialize Networks first

4. Networks -> Subnets, Routers, Ports -> FloatingIPs

5. Phase 3 - Multi-Dependencies: Require multiple services

6. Volumes (can attach to Servers)
7. Servers (depends on most other services)

Module Capabilities Matrix¶

Module Catalog¶

Servers Module¶

Location: /Sources/Substation/Modules/Servers/ Service: OpenStack Nova (Compute) Identifier: servers

Purpose: Provides comprehensive server (instance) management capabilities, serving as the most complex module with extensive service integrations.

Key Features:

• Server lifecycle management (create, start, stop, reboot, delete)
• Console access with browser integration (noVNC and other protocols)
• Server resize operations with confirmation/revert workflow
• Snapshot creation and management
• Network interface management
• Volume attachment and detachment
• Security group assignment
• Metadata and user data support
• Availability zone selection
• Server group integration for anti-affinity policies

Views:

• .servers - Primary list view with status indicators
• .serverDetail - Detailed server attributes
• .serverCreate - Multi-step creation form
• .serverConsole - Console access view
• .serverResize - Resize management with confirmation
• .serverSnapshotManagement - Snapshot operations
• .serverSecurityGroups - Security group management
• .serverNetworkInterfaces - Network interface configuration

DataProvider: ServersDataProvider - Handles server data fetching with performance optimization

Networks Module¶

Location: /Sources/Substation/Modules/Networks/ Service: OpenStack Neutron Identifier: networks

Purpose: Foundational networking module providing virtual network infrastructure management.

Key Features:

• Provider network attributes (VLAN, VXLAN, Flat, GRE, Geneve)
• Multi-segment network support
• MTU configuration and validation
• Port security management
• External network identification
• Shared network visibility
• QoS policy integration
• Availability zone awareness

Views:

• .networks - Network list with filtering
• .networkDetail - Detailed network inspection
• .networkCreate - Network creation form
• .networkServerAttachment - Server attachment management
• .networkServerManagement - Server network configuration

DataProvider: NetworksDataProvider - Optimized network data fetching

Subnets Module¶

Location: /Sources/Substation/Modules/Subnets/ Service: OpenStack Neutron Identifier: subnets

Purpose: Manages IP address allocation pools and subnet configurations within networks.

Key Features:

• CIDR management and validation
• DHCP configuration
• DNS nameserver configuration
• Host route management
• IP allocation pool configuration
• Gateway IP management
• IPv4/IPv6 dual-stack support

Views:

• .subnets - Subnet list view
• .subnetDetail - Detailed subnet information
• .subnetCreate - Subnet creation form
• .subnetRouterManagement - Router attachment management

DataProvider: SubnetsDataProvider - Subnet data management

Routers Module¶

Location: /Sources/Substation/Modules/Routers/ Service: OpenStack Neutron Identifier: routers

Purpose: Provides virtual router management for inter-network routing and external connectivity.

Key Features:

• External gateway configuration
• Internal interface management
• Static route configuration
• High availability support
• Distributed routing configuration
• Floating IP association

Views:

• .routers - Router list view
• .routerDetail - Router detail inspection
• .routerCreate - Router creation form

DataProvider: RoutersDataProvider - Router data fetching and caching

Ports Module¶

Location: /Sources/Substation/Modules/Ports/ Service: OpenStack Neutron Identifier: ports

Purpose: Manages virtual network ports for compute and network connectivity.

Key Features:

• Port security configuration
• Allowed address pairs management
• QoS policy assignment
• Fixed IP configuration
• MAC address management
• Port binding configuration
• VNIC type selection

Views:

• .ports - Port list view
• .portDetail - Detailed port information
• .portCreate - Port creation form
• .allowedAddressPairManagement - Address pair configuration

DataProvider: PortsDataProvider - Port data management with filtering

FloatingIPs Module¶

Location: /Sources/Substation/Modules/FloatingIPs/ Service: OpenStack Neutron Identifier: floatingips

Purpose: Manages public IP addresses for external connectivity to instances.

Key Features:

• Floating IP allocation from external networks
• Port association and disassociation
• Server attachment management
• DNS integration support
• QoS bandwidth limiting

Views:

• .floatingIPs - Floating IP list
• .floatingIPDetail - Detailed floating IP view
• .floatingIPCreate - Allocation form
• .floatingIPServerManagement - Server association
• .floatingIPPortManagement - Port association

DataProvider: FloatingIPsDataProvider - Floating IP data fetching

SecurityGroups Module¶

Location: /Sources/Substation/Modules/SecurityGroups/ Service: OpenStack Neutron Identifier: securitygroups

Purpose: Provides firewall rule management through security groups and rules.

Key Features:

• Ingress/egress rule management
• Protocol and port range configuration
• ICMP type/code support
• Remote security group references
• CIDR-based access control
• Default security group management
• Rule priority configuration

Views:

• .securityGroups - Security group list
• .securityGroupDetail - Rule inspection
• .securityGroupCreate - Group creation
• .securityGroupServerAttachment - Server assignment
• .securityGroupServerManagement - Server security management

DataProvider: SecurityGroupsDataProvider - Security group and rule data

Images Module¶

Location: /Sources/Substation/Modules/Images/ Service: OpenStack Glance Identifier: images

Purpose: Manages virtual machine images and snapshots.

Key Features:

• Image listing with metadata
• Image visibility management
• Protected image handling
• Image property inspection
• Format and container format display
• Minimum requirements validation

Views:

• .images - Image catalog
• .imageDetail - Image properties and metadata
• .imageSelection - Image picker for server creation

DataProvider: ImagesDataProvider - Image catalog fetching

Flavors Module¶

Location: /Sources/Substation/Modules/Flavors/ Service: OpenStack Nova Identifier: flavors

Purpose: Manages compute flavors defining virtual hardware profiles.

Key Features:

• Flavor specification display (vCPUs, RAM, disk)
• Extra specs inspection
• Public/private flavor visibility
• Flavor access management
• Performance tier categorization

Views:

• .flavors - Flavor list
• .flavorDetail - Detailed specifications
• .flavorSelection - Flavor picker for server operations

DataProvider: FlavorsDataProvider - Flavor data management

KeyPairs Module¶

Location: /Sources/Substation/Modules/KeyPairs/ Service: OpenStack Nova Identifier: keypairs

Purpose: Manages SSH key pairs for secure instance access.

Key Features:

• Key pair generation
• Public key import
• Key fingerprint display
• Key type support (ssh, x509)
• Private key download (on creation)

Views:

• .keyPairs - Key pair list
• .keyPairDetail - Key information
• .keyPairCreate - Key generation/import form

DataProvider: KeyPairsDataProvider - Key pair data fetching

ServerGroups Module¶

Location: /Sources/Substation/Modules/ServerGroups/ Service: OpenStack Nova Identifier: servergroups

Purpose: Manages server groups for scheduling policies like anti-affinity.

Key Features:

• Anti-affinity policy configuration
• Affinity policy support
• Soft anti-affinity rules
• Server membership management
• Policy metadata configuration

Views:

• .serverGroups - Server group list
• .serverGroupDetail - Group members and policy
• .serverGroupCreate - Group creation form
• .serverGroupManagement - Member management

DataProvider: ServerGroupsDataProvider - Server group data

Volumes Module¶

Location: /Sources/Substation/Modules/Volumes/ Service: OpenStack Cinder Identifier: volumes

Purpose: Provides block storage management for persistent data volumes.

Key Features:

• Volume creation and cloning
• Snapshot management
• Backup operations
• Volume attachment to servers
• Volume type selection
• Encryption support
• Multi-attach capability
• Boot volume management
• Volume transfer between projects

Views:

• .volumes - Volume list
• .volumeDetail - Volume properties
• .volumeCreate - Creation form with source options
• .volumeServerManagement - Server attachment
• .volumeSnapshotManagement - Snapshot operations
• .volumeBackupManagement - Backup configuration
• .volumeArchive - Archive operations

DataProvider: VolumesDataProvider - Volume data with attachment tracking

Swift Module¶

Location: /Sources/Substation/Modules/Swift/ Service: OpenStack Swift (Object Storage) Identifier: swift

Purpose: Comprehensive object storage management with container and object operations.

Key Features:

• Container management (create, delete, metadata)
• Object upload/download with progress tracking
• Directory structure support
• Bulk operations
• Metadata management for containers and objects
• Web access configuration
• Background operation tracking
• ETag-based differential sync
• Transfer progress monitoring

Views:

• .swift - Container/object browser
• .swiftContainerDetail - Container properties
• .swiftObjectDetail - Object metadata
• .swiftContainerCreate - Container creation
• .swiftObjectUpload - Upload interface
• .swiftObjectDownload - Download management
• .swiftDirectoryDownload - Bulk directory download
• .swiftContainerMetadata - Metadata editor
• .swiftBackgroundOperations - Transfer monitoring

DataProvider: SwiftDataProvider - Object storage data with caching

Unique Components:

• Transfer monitoring integrated within Swift module form handlers
• Storage utilities integrated within Swift module
• SwiftTreeItem - Hierarchical object representation

Barbican Module¶

Location: /Sources/Substation/Modules/Barbican/ Service: OpenStack Barbican (Key Manager) Identifier: barbican

Purpose: Cryptographic key and secret management service integration.

Key Features:

• Secret listing and browsing
• Secret detail views with cryptographic information
• Secret creation with encryption options
• Secret type management (symmetric, asymmetric, certificate)
• Payload content type configuration
• Expiration management

Views:

• .barbican - Main Barbican view
• .barbicanSecrets - Secret list
• .barbicanSecretDetail - Secret properties
• .barbicanSecretCreate - Secret creation form

DataProvider: BarbicanDataProvider - Secret data management

Quick Reference¶

Common Module Operations¶

List Resources¶

All modules provide list views with:

• Filtering by search query
• Status indicators
• Multi-select for batch operations
• Keyboard navigation (j/k or arrow keys)
• Quick actions (Enter for detail, d for delete)

View Details¶

Detail views include:

• Complete resource properties
• Related resource information
• Metadata display
• Action buttons
• Scrollable content for long details

Create Resources¶

Creation forms provide:

• Field validation
• Tab navigation between fields
• Required field indicators
• Help text for complex fields
• Dependency selection (images, networks, etc.)

Batch Operations¶

Supported batch operations:

• Multi-select with 'm' key
• Select all with 'M'
• Batch delete for most resources
• Batch status updates for some resources
• Progress tracking for operations

Module-Specific Shortcuts¶

Data Refresh Patterns¶

Modules use different refresh strategies:

• Critical Resources (Servers, Networks, Volumes): 60-second auto-refresh
• Stable Resources (Images, Flavors, KeyPairs, SecurityGroups): 5-minute cache
• Dynamic Resources (Ports, FloatingIPs, Subnets, Routers): On-demand refresh
• Swift Objects: ETag-based differential sync
• Manual Refresh: 'r' key in any list view

Performance Considerations¶

• Lazy Loading: Modules load on first access
• Resource Pooling: Views are recycled for memory efficiency
• Batch Fetching: Large datasets fetched in batches
• Virtual Scrolling: Lists handle thousands of items efficiently
• Cache Management: Smart caching with TTL and invalidation
• Background Sync: Swift module uses background sync for large containers

Module Development Guidelines¶

Creating a New Module¶

1. Implement OpenStackModule protocol
2. Define identifier, displayName, version, dependencies
3. Implement configure() for initialization
4. Register views with registerViews()
5. Optionally implement DataProvider for data management
6. Register with ModuleRegistry in configuration

Module Best Practices¶

• Keep modules focused on a single OpenStack service
• Use DataProvider for consistent data fetching
• Implement health checks for monitoring
• Support batch operations where applicable
• Provide keyboard shortcuts for common actions
• Use consistent view patterns (list/detail/create)
• Handle service unavailability gracefully
• Document all public interfaces with SwiftDoc

Testing Modules¶

• Unit test DataProvider implementations
• Integration test with mock OpenStack responses
• UI test view rendering and navigation
• Performance test with large datasets
• Test error handling and service failures
• Validate form input and submission

Infrastructure Notes¶

The Core framework provides shared infrastructure components that all modules depend on, but Core itself is not a service module. It includes:

• Base protocols and interfaces
• Common UI components
• Data management utilities
• Authentication handling
• Error handling frameworks
• Performance monitoring tools

This infrastructure layer enables the consistent behavior and interface across all 14 service modules.