[PR #646/d7e36178 backport][stable-4] [Plugin elasticache_info] includes the description of each replication group #1292
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…n group (#646) [Plugin elasticache_info] includes the description of each replication group SUMMARY This pull request add the description of the corresponding Elasticache replication group into each described cache cluster. ISSUE TYPE Feature Pull Request COMPONENT NAME elasticache_info ADDITIONAL INFORMATION Actually the only way to describe Elasticache replication groups with Ansible is to use the dynamic inventory. However, exposing the informations about each replication group could be useful in other contexts. In my case, I am generating a few .env files and I need to include some Elasticache replication group primary endpoint and reader endpoint. Since the elasticache_info plugin already exist and already retrieves the appropriate replication_group_id, I believe that this plugin should also retrieve the replication group description when it exists. OTHER REMARKS CONCERNING THIS PULL REQUEST Each provided description is copy/pasted from the official boto3 documentation which is distributed under an Apache 2.0 licence. I did it for consistency reason between and also because I am not a native speaker. Also the provided description is incomplete : I only documented the fields that I was able to retrieve from my current AWS clusters. Boto3 documentation of the "describe_replication_groups" function : https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/elasticache.html#ElastiCache.Client.describe_replication_groups Moreover this pull request might violates the "integration tests" rule : I didn't find any integration test for the elasticache_info plugin and I don't know why no integration test have been made. Reviewed-by: Mark Chappell <None> (cherry picked from commit d7e3617)
Docs Build 📝Thank you for contribution!✨ This PR has been merged and your docs changes will be incorporated when they are next published. |
tremble
approved these changes
Jul 1, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a backport of PR #646 as merged into main (d7e3617).
SUMMARY
This pull request add the description of the corresponding Elasticache replication group into each described cache cluster.
ISSUE TYPE
COMPONENT NAME
elasticache_info
ADDITIONAL INFORMATION
Actually the only way to describe Elasticache replication groups with Ansible is to use the dynamic inventory.
However, exposing the informations about each replication group could be useful in other contexts.
In my case, I am generating a few .env files and I need to include some Elasticache replication group primary endpoint and reader endpoint.
Since the elasticache_info plugin already exist and already retrieves the appropriate replication_group_id, I believe that this plugin should also retrieve the replication group description when it exists.
OTHER REMARKS CONCERNING THIS PULL REQUEST
Each provided description is copy/pasted from the official boto3 documentation which is distributed under an Apache 2.0 licence. I did it for consistency reason between and also because I am not a native speaker.
Also the provided description is incomplete : I only documented the fields that I was able to retrieve from my current AWS clusters.
Boto3 documentation of the "describe_replication_groups" function : https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/elasticache.html#ElastiCache.Client.describe_replication_groups
Moreover this pull request might violates the "integration tests" rule : I didn't find any integration test for the elasticache_info plugin and I don't know why no integration test have been made.