Boto3 elasticsearch #53745
Closed
Boto3 elasticsearch #53745
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
utils/boto3_elasticsearch.py: Contains custom waiter definitions that we will need to use until they get implemented in botocore (not present in 1.12.183). modules/boto3_elasticsearch.py: Contains all functions from boto3 that interact with AWS. Added a few helper functions. states/boto3_elasticsearch.py: Added states for the AWS ES service.
…enough. Renamed ESUpgradeFinished2 to ESUpgradeFinished instead. Renamed references to ESUpgradeFInished2 in the execution module.
|
@github-abcde, thanks for your PR! By analyzing the history of the files in this pull request, we identified @ryan-lane and @tkwilliams to be potential reviewers. |
…ded nontrivial CLI examples. Fixed broken CLI example.
…_check_return_value
ghost
requested a review
from 
|
Closing this since it has a PR to the |
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.
What does this PR do?
It adds a execution module, implemented with boto3 only, to interface with the AWS ElasticSearch service.
It adds a state to allow stateful interaction with said execution module.
It adds an elasticsearch-specific utils file with waiter definitions currently not present in botocore, allowing us to use boto3's waiter system to wait until a certain state has been achieved. When the waiters are eventually added to botocore, this file will no longer be required, though past experience (and the history of PRs for extra waiters for botocore) has taught me that this may take years.
!! Requires the following (currently not yet merged) PRs:
What issues does this PR fix or reference?
None that I know of.
Previous Behavior
The execution module
boto_elasticsearch_domainis implemented using a mix of boto2 and boto3 exists, which does not implement all API calls the AWS ES service has made available.The state module
boto_elasticsearch_domaindoes not use all parameters that can currently be used with the AWS ES service in itspresentandabsentfunctions.There is no support for tagging or version upgrades. (The
present-function does allow aTags-parameter but doesn't do anything with it).No blocking functionality is present to ensure that the requested resource are actually present after the
present-function returns. The same goes forabsent.New Behavior
The new state supplies
present,absent,upgraded,latestandtaggedfunctions. The new state requires certain module functions to be loaded (which implicitly requires botocore version 1.10.77).The
upgradedandlatestfunctions allow for managing the version (upgrading only) of Elasticsearch that is running on a targeted AWS ES domain.The new execution module is implemented using boto3 only, with
@depends-version checks per function in order to allow the module to work on multiple versions of boto3/botocore without any difficulties.The state- and (some, where applicable) execution module functions have
blockingarguments to allow blocking the return of the called function until the managed resource has the required state.All functions pertaining interaction with AWS ES listed in https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/es.html are present in the execution module.
Tests written?
Yes, unittests for the execution module have been written using Mock.
Commits signed with GPG?
Yes