Skip to content

Commit 0272b2b

Browse files
owaiskazi19owaiskazi19
committed
Initial Commit
Signed-off-by: Owais Kazi <[email protected]>
1 parent 58aa178 commit 0272b2b

39 files changed

+4216
-12
lines changed

‎.github/workflows/build.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Gradle Build
2+
on: [push, pull_request]
3+
4+
jobs:
5+
check:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- uses: actions/checkout@v3
9+
with:
10+
repository: opensearch-project/OpenSearch
11+
ref: feature/extensions
12+
- name: Publish to Maven Local
13+
run: |
14+
./gradlew publishToMavenLocal
15+
- uses: actions/checkout@v2
16+
- name: Set up JDK 11
17+
uses: actions/setup-java@v2
18+
with:
19+
java-version: 11
20+
distribution: adopt
21+
- name: Run Gradle Check
22+
run: |
23+
./gradlew check

‎.github/workflows/wrapper.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: Validate Gradle Wrapper
2+
on: [push, pull_request]
3+
4+
jobs:
5+
validate:
6+
name: Validate
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v2
10+
- uses: gradle/wrapper-validation-action@v1

‎.gitignore

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2+
# intellij files
3+
.idea/
4+
*.iml
5+
*.ipr
6+
*.iws
7+
*.log
8+
build-idea/
9+
out/
10+
11+
# gradle stuff
12+
.gradle/
13+
build/
14+
15+
bin/
16+
17+
# vscode stuff
18+
.vscode/
19+
20+
# osx stuff
21+
.DS_Store

‎CODE_OF_CONDUCT.md

+25
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,28 @@
22
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
33
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
44
[email protected] with any additional questions or comments.
5+
6+
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.
7+
8+
9+
**Our open source communities endeavor to:**
10+
11+
* Be Inclusive: We are committed to being a community where everyone can join and contribute. This means using inclusive and welcoming language.
12+
* Be Welcoming: We are committed to maintaining a safe space for everyone to be able to contribute.
13+
* 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.
14+
* 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.
15+
16+
17+
**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:**
18+
19+
* The use of violent threats, abusive, discriminatory, or derogatory language;
20+
* Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation;
21+
* Posting of sexually explicit or violent content;
22+
* The use of sexualized language and unwelcome sexual attention or advances;
23+
* Public or private harassment of any kind;
24+
* Publishing private information, such as physical or electronic address, without permission;
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting;
26+
* Advocating for or encouraging any of the above behaviors.
27+
* Enforcement and Reporting Code of Conduct Issues:
28+
29+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported. [Contact us](mailto:[email protected]). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.

‎DEVELOPER_GUIDE.md

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
2+
# OpenSearch SDK Developer Guide
3+
- [Introduction](#introduction)
4+
- [Getting Started](#getting-started)
5+
- [Git Clone IndependentPlugin Repo](#git-clone-independentplugin-repo)
6+
- [Run Independent Plugin](#run-independent-plugin)
7+
- [Run Tests](#run-tests)
8+
- [Send Message using Telnet](#send-message-using-telnet)
9+
10+
## Introduction
11+
Opensearch plugins have allowed the extension and ehancements of various core features however, current plugin architecture carries the risk of fatally impacting clusters should they fail. In order to ensure that plugins may run safely without impacting the system, our goal is to effectively isolate plugin interactions with OpenSearch by modularizing the [extension points](https://opensearch.org/blog/technical-post/2021/12/plugins-intro/) to which they hook onto.
12+
13+
Read more about extensibility [here](https://github.com/opensearch-project/OpenSearch/issues/1422)
14+
15+
## Getting Started
16+
17+
### Git Clone IndependentPlugin Repo
18+
Fork [IndependentPlugin](https://github.com/owaiskazi19/IndependentPlugin) and clone locally, e.g. `git clone https://github.com/[your username]/IndependentPlugin.git`.
19+
20+
### Run Independent Plugin
21+
22+
Run main script using `gradlew run`.
23+
24+
```
25+
./gradlew run
26+
```
27+
28+
This will execute the main script set within the root `build.gradle` file :
29+
30+
```
31+
mainClassName = 'transportservice.RunPlugin'
32+
```
33+
Bound addresses will then be logged to the terminal :
34+
35+
```bash
36+
[main] INFO transportservice.TransportService - publish_address {127.0.0.1:3333}, bound_addresses {[::1]:3333}, {127.0.0.1:3333}
37+
[main] INFO transportservice.TransportService - profile [test]: publish_address {127.0.0.1:5555}, bound_addresses {[::1]:5555}, {127.0.0.1:5555}
38+
```
39+
40+
### Run Tests
41+
42+
Run tests :
43+
```
44+
./gradlew clean build test
45+
```
46+
47+
### Send Message using Telnet
48+
49+
To send a message, first run the IndependentPlugin :
50+
51+
```
52+
./gradlew run
53+
```
54+
In another terminal, run :
55+
```
56+
telnet localhost 5555
57+
```
58+
Once Telnet Client is connected, the terminal will print out :
59+
```
60+
Trying 127.0.0.1...
61+
Connected to localhost.
62+
Escape character is '^]'.
63+
```
64+
The original terminal used to run the independent plugin will log the connection request :
65+
```
66+
[opensearch[NettySizeHeaderFrameDecoderTests][transport_worker][T#5]] TRACE transportservice.TcpTransport - Tcp transport channel accepted: Netty4TcpChannel{localAddress=/127.0.0.1:5555, remoteAddress=/127.0.0.1:57302}
67+
[opensearch[NettySizeHeaderFrameDecoderTests][transport_worker][T#5]] TRACE transportservice.netty4.OpenSearchLoggingHandler - [id: 0x8c1cc239, L:/127.0.0.1:5555 - R:/127.0.0.1:57302] REGISTERED
68+
[opensearch[NettySizeHeaderFrameDecoderTests][transport_worker][T#5]] TRACE transportservice.netty4.OpenSearchLoggingHandler - [id: 0x8c1cc239, L:/127.0.0.1:5555 - R:/127.0.0.1:57302] ACTIVE
69+
```
70+
Messages sent through the Telnet Client must begin with an 'ES', for example :
71+
```
72+
ES1234SHDDF
73+
```
74+
The original terminal will then log the recieved message if format is validated :
75+
```
76+
+-------------------------------------------------+
77+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
78+
+--------+-------------------------------------------------+----------------+
79+
|00000000| 45 53 31 32 33 34 53 48 44 44 46 0d 0a |ES1234SHDDF.. |
80+
+--------+-------------------------------------------------+----------------+
81+
MESSAGE RECEIVED:ES1234SHDDF
82+
83+
REFERENCE LENGTH 13 ES1234SHDDF
84+
```
85+
86+

‎NOTICE

+13
Original file line numberDiff line numberDiff line change
@@ -1 +1,14 @@
11
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
3+
OpenSearch (https://opensearch.org/)
4+
Copyright OpenSearch Contributors
5+
6+
This product includes software developed by
7+
Elasticsearch (http://www.elastic.co).
8+
Copyright 2009-2018 Elasticsearch
9+
10+
This product includes software developed by The Apache Software
11+
Foundation (http://www.apache.org/).
12+
13+
This product includes software developed by
14+
Joda.org (http://www.joda.org/).

‎README.md

+11-12
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
1-
## My Project
1+
# OpenSearch SDK
2+
- [Introduction](#introduction)
3+
- [Contributing](#contributing)
4+
- [Code of Conduct](#code-of-conduct)
25

3-
TODO: Fill this README out!
6+
## Introduction
7+
Opensearch plugins have allowed the extension and ehancements of various core features however, current plugin architecture carries the risk of fatally impacting clusters should they fail. In order to ensure that plugins may run safely without impacting the system, our goal is to effectively isolate plugin interactions with OpenSearch by modularizing the [extension points](https://opensearch.org/blog/technical-post/2021/12/plugins-intro/) to which they hook onto.
48

5-
Be sure to:
9+
Read more about extensibility [here](https://github.com/opensearch-project/OpenSearch/issues/1422)
610

7-
* Change the title in this README
8-
* Edit your repository description on GitHub
11+
## Contributing
12+
See [DEVELOPER_GUIDE](DEVELOPER_GUIDE.md)
913

10-
## Security
11-
12-
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
13-
14-
## License
15-
16-
This project is licensed under the Apache-2.0 License.
14+
## Code of Conduct
1715

16+
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 [[email protected]](mailto:[email protected]) with any additional questions or comments.

‎THIRD-PARTY-NOTICES

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
opensearch-sdk includes the following third-party software/licensing:
2+
3+
** OpenSearch - https://github.com/opensearch-project/OpenSearch
4+
5+
Apache License
6+
Version 2.0, January 2004
7+
http://www.apache.org/licenses/
8+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
9+
1. Definitions.
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
"Legal Entity" shall mean the union of the acting entity and all
15+
other entities that control, are controlled by, or are under common
16+
control with that entity. For the purposes of this definition,
17+
"control" means (i) the power, direct or indirect, to cause the
18+
direction or management of such entity, whether by contract or
19+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
20+
outstanding shares, or (iii) beneficial ownership of such entity.
21+
"You" (or "Your") shall mean an individual or Legal Entity
22+
exercising permissions granted by this License.
23+
"Source" form shall mean the preferred form for making modifications,
24+
including but not limited to software source code, documentation
25+
source, and configuration files.
26+
"Object" form shall mean any form resulting from mechanical
27+
transformation or translation of a Source form, including but
28+
not limited to compiled object code, generated documentation,
29+
and conversions to other media types.
30+
"Work" shall mean the work of authorship, whether in Source or
31+
Object form, made available under the License, as indicated by a
32+
copyright notice that is included in or attached to the work
33+
(an example is provided in the Appendix below).
34+
"Derivative Works" shall mean any work, whether in Source or Object
35+
form, that is based on (or derived from) the Work and for which the
36+
editorial revisions, annotations, elaborations, or other modifications
37+
represent, as a whole, an original work of authorship. For the purposes
38+
of this License, Derivative Works shall not include works that remain
39+
separable from, or merely link (or bind by name) to the interfaces of,
40+
the Work and Derivative Works thereof.
41+
"Contribution" shall mean any work of authorship, including
42+
the original version of the Work and any modifications or additions
43+
to that Work or Derivative Works thereof, that is intentionally
44+
submitted to Licensor for inclusion in the Work by the copyright owner
45+
or by an individual or Legal Entity authorized to submit on behalf of
46+
the copyright owner. For the purposes of this definition, "submitted"
47+
means any form of electronic, verbal, or written communication sent
48+
to the Licensor or its representatives, including but not limited to
49+
communication on electronic mailing lists, source code control systems,
50+
and issue tracking systems that are managed by, or on behalf of, the
51+
Licensor for the purpose of discussing and improving the Work, but
52+
excluding communication that is conspicuously marked or otherwise
53+
designated in writing by the copyright owner as "Not a Contribution."
54+
"Contributor" shall mean Licensor and any individual or Legal Entity
55+
on behalf of whom a Contribution has been received by Licensor and
56+
subsequently incorporated within the Work.
57+
2. Grant of Copyright License. Subject to the terms and conditions of
58+
this License, each Contributor hereby grants to You a perpetual,
59+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
60+
copyright license to reproduce, prepare Derivative Works of,
61+
publicly display, publicly perform, sublicense, and distribute the
62+
Work and such Derivative Works in Source or Object form.
63+
3. Grant of Patent License. Subject to the terms and conditions of
64+
this License, each Contributor hereby grants to You a perpetual,
65+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
66+
(except as stated in this section) patent license to make, have made,
67+
use, offer to sell, sell, import, and otherwise transfer the Work,
68+
where such license applies only to those patent claims licensable
69+
by such Contributor that are necessarily infringed by their
70+
Contribution(s) alone or by combination of their Contribution(s)
71+
with the Work to which such Contribution(s) was submitted. If You
72+
institute patent litigation against any entity (including a
73+
cross-claim or counterclaim in a lawsuit) alleging that the Work
74+
or a Contribution incorporated within the Work constitutes direct
75+
or contributory patent infringement, then any patent licenses
76+
granted to You under this License for that Work shall terminate
77+
as of the date such litigation is filed.
78+
4. Redistribution. You may reproduce and distribute copies of the
79+
Work or Derivative Works thereof in any medium, with or without
80+
modifications, and in Source or Object form, provided that You
81+
meet the following conditions:
82+
(a) You must give any other recipients of the Work or
83+
Derivative Works a copy of this License; and
84+
(b) You must cause any modified files to carry prominent notices
85+
stating that You changed the files; and
86+
(c) You must retain, in the Source form of any Derivative Works
87+
that You distribute, all copyright, patent, trademark, and
88+
attribution notices from the Source form of the Work,
89+
excluding those notices that do not pertain to any part of
90+
the Derivative Works; and
91+
(d) If the Work includes a "NOTICE" text file as part of its
92+
distribution, then any Derivative Works that You distribute must
93+
include a readable copy of the attribution notices contained
94+
within such NOTICE file, excluding those notices that do not
95+
pertain to any part of the Derivative Works, in at least one
96+
of the following places: within a NOTICE text file distributed
97+
as part of the Derivative Works; within the Source form or
98+
documentation, if provided along with the Derivative Works; or,
99+
within a display generated by the Derivative Works, if and
100+
wherever such third-party notices normally appear. The contents
101+
of the NOTICE file are for informational purposes only and
102+
do not modify the License. You may add Your own attribution
103+
notices within Derivative Works that You distribute, alongside
104+
or as an addendum to the NOTICE text from the Work, provided
105+
that such additional attribution notices cannot be construed
106+
as modifying the License.
107+
You may add Your own copyright statement to Your modifications and
108+
may provide additional or different license terms and conditions
109+
for use, reproduction, or distribution of Your modifications, or
110+
for any such Derivative Works as a whole, provided Your use,
111+
reproduction, and distribution of the Work otherwise complies with
112+
the conditions stated in this License.
113+
5. Submission of Contributions. Unless You explicitly state otherwise,
114+
any Contribution intentionally submitted for inclusion in the Work
115+
by You to the Licensor shall be under the terms and conditions of
116+
this License, without any additional terms or conditions.
117+
Notwithstanding the above, nothing herein shall supersede or modify
118+
the terms of any separate license agreement you may have executed
119+
with Licensor regarding such Contributions.
120+
6. Trademarks. This License does not grant permission to use the trade
121+
names, trademarks, service marks, or product names of the Licensor,
122+
except as required for reasonable and customary use in describing the
123+
origin of the Work and reproducing the content of the NOTICE file.
124+
7. Disclaimer of Warranty. Unless required by applicable law or
125+
agreed to in writing, Licensor provides the Work (and each
126+
Contributor provides its Contributions) on an "AS IS" BASIS,
127+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
128+
implied, including, without limitation, any warranties or conditions
129+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
130+
PARTICULAR PURPOSE. You are solely responsible for determining the
131+
appropriateness of using or redistributing the Work and assume any
132+
risks associated with Your exercise of permissions under this License.
133+
8. Limitation of Liability. In no event and under no legal theory,
134+
whether in tort (including negligence), contract, or otherwise,
135+
unless required by applicable law (such as deliberate and grossly
136+
negligent acts) or agreed to in writing, shall any Contributor be
137+
liable to You for damages, including any direct, indirect, special,
138+
incidental, or consequential damages of any character arising as a
139+
result of this License or out of the use or inability to use the
140+
Work (including but not limited to damages for loss of goodwill,
141+
work stoppage, computer failure or malfunction, or any and all
142+
other commercial damages or losses), even if such Contributor
143+
has been advised of the possibility of such damages.
144+
9. Accepting Warranty or Additional Liability. While redistributing
145+
the Work or Derivative Works thereof, You may choose to offer,
146+
and charge a fee for, acceptance of support, warranty, indemnity,
147+
or other liability obligations and/or rights consistent with this
148+
License. However, in accepting such obligations, You may act only
149+
on Your own behalf and on Your sole responsibility, not on behalf
150+
of any other Contributor, and only if You agree to indemnify,
151+
defend, and hold each Contributor harmless for any liability
152+
incurred by, or claims asserted against, such Contributor by reason
153+
of your accepting any such warranty or additional liability.
154+
END OF TERMS AND CONDITIONS
155+
156+
* For OpenSearch see also this required NOTICE:
157+
OpenSearch (https://opensearch.org/)
158+
Copyright OpenSearch Contributors
159+
This product includes software developed by
160+
Elasticsearch (http://www.elastic.co).
161+
Copyright 2009-2018 Elasticsearch
162+
This product includes software developed by The Apache Software
163+
Foundation (http://www.apache.org/).
164+
This product includes software developed by
165+
Joda.org (http://www.joda.org/).

0 commit comments

Comments
 (0)