Skip to content

Commit cd5ca2f

Browse files
rebelinuxrebelinux
authored
Merge pull request #14 from AsBuiltReport/dev
v0.4.0 public release
2 parents 8bfdea4 + df15c8e commit cd5ca2f

34 files changed

+2591
-1928
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
name: Bug Report
2+
description: File a bug report
3+
labels: ["bug"]
4+
assignees:
5+
- rebelinux
6+
body:
7+
- type: textarea
8+
id: bug-description
9+
attributes:
10+
label: Bug description
11+
description: >-
12+
Please provide a clear and concise description of the bug.
13+
validations:
14+
required: true
15+
- type: input
16+
id: command-line-input
17+
attributes:
18+
label: Command-line input
19+
description: >-
20+
Please provide the command line input you are using to run AsBuiltReport. Please ensure that you obscure any sensitive information.
21+
placeholder: New-AsBuiltReport -Report VMware.SRM -Target xxxxxxx -Format Word,HTML -OutputFolderPath .\Documents\ -AsBuiltConfigFilePath .\AsBuiltReport\AsBuiltReport.json -ReportConfigFilePath .\AsBuiltReport\AsBuiltReport.VMware.SRM.json -EnableHealthCheck -Verbose
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: steps-to-reproduce
26+
attributes:
27+
label: Steps to reproduce
28+
description: >-
29+
Please provide a detailed list of steps to reproduce the bug.
30+
placeholder: |-
31+
1. ....
32+
2. ....
33+
3. ....
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: expected-behaviour
38+
attributes:
39+
label: Expected behaviour
40+
description: >-
41+
Please provide a clear and concise description of what you expected to happen.
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: screenshots
46+
attributes:
47+
label: Screenshots
48+
description: >-
49+
Please attach any screenshots to help explain the problem. Please ensure that you obscure any sensitive information.
50+
placeholder: |-
51+
Drag and drop screenshots here.
52+
- type: textarea
53+
id: operating-system
54+
attributes:
55+
label: Operating System
56+
description: Please provide information about the operating system are you using.
57+
placeholder: macOS Big Sur, Windows 10, Ubuntu 20.04 LTS
58+
validations:
59+
required: true
60+
- type: textarea
61+
id: powershell-version
62+
attributes:
63+
label: PowerShell Version
64+
description: Please provide information about the PowerShell version you are using. Please provide the output from the following PowerShell command `$PSVersionTable`.
65+
placeholder: $PSVersionTable
66+
validations:
67+
required: true
68+
- type: textarea
69+
id: powershell-modules
70+
attributes:
71+
label: PowerShell Modules
72+
description: Please provide information about the PowerShell modules are you using. Please provide the output from the following PowerShell command `Get-Module -ListAvailable @("AsBuiltReport.Core";"AsBuiltReport.VMware.SRM";"PScribo") | Select Name, Version`
73+
placeholder: Get-Module -ListAvailable @("AsBuiltReport.Core";"AsBuiltReport.VMware.SRM";"PScribo") | Select Name, Version
74+
validations:
75+
required: true
76+
- type: textarea
77+
id: additional-context
78+
attributes:
79+
label: Additional Context
80+
description: This field is optional. You may provide additional context for the bug you wish to report. You may wish to include links to any related [issues](https://github.com/AsBuiltReport/AsBuiltReport.VMware.SRM/issues) or other relevant information.
81+
- type: checkboxes
82+
id: checklist
83+
attributes:
84+
label: Before submitting
85+
description: >-
86+
Please ensure your bug report fulfills all of the following requirements.
87+
If you are unsure of what a specific requirement means, please follow the links to learn about it and understand why it is necessary before submitting.
88+
options:
89+
- label: >-
90+
I have read and followed the [bug reporting guidelines](https://www.asbuiltreport.com/about/contributing/#reporting-issues-and-bugs).
91+
required: true
92+
- label: >-
93+
I have read [the documentation](https://www.asbuiltreport.com/user-guide/new-asbuiltconfig),
94+
and referred to the [known issues](https://www.asbuiltreport.com/user-guide/known-issues/) before submitting this bug report.
95+
required: true
96+
- label: >-
97+
I have checked for previously opened & closed [issues](https://github.com/AsBuiltReport/AsBuiltReport.VMware.SRM/issues) before submitting this bug report.
98+
required: true

‎.github/ISSUE_TEMPLATE/change_request.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Change Request
2+
description: Request a new feature or an improvement
3+
labels: ["change request"]
4+
assignees:
5+
- tpcarman
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Description
11+
description: >-
12+
Please provide a detailed description of your idea so that the project maintainers and contributors can fully understand what change, feature, or improvement you are proposing.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: additional-context
17+
attributes:
18+
label: Additional Context
19+
description: This field is optional. You may provide additional context for the idea you wish to propose. You may wish to include links to any related [issues](https://github.com/AsBuiltReport/AsBuiltReport.VMware.SRM/issues) or other relevant information.
20+
- type: checkboxes
21+
id: checklist
22+
attributes:
23+
label: Before submitting
24+
description: >-
25+
Please ensure your change request fulfills all of the following requirements.
26+
If you are unsure of what a specific requirement means, please follow the links to learn about it and understand why it is necessary before submitting.
27+
options:
28+
- label: >-
29+
I have read [the documentation](https://www.asbuiltreport.com/user-guide/new-asbuiltconfig),
30+
and referred to the [known issues](https://www.asbuiltreport.com/user-guide/known-issues/) before submitting this change request.
31+
required: true
32+
- label: >-
33+
I have checked for previously opened & closed [issues](https://github.com/AsBuiltReport/AsBuiltReport.VMware.SRM/issues) before submitting this change request.
34+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎AsBuiltReport.VMware.SRM.json

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Report": {
3-
"Name": "VMware SRM As Built Report",
3+
"Name": "VMware Site Recovery Manager As Built Report",
44
"Version": "1.0",
55
"Status": "Released",
66
"ShowCoverPageImage": true,
@@ -13,14 +13,22 @@
1313
},
1414
"InfoLevel": {
1515
"_comment_": "0 = Disabled, 1 = Enabled, 2 = Adv Summary, 3 = Detailed",
16-
"Summary": 1,
17-
"Protected": 1,
18-
"Recovery": 1,
16+
"Sites": 1,
17+
"vCenter": 1,
18+
"License": 1,
19+
"Permission": 1,
20+
"ArrayPairs": 1,
21+
"SRA": 1,
22+
"NetworkMapping": 1,
23+
"FolderMapping": 1,
24+
"ResourceMapping": 1,
25+
"PlaceholderDatastores": 1,
1926
"ProtectionGroup": 1,
2027
"RecoveryPlan": 1,
21-
"InventoryMapping": 1
28+
"Summary": 1
2229
},
2330
"HealthCheck": {
31+
"Licensing": true,
2432
"InventoryMapping": {
2533
"Status": true
2634
},
@@ -30,6 +38,5 @@
3038
"Recovery": {
3139
"Status": true
3240
}
33-
3441
}
3542
}

‎AsBuiltReport.VMware.SRM.psd1

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
RootModule = 'AsBuiltReport.VMware.SRM.psm1'
1313

1414
# Version number of this module.
15-
ModuleVersion = '0.3.1'
15+
ModuleVersion = '0.4.0'
1616

1717
# Supported PSEditions
1818
# CompatiblePSEditions = @()
@@ -24,10 +24,10 @@ GUID = '5a38c64d-2968-404e-b323-0ff35e227917'
2424
Author = 'Jonathan Colon'
2525

2626
# Company or vendor of this module
27-
CompanyName = 'ZenPrSolutions'
27+
# CompanyName = 'ZenPrSolutions'
2828

2929
# Copyright statement for this module
30-
Copyright = '(c) 2022 Jonathan Colon. All rights reserved.'
30+
Copyright = '(c) 2023 Jonathan Colon. All rights reserved.'
3131

3232
# Description of the functionality provided by this module
3333
Description = 'A PowerShell module to generate an as built report on the configuration of VMware SRM.'
@@ -54,7 +54,7 @@ PowerShellVersion = '5.1'
5454
RequiredModules = @(
5555
@{
5656
ModuleName = 'AsBuiltReport.Core';
57-
ModuleVersion = '1.1.0'
57+
ModuleVersion = '1.3.0'
5858
}
5959
)
6060

@@ -124,6 +124,4 @@ PrivateData = @{
124124
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
125125
# DefaultCommandPrefix = ''
126126

127-
}
128-
129-
127+
}

‎CHANGELOG.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
1-
# :arrows_counterclockwise: VMware SRM As Built Report Changelog
1+
# :arrows_clockwise: VMware SRM As Built Report Changelog
2+
3+
## [0.4.0] - 2023-05-14
4+
5+
### Added
6+
7+
- Added Array Pairs information @tpcarman
8+
- Added Storage Replication Adapter information @tpcarman
9+
10+
### Changed
11+
12+
- Improved report content and structure @tpcarman
13+
- Improved bug and feature request templates
14+
- Changed Required Modules to AsBuiltReport.Core v1.3.0
215

316
## [0.3.1] - 2022-01-17
417

‎README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Please refer to the AsBuiltReport [website](https://www.asbuiltreport.com) for m
3737

3838
## Sample Report - Custom Style 1
3939

40-
Sample VMware SRM As Built report HTML file: [Sample VMware SRM As-Built Report.html](https://technomyth.zenprsolutions.net/wp-content/uploads/2022/01/Sample-VMware-SRM-As-Built-Report.html)
40+
Sample VMware SRM As Built report HTML file: [Sample VMware SRM As-Built Report.html](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AsBuiltReport/AsBuiltReport.VMware.SRM/dev/Samples/Sample%20VMware%20SRM%20As%20Built%20Report.html)
4141

4242
# :beginner: Getting Started
4343

@@ -67,15 +67,10 @@ This report is compatible with the following PowerShell versions;
6767
<!-- ********** Update system requirements ********** -->
6868
PowerShell 5.1 or PowerShell 7, and the following PowerShell modules are required for generating a VMware SRM As Built report.
6969

70-
- [AsBuiltReport.VMware.SRM Module](https://www.powershellgallery.com/packages/AsBuiltReport.VMware.SRM/).
71-
72-
### Linux & macOS
73-
74-
- .NET Core is required for cover page image support on Linux and macOS operating systems.
75-
- [Installing .NET Coe.re for macOS](https://docs.microsoft.com/en-us/dotnet/core/install/macos)
76-
- [Installing .NET Core for Linux](https://docs.microsoft.com/en-us/dotnet/core/install/linux)
70+
Each of these modules can be easily downloaded and installed via the PowerShell Gallery
7771

78-
❗ If you are unable to install .NET Core, you must set `ShowCoverPageImage` to `False` in the report JSON configuration file.
72+
- [VMware PowerCLI Module](https://www.powershellgallery.com/packages/VMware.PowerCLI/)
73+
- [AsBuiltReport.VMware.SRM Module](https://www.powershellgallery.com/packages/AsBuiltReport.VMware.SRM/).
7974

8075
### :closed_lock_with_key: Required Privileges
8176

@@ -86,6 +81,7 @@ Tested with vCenter Global Read-Only permissions.
8681
### PowerShell
8782

8883
```powershell
84+
install-module VMware.PowerCLI -MinimumVersion 13.1 -AllowClobber
8985
install-module AsBuiltReport.VMware.SRM
9086
```
9187

@@ -163,13 +159,19 @@ The table below outlines the default and maximum **InfoLevel** settings for each
163159

164160
| Sub-Schema | Default Setting | Maximum Setting |
165161
|--------------|:---------------:|:---------------:|
162+
| ArrayPairs | 1 | 1 |
163+
| SRA | 1 | 1 |
164+
| Sites | 1 | 1 |
165+
| License | 1 | 1 |
166166
| Summary | 1 | 1 |
167-
| Protected | 1 | 1 |
168-
| Recovery | 1 | 1 |
167+
| FolderMapping | 1 | 1 |
168+
| NetworkMapping | 1 | 1 |
169+
| ResourceMapping | 1 | 1 |
170+
| PlaceholderDatastores | 1 | 1 |
171+
| Permission | 1 | 1 |
169172
| ProtectionGroup | 1 | 3 |
170173
| RecoveryPlan | 1 | 3 |
171-
| InventoryMapping | 1 | 1 |
172-
174+
| Permission | 1 | 1 |
173175

174176
### Healthcheck
175177

0 commit comments

Comments
 (0)