Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 56 additions & 56 deletions .github/workflows/Release.yml
Original file line number Diff line number Diff line change
@@ -1,61 +1,61 @@
name: Publish PowerShell Module

on:
release:
types: [published]
release:
types: [published]

jobs:
publish-to-gallery:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Set PSRepository to Trusted for PowerShell Gallery
shell: pwsh
run: |
Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
- name: Install AsBuiltReport.Core module
shell: pwsh
run: |
Install-Module -Name AsBuiltReport.Core -Repository PSGallery -Force
- name: Install NetApp.ONTAP module
shell: pwsh
run: |
Install-Module -Name NetApp.ONTAP -Repository PSGallery -Force
- name: Install AsBuiltReport.Diagram module
shell: pwsh
run: |
Install-Module -Name AsBuiltReport.Diagram -Repository PSGallery -Force
- name: Test Module Manifest
shell: pwsh
run: |
Test-ModuleManifest .\AsBuiltReport.NetApp.ONTAP.psd1
- name: Publish module to PowerShell Gallery
shell: pwsh
run: |
Publish-Module -Path ./ -NuGetApiKey ${{ secrets.PSGALLERY_API_KEY }} -Verbose
tweet:
needs: publish-to-gallery
runs-on: ubuntu-latest
steps:
- uses: Eomm/why-don-t-you-tweet@v2
# We don't want to tweet if the repository is not a public one
if: ${{ !github.event.repository.private }}
with:
# GitHub event payload
# https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
tweet-message: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #Netapp #AsBuiltReport #PowerShell #Ontap #NetAppATeam"
env:
TWITTER_CONSUMER_API_KEY: ${{ secrets.TWITTER_CONSUMER_API_KEY }}
TWITTER_CONSUMER_API_SECRET: ${{ secrets.TWITTER_CONSUMER_API_SECRET }}
TWITTER_ACCESS_TOKEN: ${{ secrets.TWITTER_ACCESS_TOKEN }}
TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
bsky-post:
needs: publish-to-gallery
runs-on: ubuntu-latest
steps:
- uses: zentered/bluesky-post-action@v0.3.0
with:
post: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #Netapp #AsBuiltReport #PowerShell #Ontap #NetAppATeam"
env:
BSKY_IDENTIFIER: ${{ secrets.BSKY_IDENTIFIER }}
BSKY_PASSWORD: ${{ secrets.BSKY_PASSWORD }}
publish-to-gallery:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Set PSRepository to Trusted for PowerShell Gallery
shell: pwsh
run: |
Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
- name: Install AsBuiltReport.Core module
shell: pwsh
run: |
Install-Module -Name AsBuiltReport.Core -Repository PSGallery -Force
- name: Install NetApp.ONTAP module
shell: pwsh
run: |
Install-Module -Name NetApp.ONTAP -Repository PSGallery -Force
- name: Install AsBuiltReport.Diagram module
shell: pwsh
run: |
Install-Module -Name AsBuiltReport.Diagram -Repository PSGallery -Force
- name: Test Module Manifest
shell: pwsh
run: |
Test-ModuleManifest .\AsBuiltReport.NetApp.ONTAP\AsBuiltReport.NetApp.ONTAP.psd1
- name: Publish module to PowerShell Gallery
shell: pwsh
run: |
Publish-Module -Path ./AsBuiltReport.NetApp.ONTAP -NuGetApiKey ${{ secrets.PSGALLERY_API_KEY }} -Verbose
tweet:
needs: publish-to-gallery
runs-on: ubuntu-latest
steps:
- uses: Eomm/why-don-t-you-tweet@v2
# We don't want to tweet if the repository is not a public one
if: ${{ !github.event.repository.private }}
with:
# GitHub event payload
# https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
tweet-message: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #Netapp #AsBuiltReport #PowerShell #Ontap #NetAppATeam"
env:
TWITTER_CONSUMER_API_KEY: ${{ secrets.TWITTER_CONSUMER_API_KEY }}
TWITTER_CONSUMER_API_SECRET: ${{ secrets.TWITTER_CONSUMER_API_SECRET }}
TWITTER_ACCESS_TOKEN: ${{ secrets.TWITTER_ACCESS_TOKEN }}
TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
bsky-post:
needs: publish-to-gallery
runs-on: ubuntu-latest
steps:
- uses: zentered/bluesky-post-action@v0.3.0
with:
post: "[New Release] ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}! Check out what's new! ${{ github.event.release.html_url }} #Netapp #AsBuiltReport #PowerShell #Ontap #NetAppATeam"
env:
BSKY_IDENTIFIER: ${{ secrets.BSKY_IDENTIFIER }}
BSKY_PASSWORD: ${{ secrets.BSKY_PASSWORD }}
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
},
@{
ModuleName = 'AsBuiltReport.Diagram';
ModuleVersion = '1.0.0'
ModuleVersion = '1.0.3'
}
)

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
5 changes: 3 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.6.12] - Unreleased
## [0.6.12] - 2026-03-16

### Added

Expand All @@ -22,7 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Add ConvertTo-HashToYN function
- Add EMS configuration setting health check
- Add support for charts
- Aggragate Usage
- Aggregate Usage
- Per Node Disk Assignment

### Changed
Expand All @@ -35,6 +35,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Update github actions to use latest version
- Export diagrams by default
- Improved Cluster diagram to show Broadcast Domains and network ports per node
- Reorganize module structure - moved module files to AsBuiltReport.System.Resources/ subdirectory

