Look at README.md and see whether the content is fit-for-purpose

[sxa]

The README.md has had very little maintenance in the last two years. We should look at see if it is usable by end-users coming to the project and wishing to make use of our infrastructure by making it easy for people to find their way around.

Some notes:

• We should provide more "quick overview" information with links about the services which we use: Jenkins, Nagios, Bastillion, AWX
• I feel that "How to use the stuff in this repo" needs to be a bit more visible
• Related to the above point we have https://github.com/adoptium/infrastructure/blob/master/ansible/README.md which is linked from the top level readme, but maybe some of that should be inlined?
• Similarly the information about the types of machine we have would make a good overview with links into the more detailed documentation on each. Need to consider the relationship between this information and what we have in the FAQ. For example we have these system types
  • Real machines
  • build containers created using the files in ansible/docker
  • Docker Host systems used for running the build containers and Docker Static systems
  • Docker Static systems
  • "On-demand" provisioned machines (currently only at MacStadium with Orka, but we have previously had Azure and OpenStack at OSUOSL support for this

[sxa]

Also for consideration: tags

tags can be used for inclusion or exclusion (--skiptags). In the case where a tag is skipped it should ideally not have any negative side effects. An example I hit was when excluding nagios_plugins it knocked out the Get_Vendor_Files role which stopped it obtaining the credentials for the jenkins user.

As a minimum this should be a warning in the new doc, but perhaps we should make the tags operate at a more granular level if possible. It may be difficult to support the above scanario and also just running the affected role.