-
Notifications
You must be signed in to change notification settings - Fork 154
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
Adding docs related to catalog. #963
Conversation
ec20c8f
to
e9c17ba
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
c314faf
to
1d0487d
Compare
docs/user/ppl/admin/catalog.rst
Outdated
|
||
Command to add catalog.json file to OpenSearch Keystore :: | ||
|
||
>>bin/opensearch-keystore add-file plugins.query.federation.catalog.config catalog.json |
There was a problem hiding this comment.
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 >>
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
8869486
to
0743b64
Compare
e4c6ec2
to
2cc112a
Compare
docs/user/ppl/admin/catalog.rst
Outdated
* 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 :: |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
2cc112a
to
b579af9
Compare
Signed-off-by: Vamsi Manohar <[email protected]>
b579af9
to
c933ed3
Compare
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
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.