Adding docs related to catalog. #963

vamsi-amazon · 2022-10-25T19:03:04Z

Signed-off-by: Vamsi Manohar reddyvam@amazon.com

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.

codecov-commenter · 2022-10-25T23:38:44Z

Codecov Report

Merging #963 (c933ed3) into 2.x (f9e8e1f) will increase coverage by 32.08%.
The diff coverage is n/a.

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

Impacted Files	Coverage Δ
.../sql/prometheus/storage/PrometheusMetricTable.java	`100.00% <0.00%> (ø)`
...esponse/format/VisualizationResponseFormatter.java	`100.00% <0.00%> (ø)`
...nsearch/sql/expression/aggregation/Aggregator.java	`100.00% <0.00%> (ø)`
...main/java/org/opensearch/sql/utils/ParseUtils.java	`100.00% <0.00%> (ø)`
.../sql/planner/physical/PhysicalPlanNodeVisitor.java	`100.00% <0.00%> (ø)`
...rch/sql/data/utils/NullsLastExprValueOrdering.java	`100.00% <0.00%> (ø)`
...search/storage/script/filter/lucene/TermQuery.java	`100.00% <0.00%> (ø)`
...n/java/org/opensearch/sql/utils/DateTimeUtils.java	`100.00% <0.00%> (ø)`
...age/serialization/DefaultExpressionSerializer.java	`100.00% <0.00%> (ø)`
...ensearch/sql/expression/ExpressionNodeVisitor.java	`100.00% <0.00%> (ø)`
... and 293 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

docs/user/ppl/admin/catalog.rst

joshuali925 · 2022-10-26T20:52:37Z

docs/user/ppl/admin/catalog.rst

+
+Command to add catalog.json file to OpenSearch Keystore ::
+
+    >>bin/opensearch-keystore add-file plugins.query.federation.catalog.config catalog.json


nit. add a space after >>?

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

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

docs/user/ppl/admin/catalog.rst

doctest/build.gradle

docs/user/ppl/admin/catalog.rst

joshuali925 · 2022-10-26T23:14:45Z

docs/user/ppl/admin/catalog.rst

+* 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 ::


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

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?

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

Signed-off-by: Vamsi Manohar <reddyvam@amazon.com>

vamsi-amazon force-pushed the docs-prometheus branch 22 times, most recently from ec20c8f to e9c17ba Compare October 25, 2022 23:28

vamsi-amazon force-pushed the docs-prometheus branch 7 times, most recently from c314faf to 1d0487d Compare October 26, 2022 01:11

vamsi-amazon changed the title ~~Adding docs related to prometheus and catalog functionalities.~~ Adding docs related to catalog. Oct 26, 2022

joshuali925 reviewed Oct 26, 2022

View reviewed changes