refactor(module/test_infrastructure): module creation and adjusted examples

[acelebanski]

Description

PR delivers changes for test_infrastructure:

• Creation of the test_infrastructure module and integrating it with reference architecture examples in favour of a separate test infra example
• Made the module compliant with the following principles
  • README.md adjusted to new style with additional header file
  • minimum Terraform version set to 1.5
  • refactor variables:
    • descriptions
    • types with optionals
    • default values
    • validations
    • simplify main.tf by removing not required try
    • remove name generation logic from the module
    • add terraform registry reference

Motivation and Context

#8

How Has This Been Tested?

Refactored common_vmseries example has been deployed in the lab.

Types of changes

• New feature (non-breaking change which adds functionality)

Checklist

• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes if appropriate.
• All new and existing tests passed.

[migara]

/plan paths="modules/vmseries"

Testing job ID: 7815502865
Job result: FAILURE
Job result: FAILURE

[migara]

/plan paths="modules/vmseries"

Testing job ID: 7816328335
Job result: SUCCESS

[alperenkose]

We need to update the README files regarding the following comments:

• refactor(module/test_infrastructure): module creation and adjusted examples #10 (comment)
• refactor(module/test_infrastructure): module creation and adjusted examples #10 (comment)

[sebastianczech]

Generally, it looks good , I have only 2 optional comments.

[sebastianczech]

Overall great job. I have few comments, but they are optional 👍

[alperenkose]

That's great work in deed 👍🏻 I just have one comment, I think we don't handle the auto creation of hidden readme files with a dot for .README.md, this can result us forgetting about it and committing a new README.md file without "." in the test_instrastructure module.

I think we can handle this in one of the 2 ways;

• Creating a terraform-docs yaml file within the test_infrastructure module itself so it has the output set as .README.md. This config should take precedence over the one in the root module if I understand correctly. We might need to remove yaml config file reference in pre-commit hooks. Need to be tested.
  https://terraform-docs.io/user-guide/configuration/
• Targeting the test_infrastructure module separately in pre-commit hooks, by creating another hook with specific --output-file parameter to generate .README.md in the module. Need to be tested as well, might have a conflict when we have a generic terraform-docs and module specific terraform-docs hook at the same time.
  https://terraform-docs.io/how-to/pre-commit-hooks/

[alperenkose]

Opened a separate case for the .README.md file handling referred to here: #10 (review)