diff --git a/.codecov.yml b/.codecov.yml
new file mode 100644
index 00000000..e711a04d
--- /dev/null
+++ b/.codecov.yml
@@ -0,0 +1,12 @@
+codecov:
+ require_ci_to_pass: yes
+
+coverage:
+ precision: 2
+ round: down
+ range: "75...100"
+ status:
+ project:
+ default:
+ target: 75% # the required coverage value
+ threshold: 1% # the leniency in hitting the target
\ No newline at end of file
diff --git a/.eclipseformat.xml b/.eclipseformat.xml
new file mode 100644
index 00000000..30b5bdcc
--- /dev/null
+++ b/.eclipseformat.xml
@@ -0,0 +1,362 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
new file mode 100644
index 00000000..2fefc428
--- /dev/null
+++ b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @b4sjoo @dhrubo-os @jngz-es @model-collapse @rbhavna @wujunshen @ylwu-amzn @zane-neo @Zhangxunmt @xinyual
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..29eddb95
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,31 @@
+---
+name: 🐛 Bug report
+about: Create a report to help us improve
+title: '[BUG]'
+labels: 'bug, untriaged'
+assignees: ''
+---
+
+**What is the bug?**
+A clear and concise description of the bug.
+
+**How can one reproduce the bug?**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**What is the expected behavior?**
+A clear and concise description of what you expected to happen.
+
+**What is your host/environment?**
+ - OS: [e.g. iOS]
+ - Version [e.g. 22]
+ - Plugins
+
+**Do you have any screenshots?**
+If applicable, add screenshots to help explain your problem.
+
+**Do you have any additional context?**
+Add any other context about the problem.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 00000000..a8199a10
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,7 @@
+contact_links:
+ - name: OpenSearch Community Support
+ url: https://discuss.opendistrocommunity.dev/
+ about: Please ask and answer questions here.
+ - name: AWS/Amazon Security
+ url: https://aws.amazon.com/security/vulnerability-reporting/
+ about: Please report security vulnerabilities here.
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000..6198f338
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,18 @@
+---
+name: 🎆 Feature request
+about: Request a feature in this project
+title: '[FEATURE]'
+labels: 'enhancement, untriaged'
+assignees: ''
+---
+**Is your feature request related to a problem?**
+A clear and concise description of what the problem is, e.g. _I'm always frustrated when [...]_
+
+**What solution would you like?**
+A clear and concise description of what you want to happen.
+
+**What alternatives have you considered?**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Do you have any additional context?**
+Add any other context or screenshots about the feature request here.
\ No newline at end of file
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..d7981b51
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,15 @@
+### Description
+[Describe what this change achieves]
+
+### Issues Resolved
+[List any issues this PR will resolve]
+
+### Check List
+- [ ] New functionality includes testing.
+ - [ ] All tests pass
+- [ ] New functionality has been documented.
+ - [ ] New functionality has javadoc added
+- [ ] Commits are signed 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](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).
diff --git a/.github/workflows/auto-release.yml b/.github/workflows/auto-release.yml
new file mode 100644
index 00000000..7e000b0d
--- /dev/null
+++ b/.github/workflows/auto-release.yml
@@ -0,0 +1,29 @@
+name: Releases
+
+on:
+ push:
+ tags:
+ - '*'
+
+jobs:
+
+ build:
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write
+ steps:
+ - name: GitHub App token
+ id: github_app_token
+ uses: tibdex/github-app-token@v1.5.0
+ with:
+ app_id: ${{ secrets.APP_ID }}
+ private_key: ${{ secrets.APP_PRIVATE_KEY }}
+ installation_id: 22958780
+ - name: Get tag
+ id: tag
+ uses: dawidd6/action-get-tag@v1
+ - uses: actions/checkout@v2
+ - uses: ncipollo/release-action@v1
+ with:
+ github_token: ${{ steps.github_app_token.outputs.token }}
+ bodyFile: release-notes/opensearch-agent-tools.release-notes-${{steps.tag.outputs.tag}}.md
diff --git a/.github/workflows/backport.yml b/.github/workflows/backport.yml
new file mode 100644
index 00000000..56fef507
--- /dev/null
+++ b/.github/workflows/backport.yml
@@ -0,0 +1,31 @@
+
+name: Backport
+on:
+ pull_request_target:
+ types:
+ - closed
+ - labeled
+
+jobs:
+ backport:
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write
+ pull-requests: write
+ name: Backport
+ steps:
+ - name: GitHub App token
+ id: github_app_token
+ uses: tibdex/github-app-token@v1.5.0
+ with:
+ app_id: ${{ secrets.APP_ID }}
+ private_key: ${{ secrets.APP_PRIVATE_KEY }}
+ installation_id: 22958780
+
+ - name: Backport
+ uses: VachaShah/backport@v2.2.0
+ with:
+ github_token: ${{ steps.github_app_token.outputs.token }}
+ branch_name: backport/backport-${{ github.event.number }}
+ labels_template: "<%= JSON.stringify([...labels, 'autocut']) %>"
+ failure_labels: "failed backport"
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
new file mode 100644
index 00000000..61524b5b
--- /dev/null
+++ b/.github/workflows/ci.yml
@@ -0,0 +1,84 @@
+name: Build and Test
+on:
+ push:
+ branches:
+ - "*"
+ pull_request:
+ branches:
+ - "*"
+
+jobs:
+ Get-CI-Image-Tag:
+ uses: opensearch-project/opensearch-build/.github/workflows/get-ci-image-tag.yml@main
+ with:
+ product: opensearch
+
+ build-linux:
+ needs: Get-CI-Image-Tag
+ strategy:
+ matrix:
+ java:
+ - 11
+ - 17
+ - 21
+ name: Build and Test
+ runs-on: ubuntu-latest
+ container:
+ # using the same image which is used by opensearch-build team to build the OpenSearch Distribution
+ # this image tag is subject to change as more dependencies and updates will arrive over time
+ image: ${{ needs.Get-CI-Image-Tag.outputs.ci-image-version-linux }}
+ # need to switch to root so that github actions can install runner binary on container without permission issues.
+ options: --user root
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+
+ - name: Setup Java ${{ matrix.java }}
+ uses: actions/setup-java@v1
+ with:
+ java-version: ${{ matrix.java }}
+
+ - name: Build and Test
+ run: |
+ chown -R 1000:1000 `pwd`
+ su `id -un 1000` -c "./gradlew build &&
+ ./gradlew publishToMavenLocal"
+
+ - name: Upload Coverage Report
+ uses: codecov/codecov-action@v1
+ with:
+ token: ${{ secrets.CODECOV_TOKEN }}
+
+ build-windows:
+ strategy:
+ matrix:
+ java:
+ - 11
+ - 17
+ - 21
+ name: Build and Test
+ runs-on: windows-latest
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+
+ - name: Setup Java ${{ matrix.java }}
+ uses: actions/setup-java@v1
+ with:
+ java-version: ${{ matrix.java }}
+
+ - name: Build and Test
+ run: |
+ ./gradlew build
+
+ - name: Publish to Maven Local
+ run: |
+ ./gradlew publishToMavenLocal
+
+ - name: Upload Coverage Report
+ uses: codecov/codecov-action@v1
+ with:
+ token: ${{ secrets.CODECOV_TOKEN }}
+
diff --git a/.github/workflows/delete_backport_branch.yml b/.github/workflows/delete_backport_branch.yml
new file mode 100644
index 00000000..f24f022b
--- /dev/null
+++ b/.github/workflows/delete_backport_branch.yml
@@ -0,0 +1,15 @@
+name: Delete merged branch of the backport PRs
+on:
+ pull_request:
+ types:
+ - closed
+
+jobs:
+ delete-branch:
+ runs-on: ubuntu-latest
+ if: startsWith(github.event.pull_request.head.ref,'backport/')
+ steps:
+ - name: Delete merged branch
+ uses: SvanBoxel/delete-merged-branch@main
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/maven-publish.yml b/.github/workflows/maven-publish.yml
new file mode 100644
index 00000000..9786fa52
--- /dev/null
+++ b/.github/workflows/maven-publish.yml
@@ -0,0 +1,37 @@
+name: Publish snapshots to maven
+
+on:
+ workflow_dispatch:
+ push:
+ branches:
+ - main
+ - '[0-9]+.[0-9]+'
+ - '[0-9]+.x'
+jobs:
+ build-and-publish-snapshots:
+ strategy:
+ fail-fast: false
+ if: github.repository == 'opensearch-project/agent-tools'
+ runs-on: ubuntu-latest
+
+ permissions:
+ id-token: write
+ contents: write
+
+ steps:
+ - uses: actions/setup-java@v3
+ with:
+ distribution: temurin # Temurin is a distribution of adoptium
+ java-version: 17
+ - uses: actions/checkout@v3
+ - uses: aws-actions/configure-aws-credentials@v1
+ with:
+ role-to-assume: ${{ secrets.PUBLISH_SNAPSHOTS_ROLE }}
+ aws-region: us-east-1
+ - name: publish snapshots to maven
+ run: |
+ export SONATYPE_USERNAME=$(aws secretsmanager get-secret-value --secret-id maven-snapshots-username --query SecretString --output text)
+ export SONATYPE_PASSWORD=$(aws secretsmanager get-secret-value --secret-id maven-snapshots-password --query SecretString --output text)
+ echo "::add-mask::$SONATYPE_USERNAME"
+ echo "::add-mask::$SONATYPE_PASSWORD"
+ ./gradlew publishShadowPublicationToSnapshotsRepository
diff --git a/.github/workflows/version.yml b/.github/workflows/version.yml
new file mode 100644
index 00000000..6c96199a
--- /dev/null
+++ b/.github/workflows/version.yml
@@ -0,0 +1,53 @@
+name: Increment Version
+
+on:
+ push:
+ tags:
+ - '*.*.*.*'
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - name: GitHub App token
+ id: github_app_token
+ uses: tibdex/github-app-token@v1.5.0
+ with:
+ app_id: ${{ secrets.APP_ID }}
+ private_key: ${{ secrets.APP_PRIVATE_KEY }}
+ installation_id: 22958780
+
+ - uses: actions/checkout@v2
+ - name: Fetch Tag and Version Information
+ run: |
+ TAG=$(echo "${GITHUB_REF#refs/*/}")
+ CURRENT_VERSION_ARRAY=($(echo "$TAG" | tr . '\n'))
+ BASE=$(IFS=. ; echo "${CURRENT_VERSION_ARRAY[*]:0:2}")
+ CURRENT_VERSION=$(IFS=. ; echo "${CURRENT_VERSION_ARRAY[*]:0:3}")
+ CURRENT_VERSION_ARRAY[2]=$((CURRENT_VERSION_ARRAY[2]+1))
+ NEXT_VERSION=$(IFS=. ; echo "${CURRENT_VERSION_ARRAY[*]:0:3}")
+ echo "TAG=$TAG" >> $GITHUB_ENV
+ echo "BASE=$BASE" >> $GITHUB_ENV
+ echo "CURRENT_VERSION=$CURRENT_VERSION" >> $GITHUB_ENV
+ echo "NEXT_VERSION=$NEXT_VERSION" >> $GITHUB_ENV
+ - uses: actions/checkout@v2
+ with:
+ ref: ${{ env.BASE }}
+ token: ${{ steps.github_app_token.outputs.token }}
+
+ - name: Increment Version
+ run: |
+ echo Incrementing $CURRENT_VERSION to $NEXT_VERSION
+ sed -i "s/$CURRENT_VERSION-SNAPSHOT/$NEXT_VERSION-SNAPSHOT/g" build.gradle
+
+ - name: Create Pull Request
+ uses: peter-evans/create-pull-request@v3
+ with:
+ token: ${{ steps.github_app_token.outputs.token }}
+ base: ${{ env.BASE }}
+ commit-message: Incremented version to ${{ env.NEXT_VERSION }}
+ signoff: true
+ delete-branch: true
+ title: '[AUTO] Incremented version to ${{ env.NEXT_VERSION }}.'
+ body: |
+ I've noticed that a new tag ${{ env.TAG }} was pushed, and incremented the version from ${{ env.CURRENT_VERSION }} to ${{ env.NEXT_VERSION }}.
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 00000000..722e14d1
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,13 @@
+buildSrc/libs
+.gradle/
+build/
+.idea/
+!.idea/codeStyles/codeStyleConfig.xml
+.DS_Store
+*.log
+out/
+.classpath
+.project
+.settings
+.vscode
+bin/
diff --git a/.whitesource b/.whitesource
new file mode 100644
index 00000000..db4b0fec
--- /dev/null
+++ b/.whitesource
@@ -0,0 +1,15 @@
+{
+ "scanSettings": {
+ "configMode": "AUTO",
+ "configExternalURL": "",
+ "projectToken": "",
+ "baseBranches": []
+ },
+ "checkRunSettings": {
+ "vulnerableCheckRunConclusionLevel": "failure",
+ "displayMode": "diff"
+ },
+ "issueSettings": {
+ "minSeverityLevel": "LOW"
+ }
+}
\ No newline at end of file
diff --git a/ADMINS.md b/ADMINS.md
new file mode 100644
index 00000000..81f320c5
--- /dev/null
+++ b/ADMINS.md
@@ -0,0 +1,7 @@
+## Admins
+
+| Admin | GitHub ID | Affiliation |
+| --------------- | --------------------------------------- | ----------- |
+| Henri Yandell | [hyandell](https://github.com/hyandell) | Amazon |
+
+[This document](https://github.com/opensearch-project/.github/blob/main/ADMINS.md) explains what admins do in this repo. and how they should be doing it. If you're interested in becoming a maintainer, see [MAINTAINERS](MAINTAINERS.md). If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md).
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index 5b627cfa..71291884 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -1,4 +1,22 @@
-## Code of Conduct
-This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
-For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
-opensource-codeofconduct@amazon.com with any additional questions or comments.
+This code of conduct applies to all spaces provided by the OpenSource project including in code, documentation, issue trackers, mailing lists, chat channels, wikis, blogs, social media and any other communication channels used by the project.
+
+**Our open source communities endeavor to:**
+
+* Be Inclusive: We are committed to being a community where everyone can join and contribute. This means using inclusive and welcoming language.
+* Be Welcoming: We are committed to maintaining a safe space for everyone to be able to contribute.
+* Be Respectful: We are committed to encouraging differing viewpoints, accepting constructive criticism and work collaboratively towards decisions that help the project grow. Disrespectful and unacceptable behavior will not be tolerated.
+* Be Collaborative: We are committed to supporting what is best for our community and users. When we build anything for the benefit of the project, we should document the work we do and communicate to others on how this affects their work.
+
+**Our Responsibility. As contributors, members, or bystanders we each individually have the responsibility to behave professionally and respectfully at all times. Disrespectful and unacceptable behaviors include, but are not limited to:**
+
+* The use of violent threats, abusive, discriminatory, or derogatory language;
+* Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation;
+* Posting of sexually explicit or violent content;
+* The use of sexualized language and unwelcome sexual attention or advances;
+* Public or private harassment of any kind;
+* Publishing private information, such as physical or electronic address, without permission;
+* Other conduct which could reasonably be considered inappropriate in a professional setting;
+* Advocating for or encouraging any of the above behaviors.
+* Enforcement and Reporting Code of Conduct Issues:
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported. [Contact us](mailto:opensource-codeofconduct@amazon.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c4b6a1c5..c25787ad 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,59 +1,51 @@
-# Contributing Guidelines
+## Contributing to this Project
-Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
-documentation, we greatly value feedback and contributions from our community.
+OpenSearch is a community project that is built and maintained by people just like **you**.
+[This document](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md) explains how you can contribute to this and related projects.
-Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
-information to effectively respond to your bug report or contribution.
+## Developer Certificate of Origin
+OpenSearch is an open source product released under the Apache 2.0 license (see either [the Apache site](https://www.apache.org/licenses/LICENSE-2.0) or the [LICENSE.txt file](LICENSE.txt)). The Apache 2.0 license allows you to freely use, modify, distribute, and sell your own products that include Apache 2.0 licensed software.
-## Reporting Bugs/Feature Requests
+We respect intellectual property rights of others and we want to make sure all incoming contributions are correctly attributed and licensed. A Developer Certificate of Origin (DCO) is a lightweight mechanism to do that.
-We welcome you to use the GitHub issue tracker to report bugs or suggest features.
+The DCO is a declaration attached to every contribution made by every developer. In the commit message of the contribution, the developer simply adds a `Signed-off-by` statement and thereby agrees to the DCO, which you can find below or at [DeveloperCertificate.org](http://developercertificate.org/).
-When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
-reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
+```
+Developer's Certificate of Origin 1.1
-* A reproducible test case or series of steps
-* The version of our code being used
-* Any modifications you've made relevant to the bug
-* Anything unusual about your environment or deployment
+By making a contribution to this project, I certify that:
+(a) The contribution was created in whole or in part by me and I
+ have the right to submit it under the open source license
+ indicated in the file; or
-## Contributing via Pull Requests
-Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
+(b) The contribution is based upon previous work that, to the
+ best of my knowledge, is covered under an appropriate open
+ source license and I have the right under that license to
+ submit that work with modifications, whether created in whole
+ or in part by me, under the same open source license (unless
+ I am permitted to submit under a different license), as
+ Indicated in the file; or
-1. You are working against the latest source on the *main* branch.
-2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
-3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
+(c) The contribution was provided directly to me by some other
+ person who certified (a), (b) or (c) and I have not modified
+ it.
-To send us a pull request, please:
+(d) I understand and agree that this project and the contribution
+ are public and that a record of the contribution (including
+ all personal information I submit with it, including my
+ sign-off) is maintained indefinitely and may be redistributed
+ consistent with this project or the open source license(s)
+ involved.
+ ```
-1. Fork the repository.
-2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
-3. Ensure local tests pass.
-4. Commit to your fork using clear commit messages.
-5. Send us a pull request, answering any default questions in the pull request interface.
-6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+We require that every contribution to OpenSearch is signed with a Developer Certificate of Origin. Additionally, please use your real name. We do not accept anonymous contributors nor those utilizing pseudonyms.
-GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
-[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
+Each commit must include a DCO which looks like this
+```
+Signed-off-by: Jane Smith
+```
-## Finding contributions to work on
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
-
-
-## Code of Conduct
-This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
-For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
-opensource-codeofconduct@amazon.com with any additional questions or comments.
-
-
-## Security issue notifications
-If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
-
-
-## Licensing
-
-See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+You may type this line on your own when writing your commit messages. However, if your user.name and user.email are set in your git configs, you can use `-s` or `– – signoff` to add the `Signed-off-by` line to the end of the commit message.
\ No newline at end of file
diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
new file mode 100644
index 00000000..d4a44c46
--- /dev/null
+++ b/DEVELOPER_GUIDE.md
@@ -0,0 +1,43 @@
+- [Developer Guide](#developer-guide)
+ - [Forking and Cloning](#forking-and-cloning)
+ - [Install Prerequisites](#install-prerequisites)
+ - [JDK 11](#jdk-11)
+ - [Building](#building)
+ - [Using IntelliJ IDEA](#using-intellij-idea)
+ - [Submitting Changes](#submitting-changes)
+
+## Developer Guide
+
+So you want to contribute code to this project? Excellent! We're glad you're here. Here's what you need to do.
+
+### Forking and Cloning
+
+Fork this repository on GitHub, and clone locally with `git clone`.
+
+### Install Prerequisites
+
+#### JDK 11
+
+OpenSearch components build using Java 11 at a minimum. This means you must have a JDK 11 installed with the environment variable `JAVA_HOME` referencing the path to Java home for your JDK 11 installation, e.g. `JAVA_HOME=/usr/lib/jvm/jdk-11`.
+
+### Building
+
+To build from the command line, use `./gradlew`.
+
+```
+./gradlew clean
+./gradlew build
+./gradlew publishToMavenLocal
+```
+
+### Using IntelliJ IDEA
+
+Launch Intellij IDEA, choose **Import Project**, and select the `settings.gradle` file in the root of this package.
+
+### Submitting Changes
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+### Backport
+
+- [Link to backport documentation](https://github.com/opensearch-project/opensearch-plugins/blob/main/BACKPORT.md)
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 00000000..67db8588
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,175 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
new file mode 100644
index 00000000..1ae14524
--- /dev/null
+++ b/MAINTAINERS.md
@@ -0,0 +1,16 @@
+## Maintainers
+
+| Maintainer | GitHub ID | Affiliation |
+|----------------------|----------------------------------------------------|-------------|
+| Bhavana Goud Ramaram | [rbhavna](https://github.com/rbhavna) | Amazon |
+| Charlie Yang | [model-collapse](https://github.com/model-collapse) | Amazon |
+| Dhrubo Saha | [dhrubo-os](https://github.com/dhrubo-os) | Amazon |
+| Jing Zhang | [jngz-es](https://github.com/jngz-es) | Amazon |
+| Junshen Wu | [wujunshen](https://github.com/wujunshen) | Amazon |
+| Sicheng Song | [b4sjoo](https://github.com/b4sjoo) | Amazon |
+| Xun Zhang | [Zhangxunmt](https://github.com/Zhangxunmt) | Amazon |
+| Yaliang Wu | [ylwu-amzn](https://github.com/ylwu-amzn) | Amazon |
+| Zan Niu | [zane-neo](https://github.com/zane-neo) | Amazon |
+| Xinyuan Lu | [xinyual](https://github.com/xinyual) | Amazon |
+
+[This document](https://github.com/opensearch-project/.github/blob/main/MAINTAINERS.md) explains what maintainers do in this repo, and how they should be doing it. If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md).
diff --git a/NOTICE b/NOTICE
index 616fc588..6c7dc983 100644
--- a/NOTICE
+++ b/NOTICE
@@ -1 +1,12 @@
-Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+OpenSearch (https://opensearch.org/)
+Copyright OpenSearch Contributors
+
+This product includes software developed by
+Elasticsearch (http://www.elastic.co).
+Copyright 2009-2018 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).
+
+This product includes software developed by
+Joda.org (http://www.joda.org/).
diff --git a/README.md b/README.md
index 847260ca..de18f9ea 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,41 @@
-## My Project
+[](https://codecov.io/gh/opensearch-project/skills)
-TODO: Fill this README out!
+
-Be sure to:
+- [OpenSearch skills](#opensearch-skills)
+- [Contributing](#contributing)
+- [Getting Help](#getting-help)
+- [Code of Conduct](#code-of-conduct)
+- [Security](#security)
+- [License](#license)
+- [Copyright](#copyright)
-* Change the title in this README
-* Edit your repository description on GitHub
+## OpenSearch skills
+
+OpenSearch skills is focused on providing tools for ml-common's agent framework [OpenSearch ml-commons](https://github.com/opensearch-project/ml-commons).
+
+## Contributing
+
+See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project](CONTRIBUTING.md).
+
+## Getting Help
+
+If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository.
+
+For more information, see [project website](https://opensearch.org/) and [documentation](https://docs-beta.opensearch.org/). If you need help and are unsure where to open an issue, try [forums](https://discuss.opendistrocommunity.dev/).
+
+## Code of Conduct
+
+This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) with any additional questions or comments.
## Security
-See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue.
## License
-This project is licensed under the Apache-2.0 License.
+This project is licensed under the [Apache v2.0 License](LICENSE.txt).
+
+## Copyright
+Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details.
diff --git a/RELEASING.md b/RELEASING.md
new file mode 100644
index 00000000..6903e716
--- /dev/null
+++ b/RELEASING.md
@@ -0,0 +1 @@
+This project follows the [OpenSearch release process](https://github.com/opensearch-project/.github/blob/main/RELEASING.md).
\ No newline at end of file
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 00000000..0b85ca04
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,3 @@
+## Reporting a Vulnerability
+
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/) or directly via email to aws-security@amazon.com. Please do **not** create a public GitHub issue.
\ No newline at end of file
diff --git a/build-tools/opensearchplugin-coverage.gradle b/build-tools/opensearchplugin-coverage.gradle
new file mode 100644
index 00000000..b5b176a3
--- /dev/null
+++ b/build-tools/opensearchplugin-coverage.gradle
@@ -0,0 +1,49 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * OpenSearch Plugin build tools don't work with the Gradle Jacoco Plugin to report coverage out of the box.
+ * https://github.com/elastic/elasticsearch/issues/28867.
+ *
+ * This code sets up coverage reporting manually for OpenSearch plugin tests. This is complicated because:
+ * 1. The OpenSearch integTest Task doesn't implement Gradle's JavaForkOptions so we have to manually start the jacoco agent with the test JVM
+ * 2. The cluster nodes are stopped using 'kill -9' which means jacoco can't dump it's execution output to a file on VM shutdown
+ * 3. The Java Security Manager prevents JMX from writing execution output to the file.
+ *
+ * To workaround these we start the cluster with jmx enabled and then use Jacoco's JMX MBean to get the execution data before the
+ * cluster is stopped and dump it to a file. Luckily our current security policy seems to allow this. This will also probably
+ * break if there are multiple nodes in the integTestCluster. But for now... it sorta works.
+ */
+apply plugin: 'jacoco'
+
+// Get gradle to generate the required jvm agent arg for us using a dummy tasks of type Test. Unfortunately Elastic's
+// testing tasks don't derive from Test so the jacoco plugin can't do this automatically.
+def jacocoDir = "${buildDir}/jacoco"
+task dummyTest(type: Test) {
+ enabled = false
+ workingDir = file("/") // Force absolute path to jacoco agent jar
+ jacoco {
+ destinationFile = file("${jacocoDir}/test.exec")
+ destinationFile.parentFile.mkdirs()
+ jmx = true
+ }
+}
+
+jacocoTestReport {
+ dependsOn test
+ executionData dummyTest.jacoco.destinationFile
+ getSourceDirectories().from(sourceSets.main.allSource)
+ getClassDirectories().from(sourceSets.main.output)
+ reports {
+ html.required = true // human readable
+ xml.required = true // for coverlay
+ }
+}
+
+project.gradle.projectsEvaluated {
+ jacocoTestReport.dependsOn test
+}
+
+check.dependsOn jacocoTestReport
diff --git a/build.gradle b/build.gradle
new file mode 100644
index 00000000..55aa878a
--- /dev/null
+++ b/build.gradle
@@ -0,0 +1,194 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+buildscript {
+ ext {
+ opensearch_group = "org.opensearch"
+ opensearch_version = System.getProperty("opensearch.version", "2.11.0-SNAPSHOT")
+ isSnapshot = "true" == System.getProperty("build.snapshot", "true")
+ buildVersionQualifier = System.getProperty("build.version_qualifier", "")
+ }
+
+ repositories {
+ mavenLocal()
+ mavenCentral()
+ maven { url "https://plugins.gradle.org/m2/" }
+ maven { url "https://aws.oss.sonatype.org/content/repositories/snapshots" }
+ }
+
+ dependencies {
+ classpath "${opensearch_group}.gradle:build-tools:${opensearch_version}"
+ }
+}
+
+plugins {
+ id 'java-library'
+ id 'com.diffplug.spotless' version '6.22.0'
+ id "io.freefair.lombok" version "8.0.1"
+}
+
+repositories {
+ mavenLocal()
+ mavenCentral()
+ maven { url "https://plugins.gradle.org/m2/" }
+ maven { url "https://aws.oss.sonatype.org/content/repositories/snapshots" }
+}
+
+allprojects {
+ group 'org.opensearch.plugin'
+ version = opensearch_version.tokenize('-')[0] + '.0'
+ if (buildVersionQualifier) {
+ version += "-${buildVersionQualifier}"
+ }
+ if (isSnapshot) {
+ version += "-SNAPSHOT"
+ }
+}
+
+targetCompatibility = JavaVersion.VERSION_11
+sourceCompatibility = JavaVersion.VERSION_11
+
+apply plugin: 'java'
+apply plugin: 'jacoco'
+apply plugin: 'idea'
+apply plugin: 'signing'
+apply plugin: 'maven-publish'
+apply plugin: 'opensearch.repositories'
+apply from: 'build-tools/opensearchplugin-coverage.gradle'
+apply plugin: 'opensearch.opensearchplugin'
+apply plugin: 'opensearch.testclusters'
+apply plugin: 'opensearch.pluginzip'
+
+
+configurations {
+ zipArchive
+ all {
+ resolutionStrategy.force "org.mockito:mockito-core:5.5.0"
+ }
+}
+
+def sqlJarDirectory = "$buildDir/dependencies/opensearch-sql-plugin"
+
+dependencies {
+ compileOnly group: 'org.opensearch', name:'opensearch-ml-client', version: "${version}"
+ compileOnly group: 'com.google.code.gson', name: 'gson', version: '2.10.1'
+ testImplementation "org.opensearch.test:framework:${opensearch_version}"
+ testImplementation "org.mockito:mockito-core:3.10.0"
+ testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.2'
+ testImplementation 'org.mockito:mockito-junit-jupiter:3.10.0'
+ testImplementation "com.nhaarman.mockitokotlin2:mockito-kotlin:2.2.0"
+ testImplementation "com.cronutils:cron-utils:9.1.6"
+ testImplementation "commons-validator:commons-validator:1.7"
+ testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.2'
+ compileOnly "org.apache.logging.log4j:log4j-slf4j-impl:2.19.0"
+ compileOnly group: 'org.json', name: 'json', version: '20230227'
+ zipArchive group: 'org.opensearch.plugin', name:'opensearch-sql-plugin', version: "${version}"
+ implementation fileTree(dir: sqlJarDirectory, include: ["opensearch-sql-${version}.jar", "ppl-${version}.jar", "protocol-${version}.jar"])
+}
+
+task extractSqlJar(type: Copy) {
+ mustRunAfter()
+ from(zipTree(configurations.zipArchive.find { it.name.startsWith("opensearch-sql-plugin")}))
+ into sqlJarDirectory
+}
+
+project.tasks.delombok.dependsOn(extractSqlJar)
+tasks.publishNebulaPublicationToMavenLocal.dependsOn ':generatePomFileForPluginZipPublication'
+tasks.validateNebulaPom.dependsOn ':generatePomFileForPluginZipPublication'
+
+dependencyLicenses.enabled = false
+loggerUsageCheck.enabled = false
+testingConventions.enabled = false
+
+test {
+ useJUnitPlatform()
+ testLogging {
+ exceptionFormat "full"
+ events "skipped", "passed", "failed" // "started"
+ showStandardStreams true
+ }
+}
+
+spotless {
+ java {
+ removeUnusedImports()
+ importOrder 'java', 'javax', 'org', 'com'
+ licenseHeaderFile 'spotless.license.java'
+
+ eclipse().configFile rootProject.file('.eclipseformat.xml')
+ }
+}
+
+compileJava {
+ dependsOn extractSqlJar
+ dependsOn delombok
+ options.compilerArgs.addAll(["-processor", 'lombok.launch.AnnotationProcessorHider$AnnotationProcessor'])
+}
+
+compileTestJava {
+ options.compilerArgs.addAll(["-processor", 'lombok.launch.AnnotationProcessorHider$AnnotationProcessor'])
+}
+
+
+opensearchplugin {
+ name 'agent-tools'
+ description 'OpenSearch Agent Tools'
+ classname 'org.opensearch.agent_tool.ToolPlugin'
+ extendedPlugins = ['opensearch-ml']
+ licenseFile rootProject.file("LICENSE.txt")
+ noticeFile rootProject.file("NOTICE")
+}
+
+publishing {
+ repositories {
+ maven {
+ name = 'staging'
+ url = "${rootProject.buildDir}/local-staging-repo"
+ }
+ maven {
+ name = "Snapshots"
+ url = "https://aws.oss.sonatype.org/content/repositories/snapshots"
+ credentials {
+ username "$System.env.SONATYPE_USERNAME"
+ password "$System.env.SONATYPE_PASSWORD"
+ }
+ }
+ }
+ publications {
+ pluginZip(MavenPublication) { publication ->
+ pom {
+ name = "OpenSearch Agent Tools"
+ description = "OpenSearch Agent Tools"
+ groupId = "org.opensearch.plugin"
+ licenses {
+ license {
+ name = "The Apache License, Version 2.0"
+ url = "http://www.apache.org/licenses/LICENSE-2.0.txt"
+ }
+ }
+ developers {
+ developer {
+ name = "OpenSearch"
+ url = "https://github.com/opensearch-project/agent-tools"
+ }
+ }
+ }
+ }
+ }
+ gradle.startParameter.setShowStacktrace(ShowStacktrace.ALWAYS)
+ gradle.startParameter.setLogLevel(LogLevel.DEBUG)
+}
+
+// updateVersion: Task to auto increment to the next development iteration
+task updateVersion {
+ onlyIf { System.getProperty('newVersion') }
+ doLast {
+ ext.newVersion = System.getProperty('newVersion')
+ println "Setting version to ${newVersion}."
+ // String tokenization to support -SNAPSHOT
+ // Include the required files that needs to be updated with new Version
+ ant.replaceregexp(file:'build.gradle', match: '"opensearch.version", "\\d.*"', replace: '"opensearch.version", "' + newVersion.tokenize('-')[0] + '-SNAPSHOT"', flags:'g', byline:true)
+ }
+}
diff --git a/detekt.yml b/detekt.yml
new file mode 100644
index 00000000..5d1d194d
--- /dev/null
+++ b/detekt.yml
@@ -0,0 +1,54 @@
+---
+#
+# Copyright OpenSearch Contributors
+# SPDX-License-Identifier: Apache-2.0
+#
+
+style:
+ ForbiddenComment:
+ active: false
+ LoopWithTooManyJumpStatements:
+ maxJumpCount: 4
+ MaxLineLength:
+ maxLineLength: 200
+ ThrowsCount:
+ active: true
+ max: 10
+ ReturnCount:
+ active: true
+ max: 10
+ UtilityClassWithPublicConstructor:
+ active: false
+
+empty-blocks:
+ EmptyCatchBlock:
+ excludes: ['**/test/**']
+
+exceptions:
+ SwallowedException:
+ excludes: ['**/test/**']
+ ignoredExceptionTypes:
+ - 'ZoneRulesException'
+ - 'DateTimeException'
+
+complexity:
+ LargeClass:
+ excludes: ['**/test/**']
+ LongMethod:
+ excludes: ['**/test/**']
+ threshold: 110
+ LongParameterList:
+ excludes: ['**/test/**']
+ constructorThreshold: 8
+ ComplexMethod:
+ threshold: 27
+ NestedBlockDepth:
+ threshold: 10
+
+naming:
+ ObjectPropertyNaming:
+ constantPattern: '[_A-Za-z][_A-Za-z0-9]*'
+
+performance:
+ SpreadOperator:
+ active: false
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
new file mode 100644
index 00000000..7f93135c
Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
new file mode 100644
index 00000000..3999f7f3
--- /dev/null
+++ b/gradle/wrapper/gradle-wrapper.properties
@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
+networkTimeout=10000
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+distributionSha256Sum=3e1af3ae886920c3ac87f7a91f816c0c7c436f276a6eefdb3da152100fef72ae
diff --git a/gradlew b/gradlew
new file mode 100755
index 00000000..1aa94a42
--- /dev/null
+++ b/gradlew
@@ -0,0 +1,249 @@
+#!/bin/sh
+
+#
+# Copyright © 2015-2021 the original authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+#
+# Gradle start up script for POSIX generated by Gradle.
+#
+# Important for running:
+#
+# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+# noncompliant, but you have some other compliant shell such as ksh or
+# bash, then to run this script, type that shell name before the whole
+# command line, like:
+#
+# ksh Gradle
+#
+# Busybox and similar reduced shells will NOT work, because this script
+# requires all of these POSIX shell features:
+# * functions;
+# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+# * compound commands having a testable exit status, especially «case»;
+# * various built-in commands including «command», «set», and «ulimit».
+#
+# Important for patching:
+#
+# (2) This script targets any POSIX shell, so it avoids extensions provided
+# by Bash, Ksh, etc; in particular arrays are avoided.
+#
+# The "traditional" practice of packing multiple parameters into a
+# space-separated string is a well documented source of bugs and security
+# problems, so this is (mostly) avoided, by progressively accumulating
+# options in "$@", and eventually passing that to Java.
+#
+# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
+# see the in-line comments for details.
+#
+# There are tweaks for specific operating systems such as AIX, CygWin,
+# Darwin, MinGW, and NonStop.
+#
+# (3) This script is generated from the Groovy template
+# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+# within the Gradle project.
+#
+# You can find Gradle at https://github.com/gradle/gradle/.
+#
+##############################################################################
+
+# Attempt to set APP_HOME
+
+# Resolve links: $0 may be a link
+app_path=$0
+
+# Need this for daisy-chained symlinks.
+while
+ APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
+ [ -h "$app_path" ]
+do
+ ls=$( ls -ld "$app_path" )
+ link=${ls#*' -> '}
+ case $link in #(
+ /*) app_path=$link ;; #(
+ *) app_path=$APP_HOME$link ;;
+ esac
+done
+
+# This is normally unused
+# shellcheck disable=SC2034
+APP_BASE_NAME=${0##*/}
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD=maximum
+
+warn () {
+ echo "$*"
+} >&2
+
+die () {
+ echo
+ echo "$*"
+ echo
+ exit 1
+} >&2
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "$( uname )" in #(
+ CYGWIN* ) cygwin=true ;; #(
+ Darwin* ) darwin=true ;; #(
+ MSYS* | MINGW* ) msys=true ;; #(
+ NONSTOP* ) nonstop=true ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+ if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+ # IBM's JDK on AIX uses strange locations for the executables
+ JAVACMD=$JAVA_HOME/jre/sh/java
+ else
+ JAVACMD=$JAVA_HOME/bin/java
+ fi
+ if [ ! -x "$JAVACMD" ] ; then
+ die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+ fi
+else
+ JAVACMD=java
+ if ! command -v java >/dev/null 2>&1
+ then
+ die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+ fi
+fi
+
+# Increase the maximum file descriptors if we can.
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+ case $MAX_FD in #(
+ max*)
+ # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+ # shellcheck disable=SC2039,SC3045
+ MAX_FD=$( ulimit -H -n ) ||
+ warn "Could not query maximum file descriptor limit"
+ esac
+ case $MAX_FD in #(
+ '' | soft) :;; #(
+ *)
+ # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+ # shellcheck disable=SC2039,SC3045
+ ulimit -n "$MAX_FD" ||
+ warn "Could not set maximum file descriptor limit to $MAX_FD"
+ esac
+fi
+
+# Collect all arguments for the java command, stacking in reverse order:
+# * args from the command line
+# * the main class name
+# * -classpath
+# * -D...appname settings
+# * --module-path (only if needed)
+# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "$cygwin" || "$msys" ; then
+ APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+ CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
+
+ JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+ # Now convert the arguments - kludge to limit ourselves to /bin/sh
+ for arg do
+ if
+ case $arg in #(
+ -*) false ;; # don't mess with options #(
+ /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
+ [ -e "$t" ] ;; #(
+ *) false ;;
+ esac
+ then
+ arg=$( cygpath --path --ignore --mixed "$arg" )
+ fi
+ # Roll the args list around exactly as many times as the number of
+ # args, so each arg winds up back in the position where it started, but
+ # possibly modified.
+ #
+ # NB: a `for` loop captures its iteration list before it begins, so
+ # changing the positional parameters here affects neither the number of
+ # iterations, nor the values presented in `arg`.
+ shift # remove old arg
+ set -- "$@" "$arg" # push replacement arg
+ done
+fi
+
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+# and any embedded shellness will be escaped.
+# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+# treated as '${Hostname}' itself on the command line.
+
+set -- \
+ "-Dorg.gradle.appname=$APP_BASE_NAME" \
+ -classpath "$CLASSPATH" \
+ org.gradle.wrapper.GradleWrapperMain \
+ "$@"
+
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+ die "xargs is not available"
+fi
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
+# set -- "${ARGS[@]}" "$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- $(
+ printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
+ xargs -n1 |
+ sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+ tr '\n' ' '
+ )" '"$@"'
+
+exec "$JAVACMD" "$@"
diff --git a/gradlew.bat b/gradlew.bat
new file mode 100644
index 00000000..6689b85b
--- /dev/null
+++ b/gradlew.bat
@@ -0,0 +1,92 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
+@if "%DEBUG%"=="" @echo off
+@rem ##########################################################################
+@rem
+@rem Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if %ERRORLEVEL% equ 0 goto execute
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if %ERRORLEVEL% equ 0 goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega
diff --git a/lombok.config b/lombok.config
new file mode 100644
index 00000000..189c0bef
--- /dev/null
+++ b/lombok.config
@@ -0,0 +1,3 @@
+# This file is generated by the 'io.freefair.lombok' Gradle plugin
+config.stopBubbling = true
+lombok.addLombokGeneratedAnnotation = true
diff --git a/release-notes/create_release_notes.py b/release-notes/create_release_notes.py
new file mode 100644
index 00000000..425ddcc6
--- /dev/null
+++ b/release-notes/create_release_notes.py
@@ -0,0 +1,40 @@
+# raw note means the draft release content copied down which is generated by Github workflow
+# this script helps add the URLs to all PR and have the right release note filename
+
+import os
+import sys
+import fileinput
+import re
+
+link_prefix = "https://github.com/opensearch-project/agent-tools/pull/"
+searchExp = re.compile("([\(\[]).*?([\)\]])")
+
+current_date = raw_input("what day is today (e.g. 2020-06-29): ")
+file_path = raw_input("Path to raw note file (e.g., note.md): ")
+plugin_name = "agent-tools"
+plugin_version = raw_input('Plugin version (x.x.x.x): ')
+
+app = 'OpenSearch'
+
+app_version = raw_input(app + ' compatibility version (x.x.x): ')
+
+for line in fileinput.input(file_path, inplace=True):
+ # Add title and OpenSearch/OpenSearchDashboards compatibility
+ if fileinput.isfirstline():
+ line = "## Version " + plugin_version + " " + current_date + "\n\n" \
+ "Compatible with " + app + " " + app_version + "\n"
+
+ # Add link to PRs
+ if '*' in line:
+ start = line.find('#') + 1
+ end = line.find(')', start)
+ pr_num = line[start:end]
+ line = re.sub(searchExp, "([#" + pr_num +
+ "](" + link_prefix + pr_num + "))", line)
+ sys.stdout.write(line)
+
+new_file_path = "opensearch-" + plugin_name + ".release-notes-" + \
+ plugin_version + ".md"
+os.rename(file_path, new_file_path)
+
+print('\n\nDone!\n')
diff --git a/scripts/build.sh b/scripts/build.sh
new file mode 100755
index 00000000..e0495d4a
--- /dev/null
+++ b/scripts/build.sh
@@ -0,0 +1,71 @@
+#!/bin/bash
+
+# Copyright OpenSearch Contributors.
+# SPDX-License-Identifier: Apache-2.0
+
+set -ex
+
+function usage() {
+ echo "Usage: $0 [args]"
+ echo ""
+ echo "Arguments:"
+ echo -e "-v VERSION\t[Required] OpenSearch version."
+ echo -e "-q QUALIFIER\t[Optional] Version qualifier."
+ echo -e "-s SNAPSHOT\t[Optional] Build a snapshot, default is 'false'."
+ echo -e "-p PLATFORM\t[Optional] Platform, ignored."
+ echo -e "-a ARCHITECTURE\t[Optional] Build architecture, ignored."
+ echo -e "-o OUTPUT\t[Optional] Output path, default is 'artifacts'."
+ echo -e "-h help"
+}
+
+while getopts ":h:v:q:s:o:p:a:" arg; do
+ case $arg in
+ h)
+ usage
+ exit 1
+ ;;
+ v)
+ VERSION=$OPTARG
+ ;;
+ q)
+ QUALIFIER=$OPTARG
+ ;;
+ s)
+ SNAPSHOT=$OPTARG
+ ;;
+ o)
+ OUTPUT=$OPTARG
+ ;;
+ p)
+ PLATFORM=$OPTARG
+ ;;
+ a)
+ ARCHITECTURE=$OPTARG
+ ;;
+ :)
+ echo "Error: -${OPTARG} requires an argument"
+ usage
+ exit 1
+ ;;
+ ?)
+ echo "Invalid option: -${arg}"
+ exit 1
+ ;;
+ esac
+done
+
+if [ -z "$VERSION" ]; then
+ echo "Error: You must specify the OpenSearch version"
+ usage
+ exit 1
+fi
+
+[[ ! -z "$QUALIFIER" ]] && VERSION=$VERSION-$QUALIFIER
+[[ "$SNAPSHOT" == "true" ]] && VERSION=$VERSION-SNAPSHOT
+[ -z "$OUTPUT" ] && OUTPUT=artifacts
+
+./gradlew build -x test -Dopensearch.version=$VERSION -Dbuild.snapshot=$SNAPSHOT -Dbuild.version_qualifier=$QUALIFIER
+./gradlew publishShadowPublicationToMavenLocal -Dopensearch.version=$VERSION -Dbuild.snapshot=$SNAPSHOT -Dbuild.version_qualifier=$QUALIFIER
+./gradlew publishShadowPublicationToStagingRepository -Dopensearch.version=$VERSION -Dbuild.snapshot=$SNAPSHOT -Dbuild.version_qualifier=$QUALIFIER
+mkdir -p $OUTPUT/maven/org/opensearch
+cp -r ./build/local-staging-repo/org/opensearch/. $OUTPUT/maven/org/opensearch
diff --git a/settings.gradle b/settings.gradle
new file mode 100644
index 00000000..26eac06a
--- /dev/null
+++ b/settings.gradle
@@ -0,0 +1,6 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+rootProject.name = 'agent-tools'
diff --git a/spotless.license.java b/spotless.license.java
new file mode 100644
index 00000000..9e182dcd
--- /dev/null
+++ b/spotless.license.java
@@ -0,0 +1,5 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
diff --git a/src/main/java/org/opensearch/agent/ToolPlugin.java b/src/main/java/org/opensearch/agent/ToolPlugin.java
new file mode 100644
index 00000000..eba2f6a1
--- /dev/null
+++ b/src/main/java/org/opensearch/agent/ToolPlugin.java
@@ -0,0 +1,64 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package org.opensearch.agent;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+import java.util.function.Supplier;
+
+import org.opensearch.agent.tools.PPLTool;
+import org.opensearch.client.Client;
+import org.opensearch.cluster.metadata.IndexNameExpressionResolver;
+import org.opensearch.cluster.service.ClusterService;
+import org.opensearch.core.common.io.stream.NamedWriteableRegistry;
+import org.opensearch.core.xcontent.NamedXContentRegistry;
+import org.opensearch.env.Environment;
+import org.opensearch.env.NodeEnvironment;
+import org.opensearch.ml.common.spi.MLCommonsExtension;
+import org.opensearch.ml.common.spi.tools.Tool;
+import org.opensearch.plugins.Plugin;
+import org.opensearch.repositories.RepositoriesService;
+import org.opensearch.script.ScriptService;
+import org.opensearch.threadpool.ThreadPool;
+import org.opensearch.watcher.ResourceWatcherService;
+
+import lombok.SneakyThrows;
+
+public class ToolPlugin extends Plugin implements MLCommonsExtension {
+
+ private Client client;
+ private ClusterService clusterService;
+ private NamedXContentRegistry xContentRegistry;
+
+ @SneakyThrows
+ @Override
+ public Collection