Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds inclusive naming #99

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
* @VijayanB @jayeshathila @robsears @vamshin @dblock @VachaShah @nhtruong
# This should match the team set up in https://github.com/orgs/opensearch-project/teams and include any additional contributors
* @opensearch-project/clients @robsears
4 changes: 1 addition & 3 deletions .github/workflows/compatibility.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ jobs:
run: cd opensearch-api && bundle exec rake test:spec
- name: opensearch-dsl
run: cd opensearch-dsl && bundle exec rake test:all
- name: opensearch-aws-sigv4
run: cd opensearch-aws-sigv4 && bundle exec rake test:all


test-opensearch-security:
Expand Down Expand Up @@ -83,5 +81,5 @@ jobs:
ruby -v
rake bundle:clean
rake bundle:install
- name: opensearch-ruby
- name: opensearch
run: cd opensearch && bundle exec rake test_security:all
4 changes: 1 addition & 3 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,6 @@ jobs:
run: cd opensearch-api && bundle exec rake test:spec
- name: opensearch-dsl
run: cd opensearch-dsl && bundle exec rake test:all
- name: opensearch-aws-sigv4
run: cd opensearch-aws-sigv4 && bundle exec rake test:all

test-opensearch-faraday-1:
env:
Expand Down Expand Up @@ -120,5 +118,5 @@ jobs:
ruby -v
rake bundle:clean
rake bundle:install
- name: opensearch-ruby
- name: opensearch
run: cd opensearch && bundle exec rake test_security:all
4 changes: 1 addition & 3 deletions .github/workflows/test-unreleased.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,4 @@ jobs:
- name: opensearch-api
run: cd opensearch-api && bundle exec rake test:spec
- name: opensearch-dsl
run: cd opensearch-dsl && bundle exec rake test:all
- name: opensearch-aws-sigv4
run: cd opensearch-aws-sigv4 && bundle exec rake test:all
run: cd opensearch-dsl && bundle exec rake test:all
23 changes: 20 additions & 3 deletions ADMINS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# OpenSearch Ruby Client Admins
## Overview

This document explains who the admins are (see below), what they 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).

## Current Admins

