update FabricDetails to use class object for consistency #526
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request refactors SDN fabric infrastructure handling by introducing a centralized SdnFabricInfrastructure class and using it as a strongly-typed parameter across certificate management functions. The changes improve code maintainability, type safety, and consistency while automating certificate distribution across SDN fabric nodes.
Changes:
- Centralized the
SdnFabricInfrastructureclass definition in the main module and updated all role modules to reference it viausing modulestatements - Replaced generic
[System.Object]parameter types with strongly-typed[SdnFabricInfrastructure]across certificate creation and rotation functions - Enhanced certificate functions to conditionally distribute generated certificates to all fabric nodes when FabricDetails is provided
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/SdnDiagnostics.psm1 | Added centralized SdnFabricInfrastructure class definition and updated parameter type in certificate rotation scriptblock |
| src/modules/SdnDiag.NetworkController.psm1 | Removed duplicate class definition, added using statement, updated parameter types, improved role validation, and added conditional certificate distribution |
| src/modules/SdnDiag.LoadBalancerMux.psm1 | Added using statement, updated parameter types, replaced feature checks with Confirm-IsLoadBalancerMux, and added conditional certificate distribution |
| src/modules/SdnDiag.Server.psm1 | Added using statement, updated parameter types and documentation, and added conditional certificate distribution |
| src/modules/SdnDiag.Common.psm1 | Added using statement and updated parameter types for certificate distribution functions |
|
|
||
| $certObject = [PSCustomObject]@{ | ||
| # distribute the certificate to the Network Controller(s) in the fabric to be installed in trusted root store | ||
| if ($FabricDetails){ |
There was a problem hiding this comment.
Missing space before opening brace. The conditional statement should be formatted as if ($FabricDetails) { to match the code style used in the other modules (SdnDiag.Server.psm1 line 2732 and SdnDiag.NetworkController.psm1 line 2549). This ensures consistent code formatting across the codebase.
| if ($FabricDetails){ | |
| if ($FabricDetails) { |
Description
This pull request refactors how SDN fabric details are handled across several modules by introducing a single
SdnFabricInfrastructureclass and using it as a strongly-typed parameter instead of a generic object. It also updates certificate creation and rotation functions to distribute generated certificates to all relevant SDN fabric nodes automatically. Additionally, the code simplifies and clarifies admin and role checks, and improves code organization by centralizing the class definition.Type and Parameter Refactoring:
SdnFabricInfrastructureclass inSdnDiagnostics.psm1and removed its duplicate definition fromSdnDiag.NetworkController.psm1. All relevant function parameters now use this class instead of[System.Object]for SDN fabric details. [1] [2] F9758a62L91R91, F9758a62L313R313, F6bf2815L475R475, [3] [4] [5] [6] [7] [8]Certificate Distribution Enhancements:
New-SdnNetworkControllerNodeCertificate,New-SdnMuxCertificate,New-SdnServerCertificate) to automatically distribute generated certificates to all nodes in the SDN fabric using the newSdnFabricInfrastructureparameter. [1] [2] [3]Improved Role and Admin Checks:
Confirm-IsNetworkController,Confirm-IsLoadBalancerMux,Confirm-IsAdmin) for clarity and reliability when verifying the correct execution context. [1] [2]Code Organization and Module Imports:
using module ..\SdnDiagnostics.psm1to all SDN role modules to ensure the shared class and logic are available everywhere. [1] [2] [3] [4]Minor Documentation and Logic Improvements:
FabricDetailsrefers to the environment info fromGet-SdnInfrastructureInfo. [1] [2] [3]These changes make the codebase more maintainable, type-safe, and ensure consistent handling of SDN fabric details and certificate distribution across all SDN roles.
Change type
Checklist: