Example15.ps1

#    ** This example demonstrates how to use the Add-NodeSpacer cmdlet to add spacer nodes that assist with diagram alignment. (part of AsBuiltReport.Diagram) **

<#
    This example demonstrates how to create a 3-tier web application diagram using the AsBuiltReport.Diagram.
#>

[CmdletBinding()]
param (
    [System.IO.FileInfo] $Path = '~\Desktop\',
    [array] $Format = @('png'),
    [bool] $DraftMode = $false
)

<#
    Starting with PowerShell v3, modules do not need to be explicitly imported.
    It is included here for clarity.
#>

# Import-Module AsBuiltReport.Diagram -Force -Verbose:$false

<#
    The diagram output is a file, so we need to specify the output folder path. In this example, $OutputFolderPath is used.
#>

$OutputFolderPath = Resolve-Path -Path $Path

<#
    If the diagram uses custom icons, specify the path to the icons directory. This is a Graphviz requirement.
#>

$RootPath = $PSScriptRoot
[System.IO.FileInfo]$IconPath = Join-Path -Path $RootPath -ChildPath 'Icons'

<#
    The $Images variable is a hashtable containing the names of image files used in the diagram.
    The image files must be located in the directory specified by $IconPath.
    ** Image sizes should be around 100x100, 150x150 pixels for optimal display. **
#>

$script:Images = @{
    'Main_Logo' = 'AsBuiltReport.png'
    'Server' = 'Server.png'
    'ServerRedhat' = 'Linux_Server_RedHat.png'
    'ServerUbuntu' = 'Linux_Server_Ubuntu.png'
    'Cloud' = 'Cloud.png'
    'Router' = 'Router.png'
    'Logo_Footer' = 'Signature_Logo.png'
}

<#
    The $MainGraphLabel variable sets the main title of the diagram.
#>

$MainGraphLabel = 'Web Application Diagram'

<#
    This section creates custom objects to hold server information, which are used to set node labels in the diagram.
#>

$AppServerInfo = [PSCustomObject][ordered]@{
    'OS' = 'Windows Server'
    'Version' = '2019'
    'Build' = '17763.3163'
    'Edition' = 'Datacenter'
}

$DBServerInfo = [PSCustomObject][ordered]@{
    'OS' = 'Oracle Server'
    'Version' = '8'
    'Build' = '8.2'
    'Edition' = 'Enterprise'
}

$example15 = & {
    <#
        A SubGraph allows you to group objects in a container, creating a graph within a graph.
        SubGraph, Node, and Edge have attributes for setting background color, label, border color, style, etc.
        (SubGraph is a reserved word in the PSGraph module)
        https://psgraph.readthedocs.io/en/latest/Command-SubGraph/
    #>

    SubGraph 3tier -Attributes @{Label = '3 Tier Concept'; fontsize = 22; penwidth = 1.5; labelloc = 't'; style = 'dashed,rounded'; color = 'darkgray' } {

        <#
            The Add-HtmlSignatureTable cmdlet creates a signature table to be used as a footer in the diagram.
            It can include images, author name, company name, and other details.
            (Part of AsBuiltReport.Diagram module)
        #>

        $Signature = Add-HtmlSignatureTable -ImagesObj $Images -Rows 'Author: Bugs Bunny', 'Company: ACME Inc.' -TableBorder 2 -CellBorder 0 -Align 'left' -Logo 'Logo_Footer' -DraftMode:$DraftMode -FontBold

        <#
            The Signature SubGraph contains the $Signature table created above.
            It is styled to be invisible and positioned at the bottom of the diagram.

            The SubGraph attributes set the label, font size, pen width, label location, label justification, style, and color.
            (Part of Graphviz attributes)
        #>

        SubGraph Signature -Attributes @{Label = $Signature; fontsize = 22; penwidth = 1.5; labelloc = 'b'; labeljust = 'right'; style = 'invis'; color = 'darkgray' } {

            <#
                The $WebServerFarm variable is an array of hashtables, each representing a web server node with its properties.
                Each hashtable contains:
                - Name: The name of the web server.
                - AdditionalInfo: A custom object with properties to display in the node label.
                - IconType: The type of icon to use for the node (must match a key in the $Images hashtable).
            #>

            $WebServerFarm = @(
                @{
                    Name = 'Web-Server-01';
                    AdditionalInfo = [PSCustomObject][ordered]@{
                        'OS' = 'Redhat Linux'
                        'Version' = '10'
                        'Build' = '10.1'
                        'Edition' = 'Enterprise'
                    }
                    IconType = 'ServerRedhat'
                },
                @{
                    Name = 'Web-Server-02';
                    AdditionalInfo = [PSCustomObject][ordered]@{
                        'OS' = 'Redhat Linux'
                        'Version' = '10'
                        'Build' = '10.1'
                        'Edition' = 'Enterprise'
                    }
                    IconType = 'ServerRedhat'
                },
                @{
                    Name = 'Web-Server-03';
                    AdditionalInfo = [PSCustomObject][ordered]@{
                        'OS' = 'Ubuntu Linux'
                        'Version' = '24'
                        'Build' = '11'
                        'Edition' = 'Enterprise'
                    }
                    IconType = 'ServerUbuntu'
                }
            )

            <#
                This time, we will simulate a Web Server Farm with multiple web server node. While the Add-NodeIcon cmdlet is typically used to add icons/properties to nodes, it lack the ability to create multiple nodes with distinct properties.

                Add-HtmlNodeTable has the capability to create a table layout for the nodes simulting a web server farm. It also allows the addition of icons and properties to each node in the table.

                ** The $Images object and IconType "Server" must be defined earlier in the script **
            #>

            Add-HtmlNodeTable -Name 'Web-Server-Farm' -ImagesObj $Images -inputObject $WebServerFarm.Name -iconType $WebServerFarm.IconType -ColumnSize 3 -AditionalInfo $WebServerFarm.AdditionalInfo -Subgraph -SubgraphLabel 'Web Server Farm' -SubgraphLabelPos 'top' -SubgraphTableStyle 'dashed,rounded' -TableBorderColor 'gray' -TableBorder '1' -SubgraphLabelFontSize 20 -FontSize 18 -DraftMode:$DraftMode -FontBold -SubgraphFontBold -NodeObject -MultiIcon


            Add-NodeIcon -Name 'App-Server-01' -AditionalInfo $AppServerInfo -ImagesObj $Images -IconType 'Server' -Align 'Center' -FontSize 18 -DraftMode:$DraftMode -NodeObject
            Add-NodeIcon -Name 'Db-Server-01' -AditionalInfo $DBServerInfo -ImagesObj $Images -IconType 'Server' -Align 'Center' -FontSize 18 -DraftMode:$DraftMode -NodeObject

            <#
                This section creates connections between the nodes in a hierarchical layout.
                The Add-NodeEdge cmdlet creates connections between the nodes. (Part of AsBuiltReport.Diagram module)
                https://github.com/AsBuiltReport/AsBuiltReport.Diagram
            #>

            Add-NodeEdge -From 'Web-Server-Farm' -To 'App-Server-01' -EdgeLabel 'gRPC' -EdgeLabelFontSize 14 -EdgeLabelFontColor 'black' -EdgeLength 3 -EdgeColor 'Black' -EdgeThickness 3 -EdgeStyle 'dashed'
            Add-NodeEdge -From 'App-Server-01' -To 'Db-Server-01' -EdgeLabel 'SQL' -EdgeColor 'black' -EdgeLabelFontSize 14 -EdgeLabelFontColor 'black' -EdgeLength 3 -EdgeThickness 3 -EdgeStyle 'dashed'

            <#
                The Rank cmdlet is used to place nodes at the same hierarchical level.
                In this example, App-Server-01 and Db-Server-01 are aligned horizontally.
            #>
            Rank -Nodes 'App-Server-01', 'Db-Server-01'

            <#
                In this section, we add a network router and a cloud icon to represent internet connectivity.
            #>

            $RouterInfo = [PSCustomObject][ordered]@{
                'OS' = 'Cisco IOS'
                'Version' = '15.2'
            }

            Add-NodeIcon -Name 'Core-Router' -AdditionalInfo $RouterInfo -ImagesObj $Images -IconType 'Router' -Align 'Center' -FontSize 18 -DraftMode:$DraftMode -NodeObject

            Add-NodeEdge -From 'Core-Router' -To 'Web-Server-Farm' -EdgeLabel 'GE0/0' -EdgeLabelFontSize 18 -EdgeLabelFontColor 'black' -EdgeLength 2 -EdgeColor 'Black' -EdgeThickness 3 -EdgeStyle 'dashed'

            <#
                This section demonstrates the use of the Add-NodeImage to add a custom image to the diagram (Part of AsBuiltReport.Diagram module).

                -Name parameter sets the name of the node (WAN in this case).
                -ImageSizePercent parameter sets the size of the image as a percentage (30% in this case).
            #>

            Add-NodeImage -Name 'WAN' -ImagesObj $Images -IconType 'Cloud' -IconPath $IconPath -ImageSizePercent 30 -NodeObject -DraftMode:$DraftMode

            <#
                The Add-HtmlTable cmdlet is used to create a list table to display additional information about a object.

                In this example, we create a table to display the router's network interface information.
            #>

            $RouterNetworkInfo = @(
                'S0/0:'
                '164.42.203.10/30'
                'G0/0:'
                '192.168.5.10/24'
            )

            Add-HtmlTable -Name 'RouterNetworkInfo' -Rows $RouterNetworkInfo -NodeObject -ColumnSize 2 -TableBorder 1 -TableBorderColor 'black' -FontSize 14 -Subgraph -SubgraphLabel 'Interfaces Table' -SubgraphLabelPos 'top' -SubgraphTableStyle 'solid,rounded' -SubgraphLabelFontsize 20 -SubgraphFontUnderline -SubgraphFontBold -DraftMode:$DraftMode -TableBackgroundColor 'lightblue'

            Add-NodeEdge -From 'Core-Router' -To 'RouterNetworkInfo' -EdgeColor 'black' -EdgeLabelFontSize 18 -EdgeLabelFontColor 'black' -EdgeLength 1 -Arrowhead 'none' -Arrowtail 'none' -GraphvizAttributes @{style = 'filled' } -EdgeThickness 3 -EdgeStyle 'dashed'

            Rank 'Core-Router', 'RouterNetworkInfo'

            <#
                The Add-NodeShape cmdlet is used to create a node with a specific shape and various customizable attributes (Part of AsBuiltReport.Diagram module). Supported Shapes: https://graphviz.org/doc/info/shapes.html

                ** In this example, we create a rectangle to simulate a firewall presence in the network. **
            #>

            Add-NodeShape -Name 'Firewall' -Shape rectangle -ShapeStyle 'filled' -ShapeFillColor 'red:white' -ShapeFontSize 14 -ShapeFontColor 'black' -ShapeFontName 'Arial' -ShapeWidth 3 -ShapeLabelPosition center -ShapeLineColor 'black' -DraftMode:$DraftMode

            Add-NodeEdge -From 'WAN' -To 'Firewall' -HeadLabel 'port1'  -EdgeLabelFontSize 18 -EdgeLabelFontColor 'black' -EdgeLength 2 -Arrowhead 'normal' -Arrowtail 'normal' -LabelDistance 5 -EdgeColor 'Black' -EdgeThickness 3 -EdgeStyle 'dashed'
            Add-NodeEdge -From 'Firewall' -To 'Core-Router' -HeadLabel 'Serial0/0' -TailLabel 'port2' -EdgeColor 'black' -EdgeLabelFontSize 18 -EdgeLabelFontColor 'black' -EdgeLength 2 -Arrowhead 'normal' -Arrowtail 'normal' -LabelDistance 4 -EdgeThickness 3 -EdgeStyle 'dashed'


            <#
                The Add-NodeSpacer cmdlet is used to create invisible spacer nodes that help with diagram alignment (Part of AsBuiltReport.Diagram module).

                In this diagram there is a alignment issue with the Web01 node, as it is not centered with the App01 and DB01 nodes below it. To fix this,
                we create two spacer nodes (FillerRight and FillerLeft) on either side of the Web01 node.

                -Name parameter sets the name of the spacer node.
                -ShapeWidth parameter sets the width of the spacer node.
                -ShapeHeight parameter sets the height of the spacer node.
                -ShapeOrientation parameter sets the orientation of the spacer node (0 for horizontal, 1 for vertical).
                -DraftMode parameter specifies whether the node is in draft mode.

                The rank command is used to align the spacer nodes and the web server node horizontally.
                The edge commands create invisible edges between the spacer nodes and the web server node to maintain alignment.

                ** In this example, we create two spacer nodes to help align the web server node. **
            #>

            Add-NodeSpacer -Name 'SpaceRight' -ShapeWidth 2 -ShapeHeight 1 -ShapeOrientation 0 -DraftMode:$DraftMode
            Add-NodeSpacer -Name 'SpaceLeft' -ShapeWidth 2 -ShapeHeight 1 -ShapeOrientation 0 -DraftMode:$DraftMode

            Rank -Nodes SpaceLeft, 'Web-Server-Farm', SpaceRight

            $Style = if ($DraftMode) { 'filled' } else { 'invis' }
            $StyleColor = if ($DraftMode) { 'red' } else { 'transparent' }

            Add-NodeEdge -From SpaceLeft -To 'Web-Server-Farm' -EdgeLength 2 -EdgeColor $StyleColor -GraphvizAttributes @{style = $Style }
            Add-NodeEdge -From 'Web-Server-Farm' -To SpaceRight -EdgeLength 2 -EdgeColor $StyleColor -GraphvizAttributes @{style = $Style }
        }
    }
}
<#
    This command generates the diagram using the New-AbrDiagram cmdlet (part of AsBuiltReport.Diagram).
#>

New-AbrDiagram -InputObject $example15 -OutputFolderPath $OutputFolderPath -Format $Format -MainDiagramLabel $MainGraphLabel -Filename Example15 -LogoName 'Main_Logo' -Direction top-to-bottom -IconPath $IconPath -ImagesObj $Images -DraftMode:$DraftMode