Skip to content

Adding docs related to catalog. #963

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

Merged
merged 1 commit into from
Oct 27, 2022

Conversation

vamsimanohar
Copy link
Member

@vamsimanohar vamsimanohar commented Oct 25, 2022

Signed-off-by: Vamsi Manohar [email protected]

Description

Documentation for catalog and added prometheus connector in doctest cluster.

One can view the page here: https://github.com/vamsi-amazon/sql/blob/docs-prometheus/docs/user/ppl/admin/catalog.rst

Issues Resolved

#939

Check List

  • New functionality includes testing.
    • All tests pass, including unit test, integration test and doctest
  • New functionality has been documented.
    • New functionality has javadoc added
    • New functionality has user manual doc added
  • Commits are signed per the DCO using --signoff

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

@vamsimanohar vamsimanohar force-pushed the docs-prometheus branch 22 times, most recently from ec20c8f to e9c17ba Compare October 25, 2022 23:28
@codecov-commenter
Copy link

codecov-commenter commented Oct 25, 2022

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.85%. Comparing base (f9e8e1f) to head (c933ed3).
Report is 489 commits behind head on 2.x.

Additional details and impacted files
@@              Coverage Diff              @@
##                2.x     #963       +/-   ##
=============================================
+ Coverage     62.76%   94.85%   +32.08%     
- Complexity        0     3137     +3137     
=============================================
  Files            10      313      +303     
  Lines           658     8473     +7815     
  Branches        119      626      +507     
=============================================
+ Hits            413     8037     +7624     
- Misses          192      382      +190     
- Partials         53       54        +1     
Flag Coverage Δ
query-workbench 62.76% <ø> (ø)
sql-engine 97.55% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@vamsimanohar vamsimanohar force-pushed the docs-prometheus branch 7 times, most recently from c314faf to 1d0487d Compare October 26, 2022 01:11
@vamsimanohar vamsimanohar changed the title Adding docs related to prometheus and catalog functionalities. Adding docs related to catalog. Oct 26, 2022

Command to add catalog.json file to OpenSearch Keystore ::

>>bin/opensearch-keystore add-file plugins.query.federation.catalog.config catalog.json
Copy link
Member

Choose a reason for hiding this comment

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

nit. add a space after >>?

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok

Copy link
Collaborator

Choose a reason for hiding this comment

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

what is the content of catalog.json, could you add a sample and link to it?

Copy link
Member Author

Choose a reason for hiding this comment

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

Mentioned that sample catalog.json can be found in the above section.

@vamsimanohar vamsimanohar force-pushed the docs-prometheus branch 7 times, most recently from 8869486 to 0743b64 Compare October 26, 2022 22:49
anirudha
anirudha previously approved these changes Oct 26, 2022
* A json file containing array of catalog configurations should be injected into keystore with the above mentioned key. sample json file can be seen in the above section.


[``To be run on all the nodes in the cluster``] Command to add catalog.json file to OpenSearch Keystore ::
Copy link
Member

Choose a reason for hiding this comment

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

why is "To be run on all the nodes in the cluster" code in brackets?

Copy link
Member Author

Choose a reason for hiding this comment

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

can be a common mistake while updating settings. Running on one node and expecting to be reflected when we hit reload settings api. Any other idea to emphasize it?

Copy link
Member

Choose a reason for hiding this comment

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

maybe use normal or bold text? i think formatting it as inline code is a bit confusing

@vamsimanohar vamsimanohar merged commit cacdb1b into opensearch-project:2.x Oct 27, 2022
@dai-chen dai-chen added the documentation Improvements or additions to documentation label Oct 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants