Skip to content

Commit

Permalink
Merge pull request #160 from AsBuiltReport/dev
Browse files Browse the repository at this point in the history
v0.8.6 public release
  • Loading branch information
rebelinux authored Apr 30, 2024
2 parents 966b2e9 + ca0d365 commit 93ad345
Show file tree
Hide file tree
Showing 312 changed files with 4,659 additions and 2,201 deletions.
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ labels: ["bug"]
assignees:
- rebelinux
body:
- type: dropdown
id: vbrversion
attributes:
label: Veeam Backup & Replication version
options:
- 12.1
- 12
- 11
- 10
- 9.5
validations:
required: true
- type: textarea
id: bug-description
attributes:
Expand Down
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/change_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ labels: ["change request"]
assignees:
- rebelinux
body:
- type: dropdown
id: vbrversion
attributes:
label: Veeam Backup & Replication version
options:
- 12.1
- 12
- 11
- 10
- 9.5
validations:
required: true
- type: textarea
id: description
attributes:
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/Codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ on:
branches: [ "dev" ]
pull_request:
branches: [ "dev" ]
schedule:
- cron: '20 14 * * 1'

permissions:
contents: read
Expand Down
105 changes: 25 additions & 80 deletions AsBuiltReport.Veeam.VBR.Style.ps1

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions AsBuiltReport.Veeam.VBR.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
RootModule = 'AsBuiltReport.Veeam.VBR.psm1'

# Version number of this module.
ModuleVersion = '0.8.5'
ModuleVersion = '0.8.6'

# Supported PSEditions
# CompatiblePSEditions = @()
Expand Down Expand Up @@ -55,7 +55,7 @@
RequiredModules = @(
@{
ModuleName = 'AsBuiltReport.Core';
ModuleVersion = '1.3.0'
ModuleVersion = '1.4.0'
}
@{
ModuleName = 'PScriboCharts';
Expand Down
8 changes: 7 additions & 1 deletion AsBuiltreport.Veeam.VBR.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,16 @@
"ShowTableCaptions": true
},
"Options": {
"ReportStyle": "Veeam",
"BackupServerPort": 9392,
"EnableCharts": false,
"EnableHardwareInventory": false,
"EnableDiagrams": false,
"EnableDiagramDebug": false,
"DiagramWaterMark": "",
"ExportDiagrams": true,
"EnableDiagramSignature": false,
"SignatureAuthorName": "",
"SignatureCompanyName": "",
"PSDefaultAuthentication": "Default"
},
"InfoLevel": {
Expand Down
27 changes: 27 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,33 @@ 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.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.8.6] - 2024-04-29

### Added

- Add Backup Infrastructure Diagram (WIP)
- Close [#155](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/155)
- Add vCD Resources to Service Provider section
- Add Backup Repository Space Utilization chart

### Changed

- Increase AsBuiltReport.Core modules to v1.4.0
- Migrate NOTOCHeading3 to NOTOCHeading4 to fix section heading
- Change charts palette to follow new AsBuiltReport.Core theme


### Fixed

- Fix [#149](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/149)
- Fix [#151](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/151)
- Fix [#150](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/issues/150)

### Removed

- Remove EnableCharts option.
- Remove Infrastructure Charts

## [0.8.5] - 2024-03-15

### Added
Expand Down
37 changes: 24 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,15 @@ Please refer to the AsBuiltReport [website](https://www.asbuiltreport.com) for m

# :books: Sample Reports

## Sample Report - Custom Style
## Sample Report - Veeam Style

Sample Veeam VBR As Built report HTML file: [Sample Veeam Backup & Replication As Built Report.html](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/dev/Samples/Sample%20Veeam%20Backup%20%26%20Replication%20As%20Built%20Report.html)
Sample Veeam VBR As Built Report HTML file: [Sample Report](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/dev/Samples/Sample%20Veeam%20Backup%20%26%20Replication%20As%20Built%20Report.html)

Sample Veeam VBR As Built report PDF file: [Sample Veeam Backup & Replication As Built Report.pdf](https://github.com/AsBuiltReport/AsBuiltReport.Veeam.VBR/raw/dev/Samples/Sample%20Veeam%20Backup%20%26%20Replication%20As%20Built%20Report.pdf)
## Sample Diagram - Veeam Style

Sample Veeam VBR As Built Report Diagram file: [Sample Diagram](Samples/AsBuiltReport.Veeam.VBR.png)

![Sample Diagram](Samples/AsBuiltReport.Veeam.VBR.png)

# :beginner: Getting Started

Expand Down Expand Up @@ -77,6 +81,8 @@ PowerShell 5.1 and the following PowerShell modules are required for generating
- [PScriboCharts Module](https://github.com/iainbrighton/PScriboCharts)
- [AsBuiltReport.Core Module](https://github.com/AsBuiltReport/AsBuiltReport.Core)
- [Veeam.Diagrammer Module](https://github.com/rebelinux/Veeam.Diagrammer)
- [Diagrammer.Core Module](https://github.com/rebelinux/Diagrammer.Core)


### :closed_lock_with_key: Required Privileges

Expand Down Expand Up @@ -109,7 +115,7 @@ _Note: You are not limited to installing the module to those example paths, you
## :pencil2: Configuration
The Veeam VBR As Built Report utilises a JSON file to allow configuration of report information, options, detail and healthchecks.
The Veeam VBR As Built Report utilizes a JSON file to allow configuration of report information, options, detail and healthchecks.
A Veeam VBR report configuration file can be generated by executing the following command;
Expand Down Expand Up @@ -141,13 +147,19 @@ The **Report** schema provides configuration of the Veeam VBR report information

The **Options** schema allows certain options within the report to be toggled on or off.

| Sub-Schema | Setting | Default | Description |
| ----------------------- | ------------------ | ------- | --------------------------------------------------- |
| BackupServerPort | TCP Port | 9392 | Set the backup server service's custom port. |
| PSDefaultAuthentication | Negotiate/Kerberos | Default | Set the PSRemoting authentication method |
| EnableCharts | true/false | false | Toggle to enable/disable creation of charts. |
| EnableHardwareInventory | true / false | false | Toggle to enable/disable of Hardware information |
| EnableDiagrams | true / false | false | Toggle to enable/disable of Infrastructure Diagrams |
| Sub-Schema | Setting | Default | Description |
| ----------------------- | ------------------- | ------- | ---------------------------------------------------------------- |
| BackupServerPort | TCP Port | 9392 | Set the backup server service's custom port. |
| PSDefaultAuthentication | Negotiate/Kerberos | Default | Set the PSRemoting authentication method |
| EnableHardwareInventory | true / false | false | Toggle to enable/disable of Hardware information |
| ReportStyle | Veeam/AsBuiltReport | Veeam | Allow to set report style template. |
| EnableDiagrams | true / false | false | Toggle to enable/disable of Infrastructure Diagrams |
| EnableDiagramsDebug | true/false | false | Toggle to enable/disable diagram debug option. |
| DiagramWaterMark | string | empty | Used to set the diagram waterMark. |
| ExportDiagrams | true/false | true | Toggle to enable/disable diagram export option. |
| EnableDiagramSignature | true/false | false | Toggle to enable/disable diagram signature (button right corner) |
| SignatureAuthorName | string | empty | Toggle to set signature author name. |
| SignatureCompanyName | string | empty | Toggle to set signature company name. |

###### * Note: In order to generate the infrastructure diagram, the Veeam.Diagrammer module requires the following windows application [Graphviz](https://graphviz.org/download/#windows) >= v9.0

Expand Down Expand Up @@ -262,5 +274,4 @@ PS C:\> New-AsBuiltReport -Report Veeam.VBR -Target veeam-vbr.pharmax.local -Use
## :x: Known Issues

- Since many of Veeam's features depend on the Standard+ license, the Community edition is not supported.
- If the Veeam Backup Server is not joined to an Active Directory domain (WorkGroup Auth), the PSDefaultAuthentication option must be set to Negotiate. If it is not, some of the report sections will be missing.
- In order to generate the infrastructure diagram it is required to install [Graphviz](https://graphviz.org/download/) on the machine where the report is generated.
- If the Veeam Backup Server is not joined to an Active Directory domain (WorkGroup Auth), the PSDefaultAuthentication option must be set to Negotiate. If it is not, some of the report sections will be missing.
Binary file added Samples/AsBuiltReport.Veeam.VBR.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 93ad345

Please sign in to comment.