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

Helper script for quickstart setup of Personalize plugin #177

Merged
merged 1 commit into from
Jul 24, 2023

Conversation

kulket
Copy link
Contributor

@kulket kulket commented Jul 21, 2023

Description:

Helper script is intended for quick start setup for OpenSearch. Script does following:

  • Build containers for both opensearch and opensearch dashboard
  • Picks up credentials from given profile or environment variable or default profile and stores them in opensearch keystore if available.
  • Gets both opensearch and opensearch dashboard up and running

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed as per the DCO using --signoff

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.

### Description:
Helper script is intended for quick start setup of OpenSearch.
Script does following:

* Build containers for both opensearch and opensearch dashboard
* Picks up credentials from given profile or environment variable or default profile and stores them in opensearch keystore if available.
* Gets both opensearch and opensearch dashboard up and running

Signed-off-by: Ketan Kulkarni <kektnr@amazon.com>
@codecov
Copy link

codecov bot commented Jul 21, 2023

Codecov Report

Merging #177 (e1751b2) into main (e6fe9ed) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##               main     #177   +/-   ##
=========================================
  Coverage     83.33%   83.33%           
  Complexity      333      333           
=========================================
  Files            42       42           
  Lines          1254     1254           
  Branches        153      153           
=========================================
  Hits           1045     1045           
  Misses          132      132           
  Partials         77       77           

@kulket kulket marked this pull request as ready for review July 21, 2023 09:15

# Some useful constants
readonly DOCKER_IMAGE_TAG="opensearch-with-personalized-search-ranking"
readonly OPENSEARCH_VERSION="2.9.0"
Copy link
Collaborator

Choose a reason for hiding this comment

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

if hard coded the version, in the following version upgrade, you will need to bump the version here, and also you are not able to run the script in main with 3.0.0.

Suggested to read the version number from the build.gradle file here

Copy link
Contributor Author

@kulket kulket Jul 21, 2023

Choose a reason for hiding this comment

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

After current release, I am actually planning to update OPENSEARCH_VERSION to use tag value latest instead of any specific version in order to always use latest publicly available version.

Since this script depends upon availability of container image I don't think havning future release value like 3.0.0 is feasible.

Please let me know if I am missing something as well as if it is ok to update tag value to latest as a follow up change once v 2.9.0 is released.

Copy link
Collaborator

Choose a reason for hiding this comment

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

sounds good.

@mingshl mingshl merged commit 83c8301 into opensearch-project:main Jul 24, 2023
16 checks passed
@mingshl mingshl added backport 2.9 backport 2.x Backport to 2.x branch labels Jul 24, 2023
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 24, 2023
### Description:
Helper script is intended for quick start setup of OpenSearch.
Script does following:

* Build containers for both opensearch and opensearch dashboard
* Picks up credentials from given profile or environment variable or default profile and stores them in opensearch keystore if available.
* Gets both opensearch and opensearch dashboard up and running

Signed-off-by: Ketan Kulkarni <kektnr@amazon.com>
(cherry picked from commit 83c8301)
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 24, 2023
### Description:
Helper script is intended for quick start setup of OpenSearch.
Script does following:

* Build containers for both opensearch and opensearch dashboard
* Picks up credentials from given profile or environment variable or default profile and stores them in opensearch keystore if available.
* Gets both opensearch and opensearch dashboard up and running

Signed-off-by: Ketan Kulkarni <kektnr@amazon.com>
(cherry picked from commit 83c8301)
mingshl pushed a commit that referenced this pull request Jul 24, 2023
### Description:
Helper script is intended for quick start setup of OpenSearch.
Script does following:

* Build containers for both opensearch and opensearch dashboard
* Picks up credentials from given profile or environment variable or default profile and stores them in opensearch keystore if available.
* Gets both opensearch and opensearch dashboard up and running

Signed-off-by: Ketan Kulkarni <kektnr@amazon.com>
(cherry picked from commit 83c8301)

Co-authored-by: kulket <130191298+kulket@users.noreply.github.com>
sejli pushed a commit that referenced this pull request Jul 25, 2023
### Description:
Helper script is intended for quick start setup of OpenSearch.
Script does following:

* Build containers for both opensearch and opensearch dashboard
* Picks up credentials from given profile or environment variable or default profile and stores them in opensearch keystore if available.
* Gets both opensearch and opensearch dashboard up and running

Signed-off-by: Ketan Kulkarni <kektnr@amazon.com>
(cherry picked from commit 83c8301)

Co-authored-by: kulket <130191298+kulket@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x Backport to 2.x branch backport 2.9
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants