Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for including comparison of installed version with BoM #41

Closed
3 of 4 tasks
serbiansky opened this issue Dec 6, 2022 · 6 comments
Closed
3 of 4 tasks
Labels
enhancement Enhancement report/health Health Report report/overview Overview Report vcf/4 VMware Cloud Foundation 4.x
Milestone

Comments

@serbiansky
Copy link

Code of Conduct

  • I have read and agree to the project's Code of Conduct.
  • Vote on this issue by adding a 👍 reaction to the original issue initial description to help the maintainers prioritize.
  • Do not leave "+1" or other comments that do not add relevant information or questions.
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment.

Description

In System Overview Report we have deployed versions, maybe we can include comparison table to compare installed version vs BoM of current VCF version. Maybe in Health report this comparison can be useful as well.
With this we can identify is it AP Tool used (then AP tool need to be used for upgrade) or more importantly to validate that customer didn't used manual upgrade for some components, which is not so rare case. If they customer upgraded manually to version supported by AP tool that will be easy to solve before upgrade. But if they used versions which are not supported by AP tool then it will not be easy to solve without GSS.

Use Case(s)

Identifying versions of components which are not part of VCF BoM and if AP tools is not used then upgrade will not be possible for that component without GSS involvement. Not so rare customers are using direct upgrade of components like ESXi, vCenter or NSX without AP tool and with this validation we will be able to identify before upgrade.

Potential Configuration

Adding comparison table of currently deployed versions with VCF BoM in System Overview Report and or Health report. Color coding will be good if version is part of BoM in green and red if its not.
If AP tool is used maybe we can add note that AP tool needs to be used for future VCF upgrades. This is documented in AP tool documentation but usually ignored by customers.

References

No response

@serbiansky serbiansky added the enhancement Enhancement label Dec 6, 2022
@github-actions github-actions bot added the pending-review Pending Review label Dec 6, 2022
@tenthirtyam tenthirtyam added backlog Backlog report/health Health Report report/overview Overview Report and removed pending-review Pending Review labels Dec 6, 2022
@tenthirtyam tenthirtyam added this to the Backlog milestone Dec 6, 2022
@tenthirtyam tenthirtyam changed the title Add support for including comparison of installed version with BoM in System Overview Report (or in Health report) Add support for including comparison of installed version with BoM Dec 6, 2022
@tenthirtyam
Copy link
Collaborator

