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

docs: Move examples that are more like test cases to the new tests/ directory; add better example configurations #3069

Merged
merged 6 commits into from
Jun 13, 2024

Conversation

bryantbiggs
Copy link
Member

Description

  • Move examples that are more like test cases to the new tests/ directory
  • Replace "test" configurations with better example configurations
  • Change nodegroup to node group

Motivation and Context

  • The use of the examples/ directory has been historically a mix of both demonstrating the various ways in which the provided module(s) can be configured, but also as a means of testing and validating changes. For smaller, more simple module this works ok - but for a larger, complex module such as EKS with all of the various ways one could configure a cluster, its a nightmare for users looking to get started. This PR is the start of splitting apart those two concepts:
    • Test configurations will be stored under tests/ directory, and in the future we can explore the use of utilizing the native Terraform testing facilities. These configurations are quite elaborate and far from what you should ever expect to see in the wild - we are aiming to cover the full breadth of functionality that the module(s) provide in this directory in order to test and validate that provided functionality
    • Example configurations will be stored under the examples/ directory. Now, when users look to the example configurations provided, those examples should less complex than what was previously provided and therefore more realistic in terms of a starting point for a cluster

There will be subsequent PRs that will expand on this change as we look to improve the documentation around the module's usability. For example, the next PR will look to introduce a simple mkdocs website where we can start to build out better and more comprehensive documentation around things such as:

  • EKS addons and their configuration, how the version is inferred, etc.
  • Configuring storage for nodes
  • Explain the use of custom launch template versus the default launch template with EKS managed node group
  • The process and behavior of upgrading a cluster's Kubernetes version with this module
  • Autoscaling of nodes and how that affects/interacts with this module (or vice versa)

Breaking Changes

  • No

How Has This Been Tested?

  • I have updated at least one of the examples/* to demonstrate and validate my change(s)
  • I have tested and validated these changes using one or more of the provided examples/* projects
  • I have executed pre-commit run -a on my pull request

@bryantbiggs bryantbiggs requested a review from antonbabenko June 13, 2024 14:38
Copy link
Member

@antonbabenko antonbabenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me if you think that such separation helps you manage it.

@bryantbiggs bryantbiggs merged commit 323fb75 into terraform-aws-modules:master Jun 13, 2024
19 checks passed
@bryantbiggs bryantbiggs deleted the chore/tests branch June 13, 2024 14:51
@antonbabenko
Copy link
Member

This PR is included in version 20.15.0 🎉

Copy link

I'm going to lock this pull request 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 related to this change, 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 Jul 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants