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

Add documentation for API rate limiting #4287

Merged
merged 13 commits into from
Jun 13, 2023
Merged

Conversation

cwillum
Copy link
Contributor

@cwillum cwillum commented Jun 7, 2023

Description

Rate limiting is configured in the config.yml file for security. This configuration needs to be documented.

Issues Resolved

Did the above.

Fixes #4171

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@cwillum cwillum added 2 - In progress Issue/PR: The issue or PR is in progress. security backport 2.8 PR: Backport label for 2.8 labels Jun 7, 2023
@cwillum cwillum self-assigned this Jun 7, 2023

| Setting | Description |
| :--- | :--- |
| `opensearch_security.ui.openid.login.buttonname` | Display name for the login button. "Log in with single sign-on" by default. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change part of this PR?

Copy link
Contributor Author

@cwillum cwillum Jun 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DarshitChanpura Just in a draft state right now. I'll keep you posted. (and the answer is no. Just getting a table in there.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DarshitChanpura I believe this is all set. When you get a chance, could you have a last look? Thanks for all the help with this.

@cwillum cwillum marked this pull request as draft June 8, 2023 17:34
@cwillum cwillum marked this pull request as ready for review June 9, 2023 01:41
@cwillum cwillum added 3 - Tech review PR: Tech review in progress 4 - Doc review PR: Doc review in progress and removed 2 - In progress Issue/PR: The issue or PR is in progress. 3 - Tech review PR: Tech review in progress labels Jun 9, 2023
Copy link
Collaborator

@Naarcha-AWS Naarcha-AWS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small question?

_security/configuration/configuration.md Show resolved Hide resolved
Copy link
Contributor Author

@cwillum cwillum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

_security/configuration/configuration.md Show resolved Hide resolved
Copy link
Contributor

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cwillum Looks good. A couple of suggestions for clarity.

_security/configuration/configuration.md Outdated Show resolved Hide resolved
_security/configuration/configuration.md Outdated Show resolved Hide resolved
_security/configuration/configuration.md Show resolved Hide resolved
@cwillum cwillum merged commit 9a8995d into main Jun 13, 2023
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jun 13, 2023
* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
(cherry picked from commit 9a8995d)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
cwillum pushed a commit that referenced this pull request Jun 13, 2023
* fix#4171 api rate limit



* fix#4171 api rate limit



* fix#4171 api rate limit



* fix#4171 api rate limit



* fix#4171 api rate limit



* fix#4171 api rate limit



* fix#4171 api rate limit



* fix#4171 api rate limit



* fix#4171 api rate limit



* fix#4171 api rate limit



* fix#4171 api rate limit



* fix#4171 api rate limit



* fix#4171 api rate limit



---------


(cherry picked from commit 9a8995d)

Signed-off-by: cwillum <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@cwillum cwillum deleted the fix#4171-api-rate-limiting branch June 13, 2023 01:33
vagimeli pushed a commit that referenced this pull request Jun 14, 2023
* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
vagimeli added a commit that referenced this pull request Jun 15, 2023
@cwillum cwillum removed the 4 - Doc review PR: Doc review in progress label Jul 25, 2023
vagimeli pushed a commit that referenced this pull request Aug 24, 2023
* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli added a commit that referenced this pull request Aug 24, 2023
harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

* fix#4171 api rate limit

Signed-off-by: cwillum <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.8 PR: Backport label for 2.8 security
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] [New Doc] Document API rate-limiting as customer control for open-sourced OpenSearch.
4 participants