May be able to use the JSON output from SOS to some portions achieve this enhancement.

    "Version Check Status": {
        "sfo01-m01-esx04.sfo.rainpole.io": {
            "area": "ESXI: sfo01-m01-esx04.sfo.rainpole.io",
            "title": [
                "7.0.3-20328353",
                "7.0.3-20328353",
                "7.0.3-20328353"
            ],
            "state": "GREEN",
            "timestamp": "Mon Nov 21 14:08:36 2022",
            "message": "No Version mismatch found for ESXI:sfo01-m01-esx04.sfo.rainpole.io. BOM version 7.0.3-20328353, Component Running installed version 7.0.3-20328353 and VCF Inventory version 7.0.3-20328353 are as expected.",
            "status": "passed",
            "alert": "GREEN"
        },
        "sfo01-m01-esx02.sfo.rainpole.io": {
            "area": "ESXI: sfo01-m01-esx02.sfo.rainpole.io",
            "title": [
                "7.0.3-20328353",
                "7.0.3-20328353",
                "7.0.3-20328353"
            ],
            "state": "GREEN",
            "timestamp": "Mon Nov 21 14:08:36 2022",
            "message": "No Version mismatch found for ESXI:sfo01-m01-esx02.sfo.rainpole.io. BOM version 7.0.3-20328353, Component Running installed version 7.0.3-20328353 and VCF Inventory version 7.0.3-20328353 are as expected.",
            "status": "passed",
            "alert": "GREEN"
        },
        "sfo01-w01-esx03.sfo.rainpole.io": {
            "area": "ESXI: sfo01-w01-esx03.sfo.rainpole.io",
            "title": [
                "7.0.3-20328353",
                "7.0.3-20328353",
                "7.0.3-20328353"
            ],
            "state": "GREEN",
            "timestamp": "Mon Nov 21 14:08:36 2022",
            "message": "No Version mismatch found for ESXI:sfo01-w01-esx03.sfo.rainpole.io. BOM version 7.0.3-20328353, Component Running installed version 7.0.3-20328353 and VCF Inventory version 7.0.3-20328353 are as expected.",
            "status": "passed",
            "alert": "GREEN"
        },
        "sfo01-w01-esx01.sfo.rainpole.io": {
            "area": "ESXI: sfo01-w01-esx01.sfo.rainpole.io",
            "title": [
                "7.0.3-20328353",
                "7.0.3-20328353",
                "7.0.3-20328353"
            ],
            "state": "GREEN",
            "timestamp": "Mon Nov 21 14:08:36 2022",
            "message": "No Version mismatch found for ESXI:sfo01-w01-esx01.sfo.rainpole.io. BOM version 7.0.3-20328353, Component Running installed version 7.0.3-20328353 and VCF Inventory version 7.0.3-20328353 are as expected.",
            "status": "passed",
            "alert": "GREEN"
        },
        "sfo01-w01-esx04.sfo.rainpole.io": {
            "area": "ESXI: sfo01-w01-esx04.sfo.rainpole.io",
            "title": [
                "7.0.3-20328353",
                "7.0.3-20328353",
                "7.0.3-20328353"
            ],
            "state": "GREEN",
            "timestamp": "Mon Nov 21 14:08:36 2022",
            "message": "No Version mismatch found for ESXI:sfo01-w01-esx04.sfo.rainpole.io. BOM version 7.0.3-20328353, Component Running installed version 7.0.3-20328353 and VCF Inventory version 7.0.3-20328353 are as expected.",
            "status": "passed",
            "alert": "GREEN"
        },
        "sfo01-m01-esx03.sfo.rainpole.io": {
            "area": "ESXI: sfo01-m01-esx03.sfo.rainpole.io",
            "title": [
                "7.0.3-20328353",
                "7.0.3-20328353",
                "7.0.3-20328353"
            ],
            "state": "GREEN",
            "timestamp": "Mon Nov 21 14:08:36 2022",
            "message": "No Version mismatch found for ESXI:sfo01-m01-esx03.sfo.rainpole.io. BOM version 7.0.3-20328353, Component Running installed version 7.0.3-20328353 and VCF Inventory version 7.0.3-20328353 are as expected.",
            "status": "passed",
            "alert": "GREEN"
        },
        "sfo01-m01-esx01.sfo.rainpole.io": {
            "area": "ESXI: sfo01-m01-esx01.sfo.rainpole.io",
            "title": [
                "7.0.3-20328353",
                "7.0.3-20328353",
                "7.0.3-20328353"
            ],
            "state": "GREEN",
            "timestamp": "Mon Nov 21 14:08:36 2022",
            "message": "No Version mismatch found for ESXI:sfo01-m01-esx01.sfo.rainpole.io. BOM version 7.0.3-20328353, Component Running installed version 7.0.3-20328353 and VCF Inventory version 7.0.3-20328353 are as expected.",
            "status": "passed",
            "alert": "GREEN"
        },
        "sfo-m01-vc01.sfo.rainpole.io": {
            "area": "VCENTER: sfo-m01-vc01.sfo.rainpole.io",
            "title": [
                "7.0.3.01000-20395099",
                "7.0.3.01000-20395099",
                "7.0.3.01000-20395099"
            ],
            "state": "GREEN",
            "timestamp": "Mon Nov 21 14:08:36 2022",
            "message": "No Version mismatch found for VCENTER:sfo-m01-vc01.sfo.rainpole.io. BOM version 7.0.3.01000-20395099, Component Running installed version 7.0.3.01000-20395099 and VCF Inventory version 7.0.3.01000-20395099 are as expected.",
            "status": "passed",
            "alert": "GREEN"
        },
        "sfo-w01-vc01.sfo.rainpole.io": {
            "area": "VCENTER: sfo-w01-vc01.sfo.rainpole.io",
            "title": [
                "7.0.3.01000-20395099",
                "7.0.3.01000-20395099",
                "7.0.3.01000-20395099"
            ],
            "state": "GREEN",
            "timestamp": "Mon Nov 21 14:08:36 2022",
            "message": "No Version mismatch found for VCENTER:sfo-w01-vc01.sfo.rainpole.io. BOM version 7.0.3.01000-20395099, Component Running installed version 7.0.3.01000-20395099 and VCF Inventory version 7.0.3.01000-20395099 are as expected.",
            "status": "passed",
            "alert": "GREEN"
        },
        "sfo-m01-nsx01.sfo.rainpole.io": {
            "area": "NSX_MANAGER: sfo-m01-nsx01.sfo.rainpole.io",
            "title": [
                "3.2.1.2.0-20541212",
                "3.2.1.2.0-20541212",
                "3.2.1.2.0-20541212"
            ],
            "state": "GREEN",
            "timestamp": "Mon Nov 21 14:08:36 2022",
            "message": "No Version mismatch found for NSX_MANAGER:sfo-m01-nsx01.sfo.rainpole.io. BOM version 3.2.1.2.0-20541212, Component Running installed version 3.2.1.2.0-20541212 and VCF Inventory version 3.2.1.2.0-20541212 are as expected.",
            "status": "passed",
            "alert": "GREEN"
        },
        "sfo-w01-nsx01.sfo.rainpole.io": {
            "area": "NSX_MANAGER: sfo-w01-nsx01.sfo.rainpole.io",
            "title": [
                "3.2.1.2.0-20541212",
                "3.2.1.2.0-20541212",
                "3.2.1.2.0-20541212"
            ],
            "state": "GREEN",
            "timestamp": "Mon Nov 21 14:08:36 2022",
            "message": "No Version mismatch found for NSX_MANAGER:sfo-w01-nsx01.sfo.rainpole.io. BOM version 3.2.1.2.0-20541212, Component Running installed version 3.2.1.2.0-20541212 and VCF Inventory version 3.2.1.2.0-20541212 are as expected.",
            "status": "passed",
            "alert": "GREEN"
        },
        "sfo-vcf01.sfo.rainpole.io": {
            "area": "SDDC: sfo-vcf01.sfo.rainpole.io",
            "title": [
                "4.5.0.0",
                "4.5.0.0",
                "4.5.0.0"
            ],
            "state": "GREEN",
            "timestamp": "Mon Nov 21 14:08:36 2022",
            "message": "No Version mismatch found for SDDC:sfo-vcf01.sfo.rainpole.io. BOM version 4.5.0.0, Component Running installed version 4.5.0.0 and VCF Inventory. version 4.5.0.0 are as expected. SDDC Manager Build no. is excluded from the check.",
            "status": "passed",
            "alert": "GREEN"
        }
    },

