-
Notifications
You must be signed in to change notification settings - Fork 27
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
Minor documentation updates #70
Minor documentation updates #70
Conversation
Signed-off-by: Mikayla Thompson <thomika@amazon.com>
- Adding more expectations to the knowledge base and corresponding test actions. There is a discussion in #68 regarding the format of expectations. Generally, the value of this project is directly correlated to the number and breadth of the expectations and tests, so this is a very important area of investment. | ||
- Expanding the functionality of the OpenSearchClientLibrary in `./upgrade_testing_framework/robot_lib`. This library contains code that makes various actions available to the robot framework (e.g. running specific api calls against the cluster). | ||
- These libraries are currently not distibuted in any way beyond this git repo. They could be packaged for PyPI and distributed as standalone tools. | ||
- Supporting alternate upgrade mechanisms in the `cluster_migration_core` library. Snapshot & restore is the only mechanism currently supported and it has limitations including being unable to do upgrades beyond version N+1. To simulate and test upgrades between more disparate versions, support needs to be added for either multi-step upgrades or different mechanisms. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add something like:
- Supporting additional version of Elasticsearch/OpenSearch. We currently have targeted ES 7.10.2->OS 1.3.6 and support that through the code. To add additional versions, some minor changes will likely be needed in
cluster_migration_core
andupgrade_testing_framework
(more conditional branches, maybe changes in some configuration syntax). Additionally, a new Test Config will need to be created and added to./test_configs
to encapsulate the new test type.
Signed-off-by: Mikayla Thompson <thomika@amazon.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. However, tests are failing (not the fault of this PR). @lewijacn will be posting a fix soon. Maybe we don't consider our UTF-wrapup task complete until that's pushed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, minor things noticed
upgrades/README.md
Outdated
#### Current State & Limitations | ||
|
||
The UTF is currently functional and runnable, but of limited utility. The following are areas where we expect to need to invest more time or investigation: | ||
- Adding more expectations to the knowledge base and corresponding test actions. There is a discussion in #68 regarding the format of expectations. Generally, the value of this project is directly correlated to the number and breadth of the expectations and tests, so this is a very important area of investment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: You may want to like the PR to #68, I thought this may happen automatically but when I looked on your branch it didn't link. Lmk if I'm wrong here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, that's what I was hoping would happen too. Thanks, I'll do a real link.
upgrades/README.md
Outdated
|
||
The UTF is currently functional and runnable, but of limited utility. The following are areas where we expect to need to invest more time or investigation: | ||
- Adding more expectations to the knowledge base and corresponding test actions. There is a discussion in #68 regarding the format of expectations. Generally, the value of this project is directly correlated to the number and breadth of the expectations and tests, so this is a very important area of investment. | ||
- Expanding the functionality of the OpenSearchClientLibrary in `./upgrade_testing_framework/robot_lib`. This library contains code that makes various actions available to the robot framework (e.g. running specific api calls against the cluster). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think OpenSearchClientLibrary got changed to OpenSearchRESTActions
Signed-off-by: Mikayla Thompson <thomika@amazon.com>
Signed-off-by: Mikayla Thompson <thomika@amazon.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Description
I'm adding minor updates to our documentation for the UTF & Knowledge Base to make them more accessible to incoming developers (for the latter) and include information on the current state of the project and known areas that need more development (for the former).
Signed-off-by: Mikayla Thompson thomika@amazon.com
Testing
[Please provide details of testing done: unit testing, integration testing and manual testing]
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.