### Fixed

Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,13 @@ Each of the following modules will be automatically installed by following the [

These modules may also be manually installed.

| Module Name | Minimum Required Version | PS Gallery | GitHub |
| ------------------ | :----------------------: | :-------------------------------------------------------------------: | :-------------------------------------------------------------------------: |
| PScribo | 0.11.1 | [Link](https://www.powershellgallery.com/packages/PScribo) | [Link](https://github.com/iainbrighton/PScribo/tree/master) |
| AsBuiltReport.Core | 1.5.1 | [Link](https://www.powershellgallery.com/packages/AsBuiltReport.Core) | [Link](https://github.com/AsBuiltReport/AsBuiltReport.Core/releases/latest) |
| Netapp.ONTAP | 9.17.1.2509 | [Link](https://www.powershellgallery.com/packages/NetApp.ONTAP) | |
| Module Name | Minimum Required Version | PS Gallery | GitHub |
| --------------------- | :----------------------: | :----------------------------------------------------------------------: | :-------------------------------------------------------------------------: |
| PScribo | 0.11.1 | [Link](https://www.powershellgallery.com/packages/PScribo) | [Link](https://github.com/iainbrighton/PScribo/tree/master) |
| AsBuiltReport.Core | 1.6.2 | [Link](https://www.powershellgallery.com/packages/AsBuiltReport.Core) | [Link](https://github.com/AsBuiltReport/AsBuiltReport.Core/releases/latest) |
| Netapp.ONTAP | 9.18.1.2601 | [Link](https://www.powershellgallery.com/packages/NetApp.ONTAP) | [Link](https://github.com/NetApp/ontap-powershell-modules) |
| AsBuiltReport.Chart | 0.3.0 | [Link](https://www.powershellgallery.com/packages/AsBuiltReport.Chart) | [Link](https://github.com/AsBuiltReport/AsBuiltReport.Chart) |
| AsBuiltReport.Diagram | 1.0.3 | [Link](https://www.powershellgallery.com/packages/AsBuiltReport.Diagram) | [Link](https://github.com/AsBuiltReport/AsBuiltReport.Diagram) |

## :package: Module Installation

Expand Down
62 changes: 0 additions & 62 deletions Todo.md
Original file line number Diff line number Diff line change
@@ -1,62 +0,0 @@
- [ ] Aggregate Diagram
- [ ] Add Raid group information to the Aggregate Diagram
- [ ] Add Disk information to the Aggregate Diagram

- [] Network Port Diagram
- [] Cluster Network Ports:
- [] Document all ports and lifs used by the cluster nodes for cluster communication.
- [] Network Ports:
- [] Ifgrps:
- [] Document all ifgrps used in the cluster and their associated ports.
- [] Vlan Interface Ports:
- [] Document all ports used by management access to the cluster nodes.
- [] Document all ports used for replication traffic.

- [] Add Health check for Nodes without intercluster interface (Replication Information)

- [] Implement InfoLevel 1/2 on every section
- Example
- Aggegate Option
- Volumes Options
- Lun Summary vs Lun Full Information

- [] Vserver Information
- [] Add healthcheck for no route in vserver
- [] Configure at least one route to ensure client can assess the vserver services.


```powershell
Import-Module AsBuiltReport.NetApp.ONTAP -Force
Import-Module NetApp.ONTAP -Force
Import-Module AsBuiltReport.Diagram -Force
Import-Module AsBuiltReport.Chart -Force

New-AsBuiltReport -Report NetApp.ONTAP -AsBuiltConfigFilePath "$($env:HOME)/script/AsBuiltReport.json" -OutputFolderPath "$($env:HOME)" -Target 192.168.7.60 -Format HTML -EnableHealthCheck -UserName 'admin' -Password 'P@ssw0rd' -ReportConfigFilePath "$($env:HOME)/script/AsBuiltReport.NetApp.ONTAP.json"
```

```powershell
$password = ConvertTo-SecureString "P@ssw0rd" -AsPlainText -Force
$Cred = New-Object System.Management.Automation.PSCredential ("admin", $password)

Connect-NcController 192.168.5.70 -Credential $Cred

Import-Module AsBuiltReport.NetApp.ONTAP -Force
Import-Module NetApp.ONTAP -Force
Import-Module AsBuiltReport.Diagram -Force
Import-Module AsBuiltReport.Chart -Force

New-AsBuiltReport -Report NetApp.ONTAP -AsBuiltConfigFilePath "$($env:HOME)/script/AsBuiltReport.json" -OutputFolderPath "$($env:HOME)" -Target 192.168.5.70 -Format HTML -EnableHealthCheck -UserName 'admin' -Password 'P@ssw0rd' -ReportConfigFilePath "$($env:HOME)/script/AsBuiltReport.NetApp.ONTAP.json"

```powershell
$password = ConvertTo-SecureString "P@ssw0rd" -AsPlainText -Force
$Cred = New-Object System.Management.Automation.PSCredential ("admin", $password)

Connect-NcController 172.23.4.60 -Credential $Cred

Import-Module AsBuiltReport.NetApp.ONTAP -Force
Import-Module NetApp.ONTAP -Force
Import-Module AsBuiltReport.Diagram -Force
Import-Module AsBuiltReport.Chart -Force

New-AsBuiltReport -Report NetApp.ONTAP -AsBuiltConfigFilePath "$($env:HOME)/script/AsBuiltReport.json" -OutputFolderPath "$($env:HOME)" -Target 172.23.4.60 -Format HTML -EnableHealthCheck -Credential $Cred -ReportConfigFilePath "$($env:HOME)/script/AsBuiltReport.NetApp.ONTAP.json"
```
Loading