-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from wazuh/1-add-init-plugin
Init repo
- Loading branch information
Showing
9 changed files
with
149 additions
and
1 deletion.
There are no files selected for viewing
Validating CODEOWNERS rules …
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 @@ | ||
* @wazuh/devel-indexer |
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,33 @@ | ||
--- | ||
name: 🐛 Bug report | ||
about: Create a report to help us improve | ||
title: "[BUG]" | ||
labels: ["type/bug", "level/task"] | ||
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. |
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 @@ | ||
# disable blank issue creation | ||
blank_issues_enabled: false |
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,19 @@ | ||
--- | ||
name: 🎆 Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: ["type/enhancement", "level/task"] | ||
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. |
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,8 @@ | ||
updates: | ||
- directory: / | ||
open-pull-requests-limit: 1 | ||
package-ecosystem: gradle | ||
schedule: | ||
interval: weekly | ||
day: "friday" | ||
version: 2 |
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,5 @@ | ||
### Description | ||
[Describe what this change achieves] | ||
|
||
### Issues Resolved | ||
[List any issues this PR will resolve] |
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,23 @@ | ||
# Contributing to OpenSearch Plugins | ||
Depending on the plugin relationship with the OpenSearch organization we currently recommend the following naming conventions and optional follow-up checks: | ||
|
||
### Official plugins | ||
|
||
For the **official plugins** that live within the OpenSearch organization (i.e. they are included in [OpenSearch/plugins/](https://github.com/opensearch-project/OpenSearch/tree/main/plugins) or [OpenSearch/modules/](https://github.com/opensearch-project/OpenSearch/tree/main/modules) folder), and **which share the same release cycle as OpenSearch** itself: | ||
|
||
- Do not include the word `plugin` in the repo name (e.g. [job-scheduler](https://github.com/opensearch-project/job-scheduler)) | ||
- Use lowercase repo names | ||
- Use spinal case for repo names (e.g. [job-scheduler](https://github.com/opensearch-project/job-scheduler)) | ||
- Do not include the word `OpenSearch` or `OpenSearch Dashboards` in the repo name | ||
- Provide a meaningful description, e.g. `An OpenSearch Dashboards plugin to perform real-time and historical anomaly detection on OpenSearch data`. | ||
|
||
### Thirdparty plugins | ||
|
||
For the **3rd party plugins** that are maintained as independent projects in separate GitHub repositories **with their own release cycles** the recommended naming convention should follow the same rules as official plugins with some exceptions and few follow-up checks: | ||
|
||
- Inclusion of the words like `OpenSearch` or `OpenSearch Dashboard` (and in reasonable cases even `plugin`) are welcome because they can increase the chance of discoverability of the repository | ||
- Check the plugin versioning policy is documented and help users know which versions of the plugin are compatible and recommended for specific versions of OpenSearch | ||
- Review [CONTRIBUTING.md](CONTRIBUTING.md) document which is by default tailored to the needs of Amazon Web Services developer teams. You might want to update or further customize specific parts related to: | ||
- **Code of Conduct** (if you do not already have CoC policy then there are several options to start with, such as [Contributor Covenant](https://www.contributor-covenant.org/)), | ||
- **Security Policy** (you should let users know how they can safely report security vulnerabilities), | ||
- Check if you need explicit part about **Trademarks and Attributions** (if you use any registered or non-registered trademarks we recommend following applicable "trademark-use" documents provided by respective trademark owners) |
File renamed without changes.
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 +1,58 @@ | ||
# wazuh-indexer-plugins | ||
<p align="center"> | ||
<img width="640px" src="https://wazuh.com/brand-assets/Wazuh-Logo.svg"/> | ||
</p> | ||
|
||
[![Chat](https://img.shields.io/badge/chat-on%20forums-blue)](https://groups.google.com/forum/#!forum/wazuh) | ||
[![Slack](https://img.shields.io/badge/slack-join-blue.svg)](https://wazuh.com/community/join-us-on-slack) | ||
[![Documentation](https://img.shields.io/badge/documentation-reference-blue)](https://documentation.wazuh.com) | ||
|
||
- [Welcome!](#welcome) | ||
- [Project Resources](#project-resources) | ||
- [Security](#security) | ||
- [License](#license) | ||
- [Copyright](#copyright) | ||
- [Trademark](#trademark) | ||
|
||
## Welcome! | ||
|
||
The Wazuh Indexer is a highly scalable, full-text search and analytics engine. This Wazuh central component indexes and stores alerts generated by the Wazuh server and provides near real-time data search and analytics capabilities. | ||
|
||
Wazuh Indexer is an open source fork of [OpenSearch](https://github.com/opensearch-project/opensearch). | ||
|
||
This repository stores the source code of the Wazuh Indexer plugins and their configurations. | ||
|
||
## Project Resources | ||
|
||
* [Project Website](https://wazuh.com) | ||
* [Quickstart](https://documentation.wazuh.com/current/quickstart.html) | ||
* [Documentation](https://documentation.wazuh.com) | ||
* Need help? Try [Slack](https://wazuh.com/community/join-us-on-slack) | ||
* [Security](SECURITY.md) | ||
|
||
## Security | ||
|
||
To report a possible vulnerability or security issue you can: | ||
- Email us to security@wazuh.com. | ||
- Open a new security report under the security tab on this repository. | ||
|
||
**PLEASE DO NOT OPEN A PUBLIC ISSUE ABOUT SECURITY** | ||
|
||
We want to protect our community, so please give us time to fix a vulnerability | ||
before publishing it. | ||
|
||
## License | ||
|
||
This project is licensed under the [AGPL v3.0 License](LICENSE.txt). | ||
|
||
## Copyright | ||
|
||
- Copyright Wazuh, Inc. | ||
|
||
## Trademark | ||
|
||
OpenSearch is a registered trademark of Amazon Web Services. | ||
|
||
OpenSearch includes certain Apache-licensed Elasticsearch code from Elasticsearch B.V. and other source code. Elasticsearch B.V. is not the source of that other source code. ELASTICSEARCH is a registered trademark of Elasticsearch B.V. | ||
|
||
Check Wazuh's [trademark and Brand policy](https://wazuh.com/trademark-and-brand-policy/). | ||
|