@serbiansky
Copy link
Author

serbiansky commented Dec 9, 2022

Yes, that's how last time I notice at report:

 "state": "YELLOW",
            "timestamp": "Mon Nov 21 14:30:23 2022",
            "message": "Failed. Version mismatch found for ESXI:esxi-01 BOM version 7.0.3-19482537, Component Running installed version 7.0.3-20036589 and VCF Inventory version 7.0.3-20036589 are not as expected.",
            "status": "failed",
            "alert": "YELLOW"

@tenthirtyam
Copy link
Collaborator

If AP tool is used maybe we can add note that AP tool needs to be used for future VCF upgrades. This is documented in AP tool documentation but usually ignored by customers.

I think the drift for a BOM release is easily doable with some regex; however, inclusion of sync Patch Tool ("APT") context might be more substantial.

One issue with bringing in APT may that we'd need to likely keep a .json file updated for each release and what APT supports, which could increase scope for the module and release cadence influenced by APT.

Let's discuss in the New Year.

Ryan

@github-actions
Copy link

'Marking this issue as stale due to inactivity. This helps us focus on the active issues. If this issue receives no comments in the next 30 days it will automatically be closed.

If this issue was automatically closed and you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context.
Thank you!'

@github-actions github-actions bot added the stale Stale label Feb 21, 2023
@tenthirtyam tenthirtyam removed the stale Stale label Feb 24, 2023
@tenthirtyam tenthirtyam added the vcf/4 VMware Cloud Foundation 4.x label Mar 9, 2023
@tenthirtyam tenthirtyam modified the milestones: Backlog, v2.2.0 Mar 10, 2023
tenthirtyam pushed a commit that referenced this issue Apr 13, 2023
- Added `Publish-VersionHealth` to return the version health from the SoS Health Summary JSON data.
- Updated `Invoke-VcfHealthReport` to include the version health using the `Publish-VersionHealth` cmdlet.
- Fix typos.
- Bumps the module version to v2.0.0.1008.
- Updates `CHANGELOG.md`.

Ref: #41

Signed-off-by: Ryan Johnson <[email protected]>
@tenthirtyam tenthirtyam modified the milestones: v2.2.0, v2.0.0 Apr 13, 2023
@tenthirtyam tenthirtyam removed the backlog Backlog label Apr 13, 2023
@tenthirtyam
Copy link
Collaborator

There is coverage, sans APT, in #123.

@tenthirtyam tenthirtyam modified the milestones: v2.2.0, v2.0.0 Apr 14, 2023
@github-actions
Copy link

I'm going to lock this issue because it has been closed for 30 days. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 15, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement Enhancement report/health Health Report report/overview Overview Report vcf/4 VMware Cloud Foundation 4.x
Projects
None yet
Development

No branches or pull requests

2 participants