Review all git repos used in initial set of layered BOMs and validate README is correct and uptodate

[mjperrins]

Review all git repos used in initial set of layered BOMs and validate README is correct and up to date

• [ ] Check it is not using the template readme
• [ ] Update to be correct
• [ ] Validate with module own on how its used

As per scrum discussion, lets compare the Maximo README as template and check the gaps across software

• README at the software level should describe the BOM
• README at the files folder level should describe the steps for executing BOM step by step

[balasgit]

Based on the main branch in the git repo, BOM Infrastructure & software readme needs updates as described below:-

AWS Common File

• https://github.com/cloud-native-toolkit/automation-solutions/blob/main/boms/infrastructure/aws/_common/storage/files/STORAGE_README.md

AWS Readme (Empty)

• https://github.com/cloud-native-toolkit/automation-solutions/tree/main/boms/infrastructure/aws

Readme is empty for AWS Quick Start , Standard and Advanced

Azure - ARO Readme is empty https://github.com/cloud-native-toolkit/automation-solutions/blob/main/boms/infrastructure/azure/openshift-aro/1-quickstart/README.md

Azure - UPI Readme needs updates https://github.com/cloud-native-toolkit/automation-solutions/tree/main/boms/infrastructure/azure/openshift-upi/1-quickstart

Azure - Openshift needs README updates https://github.com/cloud-native-toolkit/automation-solutions/tree/main/boms/infrastructure/azure/openshift

IBM Cloud requires updates to README https://github.com/cloud-native-toolkit/automation-solutions/tree/main/boms/infrastructure/ibmcloud

Need README for IBM Cloud QuickStart, Standard and Advanced https://github.com/cloud-native-toolkit/automation-solutions/tree/main/boms/infrastructure/ibmcloud/openshift

Need README update IBM Cloud BOM https://github.com/cloud-native-toolkit/automation-solutions/tree/main/boms/infrastructure/ibmcloud/openshift/files

Data Fabric BOM Readme (Needs update)

• https://github.com/cloud-native-toolkit/automation-solutions/tree/main/boms/software/datafabric/files

DevTools Requires README - Nothing exist https://github.com/cloud-native-toolkit/automation-solutions/tree/main/boms/software/devtools

Gitops Needs README https://github.com/cloud-native-toolkit/automation-solutions/tree/main/boms/software/gitops

CP4I Needs README update https://github.com/cloud-native-toolkit/automation-solutions/tree/main/boms/software/integration/files

• No instructions for individual CP4I component to install
• Azure / AWS mentioned as TBD. The instructions are mentioned for Azure but nothing for AWS
• No Instructions mentioned for ODF like storage classes to be passed in the Terraform files

Maximo Read needs update which says supported on multi-cloud

• https://github.com/cloud-native-toolkit/automation-solutions/tree/main/boms/software/maximo

Note: Can we remove “Coming Soon” from all README ?

[balasgit]

As per scrum 16th Aug, lets create the issues across BOM if its missing.

• README at the software level
• README at the Files Folder level
• TBD needs to be updated coming soon
• Coming soon to be replaced with links

Open Question

• Do we need to validate each step by step by following README ?
• If it got stuck, lets create the issue in the software everywhere board and we can discuss "How to fix all these issues"

[balasgit]

As per discussion, the individual issues are created as well as visit for updates

• CP4I - https://github.com/cloud-native-toolkit/software-everywhere/issues/402
• AWS Storage - https://github.com/cloud-native-toolkit/software-everywhere/issues/405
• Azure Quick Start - https://github.com/cloud-native-toolkit/software-everywhere/issues/406
• AWS (Quick Start / Standard / Advanced ) https://github.com/cloud-native-toolkit/software-everywhere/issues/407
• IBM (QuickStart/ Standard / Advanced) https://github.com/cloud-native-toolkit/software-everywhere/issues/408
• IBM VPC - https://github.com/cloud-native-toolkit/software-everywhere/issues/409
• Z/OS - https://github.com/cloud-native-toolkit/software-everywhere/issues/410

[balasgit]

• Turbonomic : https://github.com/cloud-native-toolkit/software-everywhere/issues/412
• Data Fabric : https://github.com/cloud-native-toolkit/software-everywhere/issues/413
• CP4D Data Foundation : https://github.com/cloud-native-toolkit/software-everywhere/issues/414
• Maximo : https://github.com/cloud-native-toolkit/software-everywhere/issues/415
• Ascent Loading BOM : https://github.com/cloud-native-toolkit/software-everywhere/issues/416