Skip to content

Conversation

@ruai0511
Copy link
Contributor

@ruai0511 ruai0511 commented Oct 28, 2024

Add Querygroup API documentation
Related Issue:

Here's the structure of the documentation

  • availability-and-recovery
    • workload-management
      • index.md (PR not raised yet)
      • query-group-lifecycle-api.md

@github-actions
Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@Naarcha-AWS
Copy link
Contributor

@ruai0511: Does this replace PR #8267?

@Naarcha-AWS Naarcha-AWS added In progress Issue/PR: The issue or PR is in progress. v2.18.0 release-notes PR: Include this PR in the automated release notes labels Oct 29, 2024
@ruai0511
Copy link
Contributor Author

@ruai0511: Does this replace PR #8267?

Yes

@Naarcha-AWS Naarcha-AWS added Tech review PR: Tech review in progress and removed In progress Issue/PR: The issue or PR is in progress. labels Oct 29, 2024
@Naarcha-AWS Naarcha-AWS removed the Tech review PR: Tech review in progress label Oct 31, 2024
@Naarcha-AWS Naarcha-AWS added the Doc review PR: Doc review in progress label Oct 31, 2024
```

## Fields
The query group schema contains the following fields.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do these fields apply to all of the wlm APIs listed here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes

Copy link
Contributor

@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.

Approving for now. Need to tweak the automation tool to remove headers for more flexibility.

@Naarcha-AWS Naarcha-AWS merged commit b784b6d into opensearch-project:main Nov 15, 2024
6 checks passed
@Naarcha-AWS Naarcha-AWS added the backport 2.18 PR: Backport label for 2.18 label Nov 15, 2024
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 15, 2024
* add querygroup api documentation
Signed-off-by: Ruirui Zhang <[email protected]>

* fix wording
Signed-off-by: Ruirui Zhang <[email protected]>

* fix wording
Signed-off-by: Ruirui Zhang <[email protected]>

* Make page fit API template.

Signed-off-by: Naarcha-AWS <[email protected]>

* Test automation

Signed-off-by: Naarcha-AWS <[email protected]>

* Update query-group-lifecycle-api.md

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit b784b6d)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
epugh pushed a commit to o19s/documentation-website that referenced this pull request Nov 23, 2024
* add querygroup api documentation
Signed-off-by: Ruirui Zhang <[email protected]>

* fix wording
Signed-off-by: Ruirui Zhang <[email protected]>

* fix wording
Signed-off-by: Ruirui Zhang <[email protected]>

* Make page fit API template.

Signed-off-by: Naarcha-AWS <[email protected]>

* Test automation

Signed-off-by: Naarcha-AWS <[email protected]>

* Update query-group-lifecycle-api.md

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
epugh pushed a commit to o19s/documentation-website that referenced this pull request Jul 2, 2025
* add querygroup api documentation
Signed-off-by: Ruirui Zhang <[email protected]>

* fix wording
Signed-off-by: Ruirui Zhang <[email protected]>

* fix wording
Signed-off-by: Ruirui Zhang <[email protected]>

* Make page fit API template.

Signed-off-by: Naarcha-AWS <[email protected]>

* Test automation

Signed-off-by: Naarcha-AWS <[email protected]>

* Update query-group-lifecycle-api.md

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 2.18 PR: Backport label for 2.18 Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes v2.18.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Workload management at tenant level to improve resiliency [DOC] Add Documentation for WorkloadManagement Settings

4 participants