forked from open-telemetry/opentelemetry-demo
-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adding standard opensearch github dev / maintenance spec: (#16)
* adding standard opensearch github dev / maintenance spec: - CONTRIBUTING.md - MAINTAINERS.md - CODE_OF_CONDUCT.md ... Signed-off-by: YANGDB <yang.db.dev@gmail.com> --------- Signed-off-by: YANGDB <yang.db.dev@gmail.com>
- Loading branch information
Showing
10 changed files
with
150 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,4 @@ | ||
|
||
|
||
# Images | ||
IMAGE_VERSION=1.4.0 | ||
IMAGE_NAME=ghcr.io/open-telemetry/demo | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
## 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. | ||
|
||
## Development Environment | ||
|
||
You can contribute to this project from a Windows, macOS or Linux machine. The | ||
first step to contributing is ensuring you can run the demo successfully from | ||
your local machine. | ||
|
||
On all platforms, the minimum requirements are: | ||
|
||
- Docker | ||
- [Docker Compose](https://docs.docker.com/compose/install/#install-compose) v2.0.0+ | ||
|
||
### Clone Repo | ||
|
||
- Clone the Webstore Demo repository: | ||
|
||
```shell | ||
git clone https://github.com/open-telemetry/opentelemetry-demo.git | ||
``` | ||
|
||
### Open Folder | ||
|
||
- Navigate to the cloned folder: | ||
|
||
```shell | ||
cd opentelemetry-demo/ | ||
``` | ||
|
||
### Gradle Update [Windows Only] | ||
|
||
- Navigate to the Java Ad Service folder to install and update Gradle: | ||
|
||
```shell | ||
cd .\src\adservice\ | ||
.\gradlew installDist | ||
.\gradlew wrapper --gradle-version 7.4.2 | ||
``` | ||
|
||
### Run Docker Compose | ||
|
||
- Start the demo (It can take ~20min the first time the command is executed as | ||
all the images will be build): | ||
|
||
```shell | ||
docker compose up -d | ||
``` | ||
|
||
### Verify the Webstore & the Telemetry | ||
|
||
Once the images are built and containers are started you can access: | ||
|
||
- Webstore-Proxy (Via Nginx Proxy): http://nginx:90/ (`nginx` DNS name needs to be added ) | ||
- [Defined here](https://github.com/opensearch-project/opentelemetry-demo/blob/079750428f1bddf16c029f30f478396e45559fec/.env#L58) | ||
- Webstore: http://frontend:8080/ (`frontend` DNS name needs to be added ) | ||
- [Defined here](https://github.com/opensearch-project/opentelemetry-demo/blob/079750428f1bddf16c029f30f478396e45559fec/.env#L63) | ||
- Dashboards: http://dashboards:5061/ (`dashboards` DNS name needs to be added ) | ||
- Feature Flags UI: http://featureflag:8881/ (`featureflag` DNS name needs to be added ) | ||
- [Defined here](https://github.com/opensearch-project/opentelemetry-demo/blob/079750428f1bddf16c029f30f478396e45559fec/.env#LL47C31-L47C31) | ||
- Load Generator UI: http://loadgenerator:8089/ (`loadgenerator` DNS name needs to be added) | ||
- [Defined here](https://github.com/opensearch-project/opentelemetry-demo/blob/079750428f1bddf16c029f30f478396e45559fec/.env#L66) | ||
|
||
OpenSearch has [documented](https://opensearch.org/docs/latest/observing-your-data/trace/trace-analytics-jaeger/#setting-up-opensearch-to-use-jaeger-data) the usage of the Observability plugin with jaeger as a trace signal source. | ||
|
||
|
||
### Review the Documentation | ||
|
||
The Demo team is committed to keeping the demo up to date. That means the | ||
documentation as well as the code. When making changes to any service or feature | ||
remember to find the related docs and update those as well. Most (but not all) | ||
documentation can be found on the OTel website under [Demo docs][docs]. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
## Overview | ||
|
||
This document contains a list of maintainers in this repo. See [opensearch-project/.github/RESPONSIBILITIES.md](https://github.com/opensearch-project/.github/blob/main/RESPONSIBILITIES.md#maintainer-responsibilities) that explains what the role of maintainer means, what maintainers do in this and other repos, and how they should be doing it. If you're interested in contributing, and becoming a maintainer, see [CONTRIBUTING](CONTRIBUTING.md). | ||
|
||
## Current Maintainers | ||
|
||
| Maintainer | GitHub ID | Affiliation | | ||
| ----------------- | ------------------------------------------------- | ----------- | | ||
| Eric Wei | [mengweieric](https://github.com/mengweieric) | Amazon | | ||
| Joshua Li | [joshuali925](https://github.com/joshuali925) | Amazon | | ||
| Shenoy Pratik | [ps48](https://github.com/ps48) | Amazon | | ||
| Kavitha Mohan | [kavithacm](https://github.com/kavithacm) | Amazon | | ||
| Rupal Mahajan | [rupal-bq](https://github.com/rupal-bq) | Amazon | | ||
| Derek Ho | [derek-ho](https://github.com/derek-ho) | Amazon | | ||
| Lior Perry | [YANG-DB](https://github.com/YANG-DB) | Amazon | | ||
| Peter Fitzgibbons | [pjfitzgibbons](https://github.com/pjfitzgibbons) | Amazon | | ||
| Simeon Widdis | [swiddis](https://github.com/swiddis) | Amazon | | ||
| Chen Dai | [dai-chen](https://github.com/dai-chen) | Amazon | | ||
| Vamsi Manohar | [vamsi-amazon](https://github.com/vamsi-amazon) | Amazon | | ||
| Peng Huo | [penghuo](https://github.com/penghuo) | Amazon | | ||
| Sean Kao | [seankao-az](https://github.com/seankao-az) | Amazon | | ||
|
||
|
||
## Emeritus Maintainers | ||
|
||
| Maintainer | GitHub ID | Affiliation | | ||
| ----------------- | ------------------------------------------------------- | ----------- | | ||
| Charlotte Henkle | [CEHENKLE](https://github.com/CEHENKLE) | Amazon | | ||
| Anirudha Jadhav | [anirudha](https://github.com/anirudha) | Amazon | | ||
| Nick Knize | [nknize](https://github.com/nknize) | Amazon | | ||
| David Cui | [davidcui1225](https://github.com/davidcui1225) | Amazon | | ||
| Eugene Lee | [eugenesk24](https://github.com/eugenesk24) | Amazon | | ||
| Zhongnan Su | [zhongnansu](https://github.com/zhongnansu) | Amazon | | ||
| Sean Li | [sejli](https://github.com/sejli) | Amazon | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
OpenSearch (https://opensearch.org/) | ||
Copyright OpenSearch Contributors |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
This project follows the [OpenSearch release process](https://github.com/opensearch-project/.github/blob/main/RELEASING.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters