Skip to content

Commit

Permalink
OpenSearch fork changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@sruti1312 @kkhatua
sruti1312 authored and kkhatua committed Apr 16, 2021
1 parent 26e6fae commit 110445b
Show file tree
Hide file tree
Showing 1,512 changed files with 88,723 additions and 84,441 deletions.
44 changes: 16 additions & 28 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Original file line number Diff line number Diff line change
@@ -1,33 +1,21 @@
*Fixes #:*
**Is your feature request related to a problem? Please provide an existing Issue # , or describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

*Description of changes:*
**Describe the solution you are proposing**
A clear and concise description of what you want to happen.

*Tests:*
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

*If new tests are added, how long do the new ones take to complete*
**Additional context**
Add any other context or screenshots about the feature request here.

Developer's Certificate of Origin 1.1
### 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 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

(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

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(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.
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/performance-analyzer-rca/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).
33 changes: 33 additions & 0 deletions .github/bug_template.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: 🐛 Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: bug
assignees: ''
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Plugins**
Please list all plugins currently enabled.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Host/Environment (please complete the following information):**
- OS: [e.g. iOS]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
19 changes: 19 additions & 0 deletions .github/feature_request_template.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: 🎆 Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
6 changes: 2 additions & 4 deletions .github/workflows/gradle.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,10 @@ on:
push:
branches:
- main
- dev

pull_request:
branches:
- main
- dev

jobs:
build_rca_pkg:
Expand All @@ -27,7 +25,7 @@ jobs:
- name: Checkout Performance Analyzer package
uses: actions/checkout@v2
with:
repository: opendistro-for-elasticsearch/performance-analyzer
repository: opensearch-project/performance-analyzer
path: ./tmp/pa
- name: Set up JDK 1.12
uses: actions/setup-java@v1
Expand Down Expand Up @@ -60,7 +58,7 @@ jobs:
run: ./gradlew updateShas
- name: Set docker-compose path
run: DOCKER_COMPOSE_LOCATION=$(which docker-compose)
# Set the vm.max_map_count system property to the minimum required to run Elasticsearch
# Set the vm.max_map_count system property to the minimum required to run OpenSearch
- name: Set vm.max_map_count
run: sudo sysctl -w vm.max_map_count=262144
- name: Build PA and run Unit Tests
Expand Down
30 changes: 26 additions & 4 deletions CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,26 @@
## 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.

In the event of conflict, this **Code of Conduct** supercedes the original [Code of Conduct](https://opendistro.github.io/for-elasticsearch/codeofconduct.html) that this project had adopted.
45 changes: 41 additions & 4 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution.

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check [existing open](https://github.com/opendistro-for-elasticsearch/performance-analyzer-rca/issues), or [recently closed](https://github.com/opendistro-for-elasticsearch/performance-analyzer-rca/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
When filing an issue, please check [existing open](https://github.com/opensearch-project/performance-analyzer-rca/issues), or [recently closed](https://github.com/opensearch-project/performance-analyzer-rca/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), 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:

* A reproducible test case or series of steps
Expand All @@ -23,7 +23,7 @@ reported the issue. Please try to include as much information as you can. Detail
## Contributing via Pull Requests
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

1. You are working against the latest source on the *master* branch.
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.

Expand All @@ -39,9 +39,46 @@ To send us a pull request, please:
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/).

## Developer Certificate of Origin

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.

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/).

```
Developer's Certificate of Origin 1.1
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
(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
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(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.
```
We require that every contribution is signed with a Developer Certificate of Origin. Additionally, please use your real name. We do not accept anonymous contributors nor those utilizing pseudonyms.

Each commit must include a DCO which looks like this

```
Signed-off-by: Jane Smith <jane.smith@email.com>
```
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.

## 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'](https://github.com/opendistro-for-elasticsearch/performance-analyzer-rca/labels/help%20wanted) issues is a great place to start.
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'](https://github.com/opensearch-project/performance-analyzer-rca/labels/help%20wanted) issues is a great place to start.

## Testing your changes

Expand Down Expand Up @@ -92,6 +129,6 @@ If you discover a potential security issue in this project we ask that you notif

## Licensing

See the [LICENSE](https://github.com/opendistro-for-elasticsearch/performance-analyzer-rca/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
See the [LICENSE](https://github.com/opensearch-project/performance-analyzer-rca/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
14 changes: 7 additions & 7 deletions INSTALL.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Building, Installing, and Running the RCA Framework

This document walks you through the process of building and deploying the RCA framework along with the Performance Analyzer plugin. The RCA framework relies on the metrics provided by the [performance analyzer plugin](https://github.com/opendistro-for-elasticsearch/performance-analyzer). Since this code is still in development, the released versions of performance analyzer plugin do not support the RCA framework yet and you will have to build the plugin from source.
This document walks you through the process of building and deploying the RCA framework along with the Performance Analyzer plugin. The RCA framework relies on the metrics provided by the [performance analyzer plugin](https://github.com/opensearch-project/performance-analyzer). Since this code is still in development, the released versions of performance analyzer plugin do not support the RCA framework yet and you will have to build the plugin from source.


## Building the Performance Analyzer plugin
Expand All @@ -20,7 +20,7 @@ This document walks you through the process of building and deploying the RCA fr

#### 2. Clone the Performance Analyzer RCA repository as follows:

`git clone https://github.com/opendistro-for-elasticsearch/performance-analyzer-rca.git`
`git clone https://github.com/opensearch-project/performance-analyzer-rca.git`

`cd performance-analyzer-rca`

Expand Down Expand Up @@ -67,7 +67,7 @@ This package uses the [Gradle](https://docs.gradle.org/current/userguide/usergui

2. Clone the Performance Analyzer plugin repository as follows:

`git clone -b master --single-branch https://github.com/opendistro-for-elasticsearch/performance-analyzer.git`
`git clone -b master --single-branch https://github.com/opensearch-project/performance-analyzer.git`

3. `cd performance-analyzer`

Expand All @@ -89,7 +89,7 @@ This package uses the [Gradle](https://docs.gradle.org/current/userguide/usergui

### Setup

Currently, for the alpha development-only source code release, we support installing and running the RCA framework only on Open Distro for Elasticsearch Docker containers.
Currently, for the alpha development-only source code release, we support installing and running the RCA framework only on OpenSearch Docker containers.

You can use the packaged Dockerfile and docker-compose.yml files [here](./docker) to spin up a cluster with RCA framework installed.

Expand All @@ -106,19 +106,19 @@ You can use the packaged Dockerfile and docker-compose.yml files [here](./docker
4. Copy the RCA framework artifact and the Performance Analyzer plugin JAR into this folder

`cp <RCA framework root>/build/distributions/performance-analyzer-rca.zip ./`
`cp <Performance Analyzer plugin root>/build/distributions/opendistro-performance-analyzer-1.13.0.0-SNAPSHOT.zip ./`
`cp <Performance Analyzer plugin root>/build/distributions/opendistro-performance-analyzer-1.13.0.0-SNAPSHOT.zip ./`

### Installation

1. Make sure you're in the `rca-infra` folder.

2. Build and tag the Docker image with our RCA framework.

`docker build -t odfe-es/pa-rca:1.0 .`
`docker build -t odfe-opensearch/pa-rca:1.0 .`

3. Spin up a two node cluster as follows:

`DATA_VOLUME1=esdata1 DATA_VOLUME2=esdata2 docker-compose -f docker-compose.yml -f docker-compose.hostports.yml -f docker-compose.cluster.yml up elasticsearch1 elasticsearch2`
`DATA_VOLUME1=opensearchdata1 DATA_VOLUME2=opensearchdata2 docker-compose -f docker-compose.yml -f docker-compose.hostports.yml -f docker-compose.cluster.yml up opensearch1 opensearch2`

## Running

Expand Down
14 changes: 14 additions & 0 deletions MAINTAINERS.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Performance Analyzer RCA plugin Maintainers

## Maintainers
| Maintainer | GitHub ID | Affiliation |
| --------------- | --------- | ----------- |
| Joshua Tokle | [jotok](https://github.com/jotok) | Amazon |
| Sruti Parthiban | [sruti1312](https://github.com/sruti1312) | Amazon |
| Haoru Xiao | [hxiao608](https://github.com/hxiao608) | Amazon |
| Ricardo L. Stephen | [ricardolstephen](https://github.com/ricardolstephen) | Amazon |
| Yujia Sun | [yujias0706](https://github.com/yujias0706) | Amazon |
| Kunal Khatua | [kkhatua](https://github.com/kkhatua) | Amazon |


**Note:** Affiliations are tracked as during time of their contributions, and might be out-of-date.
4 changes: 2 additions & 2 deletions NOTICE
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
Open Distro for Elasticsearch Performance Analyzer RCA plugin
Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
OpenSearch Performance Analyzer RCA plugin
Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Loading

0 comments on commit 110445b

Please sign in to comment.