Expand All @@ -11,5 +13,20 @@
| Yuvraj Jaiswal | [yuvi17](https://github.com/yuvi17) | Amazon |


[This document](https://github.com/opensearch-project/.github/blob/main/ADMINS.md)
explains what an admin's responsibilities are.
## Admin Responsibilities

As an admin you own stewartship of the repository and its settings. Admins have [admin-level permissions on a repository](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization). Use those privileges to serve the community and protect the repository as follows.

### Prioritize Security

Security is your number one priority. Manage security keys and safeguard access to the repository.

Note that this repository is monitored and supported 24/7 by Amazon Security, see [Reporting a Vulnerability](SECURITY.md) for details.

### Enforce Code of Conduct

Act on [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) violations by revoking access, and blocking malicious actors.

### Adopt Organizational Best Practices

Adopt organizational best practices, work in the open, and collaborate with other admins by opening issues before making process changes. Prefer consistency, and avoid diverging from practices in the opensearch-project organization.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Added Sigv4 Support with `opensearch-aws-sigv4` gem ([#71](https://github.com/opensearch-project/opensearch-ruby/issues/71))

### Changed
- Updated for inclusive naming ([#99](https://github.com/opensearch-project/opensearch-ruby/issues/99))


### Deprecated

Expand Down
36 changes: 3 additions & 33 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,10 @@
- [Ways to Contribute](#ways-to-contribute)
- [Bug Reports](#bug-reports)
- [Feature Requests](#feature-requests)
- [Documentation Changes](#documentation-changes)
- [Contributing Code](#contributing-code)
- [Developer Certificate of Origin](#developer-certificate-of-origin)
- [License Headers](#license-headers)
- [Java](#java)
- [Python, Ruby, Shell](#python-ruby-shell)
- [Shell](#shell)
- [Changelog](#changelog)
- [Adding Changes](#adding-changes)
- [Review Process](#review-process)

## Contributing to OpenSearch
Expand Down Expand Up @@ -100,47 +96,21 @@ New files in your code contributions should contain the following license header
/*
* Copyright OpenSearch Contributors
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*
*/
*/
```

### Python, Ruby, Shell
### Python
```
# Copyright OpenSearch Contributors
# SPDX-License-Identifier: Apache-2.0
#
# The OpenSearch Contributors require contributions made to
# this file be licensed under the Apache-2.0 license or a
# compatible open source license.
```


### Shell
```
# Copyright OpenSearch Contributors
# SPDX-License-Identifier: Apache-2.0
```

## Changelog

OpenSearch-ruby maintains a version specific changelog by enforcing a change to the ongoing [CHANGELOG](CHANGELOG.md) file adhering to the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.

The changes are curated by version, with the changes to the main branch added chronologically to the `Unreleased` version. Each version has corresponding sections which list out the category of the change - `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`.


### Adding Changes

As a contributor, you must ensure that every pull request has its changes listed out within the corresponding version and appropriate section of the [CHANGELOG](CHANGELOG.md) file.

Adding in the change is a two step process -
1. Add your changes to the corresponding section within the CHANGELOG file with dummy pull request information, publish the PR.

2. Update the entry for your change in [`CHANGELOG.md`](CHANGELOG.md) and make sure that you reference the pull request there.

## Review Process

We deeply appreciate everyone who takes the time to make a contribution. We will review all contributions as quickly as possible. As a reminder, [opening an issue](issues/new/choose) discussing your change before you make it is the best way to smooth the PR process. This will prevent a rejection because someone else is already working on the problem, or because the solution is incompatible with the architectural direction.
Expand Down
95 changes: 75 additions & 20 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,78 @@
# OpenSearch Ruby Client Maintainers
- [Overview](#overview)
- [Current Maintainers](#current-maintainers)
- [Maintainer Responsibilities](#maintainer-responsibilities)
- [Uphold Code of Conduct](#uphold-code-of-conduct)
- [Prioritize Security](#prioritize-security)
- [Review Pull Requests](#review-pull-requests)
- [Triage Open Issues](#triage-open-issues)
- [Backports](#backports)
- [Be Responsive](#be-responsive)
- [Maintain Overall Health of the Repo](#maintain-overall-health-of-the-repo)
- [Use Semver](#use-semver)
- [Release Frequently](#release-frequently)
- [Promote Other Maintainers](#promote-other-maintainers)

## Overview

This document explains who the maintainers are (see below), what they do in this repo, and how they should be doing it. If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md).

## Current Maintainers

| Maintainer | GitHub ID | Affiliation |
|-------------------------|-------------------------------------------------|-------------|
| Vijayan Balasubramanian | [VijayanB](https://github.com/VijayanB) | Amazon |
| Jayesh Hathila | [jayeshathila](https://github.com/jayeshathila) | Amazon |
| Rob Sears | [robsears](https://github.com/robsears) | Bonsai |
| Vamshi Vijay Nakkirtha | [vamshin](https://github.com/vamshin) | Amazon |
| Daniel Doubrovkine | [dblock](https://github.com/dblock) | Amazon |
| Vacha Shah | [VachaShah](https://github.com/VachaShah) | Amazon |
| Theo Truong | [nhtruong](https://github.com/nhtruong) | Amazon |

## Emeritus

| Maintainer | GitHub ID | Affiliation |
|-------------------------|-------------------------------------------------|-------------|
| Yuvraj Jaiswal | [yuvi17](https://github.com/yuvi17) | 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).
| Maintainer | GitHub ID | Affiliation |
| ------------------------ | --------------------------------------- | ----------- |
| Vijayan Balasubramanian | [VijayanB](https://github.com/VijayanB) | Amazon |
| Jayesh Hathila | [jayeshathila](https://github.com/jayeshathila) | Amazon |
| Rob Sears | [robsears](https://github.com/robsears) | Bonsai |
| Vamshi Vijay Nakkirtha | [vamshin](https://github.com/vamshin) | Amazon |
| Yuvraj Jaiswal | [yuvi17](https://github.com/yuvi17) | Amazon |

## Maintainer Responsibilities

Maintainers are active and visible members of the community, and have [maintain-level permissions on a repository](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization). Use those privileges to serve the community and evolve code as follows.

### Uphold Code of Conduct

Model the behavior set forward by the [Code of Conduct](CODE_OF_CONDUCT.md) and raise any violations to other maintainers and admins.

### Prioritize Security

Security is your number one priority. Maintainer's Github keys must be password protected securely and any reported security vulnerabilities are addressed before features or bugs.

Note that this repository is monitored and supported 24/7 by Amazon Security, see [Reporting a Vulnerability](SECURITY.md) for details.

### Review Pull Requests

Review pull requests regularly, comment, suggest, reject, merge and close. Accept only high quality pull-requests. Provide code reviews and guidance on incomming pull requests. Don't let PRs be stale and do your best to be helpful to contributors.

### Triage Open Issues

Manage labels, review issues regularly, and triage by labelling them.

All repositories in this organization have a standard set of labels, including `bug`, `documentation`, `duplicate`, `enhancement`, `good first issue`, `help wanted`, `blocker`, `invalid`, `question`, `wontfix`, and `untriaged`, along with release labels, such as `v1.0.0`, `v1.1.0`, `v2.0.0`, `patch`, and `backport`.

Use labels to target an issue or a PR for a given release, add `help wanted` to good issues for new community members, and `blocker` for issues that scare you or need immediate attention. Request for more information from a submitter if an issue is not clear. Create new labels as needed by the project.

### Backports

The Github workflow in [backport.yml](.github/workflows/backport.yml) creates backport PRs automatically when the original PR with an appropriate label `backport <backport-branch-name>` is merged to main. To backport a PR to `1.x`, add a label `backport 1.x` to the PR, once this PR is merged to main, the workflow will create a backport PR to the `1.x` branch.

### Be Responsive

Respond to enhancement requests, and forum posts. Allocate time to reviewing and commenting on issues and conversations as they come in.

### Maintain Overall Health of the Repo

Keep the `main` branch at production quality at all times. Backport features as needed. Cut release branches and tags to enable future patches.

### Use Semver

Use and enforce [semantic versioning](https://semver.org/) and do not let breaking changes be made outside of major releases.

### Release Frequently

Make frequent project releases to the community.

### Promote Other Maintainers

Assist, add, and remove [MAINTAINERS](MAINTAINERS.md). Exercise good judgement, and propose high quality contributors to become co-maintainers.

2 changes: 0 additions & 2 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,12 @@ SUBPROJECTS = [
'opensearch-transport',
'opensearch-dsl',
'opensearch-api',
'opensearch-aws-sigv4',
].freeze

RELEASE_TOGETHER = [
'opensearch',
'opensearch-transport',
'opensearch-api',
'opensearch-aws-sigv4',
].freeze

CERT_DIR = ENV['CERT_DIR']
Expand Down
2 changes: 1 addition & 1 deletion opensearch-api/lib/opensearch/api/actions/cat/aliases.rb
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ module Actions
#
# @option arguments [List] :name A comma-separated list of alias names to return
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
# @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
# @option arguments [List] :h Comma-separated list of column names to display
# @option arguments [Boolean] :help Return help information
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
Expand Down
6 changes: 4 additions & 2 deletions opensearch-api/lib/opensearch/api/actions/cat/allocation.rb
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@ module Actions
# @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
# @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
# @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
# @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
# @option arguments [List] :h Comma-separated list of column names to display
# @option arguments [Boolean] :help Return help information
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
Expand Down Expand Up @@ -70,6 +71,7 @@ def allocation(arguments = {})
:bytes,
:local,
:master_timeout,
:cluster_manager_timeout,
:h,
:help,
:s,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# SPDX-License-Identifier: Apache-2.0
#
# The OpenSearch Contributors require contributions made to
# this file be licensed under the Apache-2.0 license or a
# compatible open source license.
#
# Modifications Copyright OpenSearch Contributors. See
# GitHub history for details.


module OpenSearch
module API
module Cat
module Actions
# Returns information about the cluster_manager node.
#
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
# @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
# @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
# @option arguments [List] :h Comma-separated list of column names to display
# @option arguments [Boolean] :help Return help information
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
#
def cluster_manager(arguments = {})
headers = arguments.delete(:headers) || {}

arguments = arguments.clone

method = OpenSearch::API::HTTP_GET
path = "_cat/cluster_manager"
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

body = nil
perform_request(method, path, params, body, headers).body
end

# Register this action with its valid params when the module is loaded.
#
# @since 6.2.0
ParamsRegistry.register(:cluster_manager, [
:format,
:local,
:cluster_manager_timeout,
:h,
:help,
:s,
:v
].freeze)
end
end
end
end
6 changes: 4 additions & 2 deletions opensearch-api/lib/opensearch/api/actions/cat/indices.rb
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@ module Actions
# @option arguments [List] :index A comma-separated list of index names to limit the returned information
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
# @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb)
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated*
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false)
# @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node
# @option arguments [Time] :cluster_manager_timeout Explicit operation timeout for connection to cluster_manager node
# @option arguments [List] :h Comma-separated list of column names to display
# @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red)
# @option arguments [Boolean] :help Return help information
Expand Down Expand Up @@ -75,6 +76,7 @@ def indices(arguments = {})
:bytes,
:local,
:master_timeout,
:cluster_manager_timeout,
:h,
:health,
:help,
Expand Down
3 changes: 2 additions & 1 deletion opensearch-api/lib/opensearch/api/actions/cat/master.rb
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.


# @deprecated Please use cluster_manager instead.
module OpenSearch
module API
module Cat
Expand Down
Loading