GEODE-7405: Documentation for describe query-service command

Co-authored-by: Donal Evans <[email protected]> Co-authored-by: Benjamin Ross <[email protected]>
leeqiang250 · Nov 26, 2019 · cc169e1 · cc169e1
1 parent dc80b73
commit cc169e1
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 0 deletions.
diff --git a/geode-book/master_middleman/source/subnavs/geode-subnav.erb b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
@@ -1753,6 +1753,9 @@ gfsh</a>
                                             <li>
                                                 <a href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/describe.html#topic_kys_yvk_2l">describe offline-disk-store</a>
                                             </li>
+                                            <li>
+                                                <a href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/describe.html#topic_describe_query_service">describe query-service</a>
+                                            </li>
                                             <li>
                                                 <a href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/describe.html#topic_DECF7D3D33F54071B6B8AD4EA7E3F90B">describe region
                                                 </a>

diff --git a/geode-docs/managing/security/implementing_authorization.html.md.erb b/geode-docs/managing/security/implementing_authorization.html.md.erb
@@ -141,6 +141,7 @@ This table classifies the permissions assigned for `gfsh` operations.
 | describe lucene index                  | CLUSTER:READ:LUCENE              |
 | describe member                        | CLUSTER:READ                     |
 | describe offline-disk-store            | CLUSTER:READ                     |
+| describe query-service                 | CLUSTER:READ                     |
 | describe region                        | CLUSTER:READ                     |
 | destroy async-event-queue              | CLUSTER:MANAGE                   |
 | destroy disk-store                     | CLUSTER:MANAGE:DISK              |

diff --git a/geode-docs/tools_modules/gfsh/command-pages/describe.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/describe.html.md.erb
@@ -53,6 +53,10 @@ Display details of a member's configuration, shell connection, disk-stores, memb
 
     Display information about an offline member's disk store.
 
+-   **[describe query-service](#topic_describe_query_service)**
+
+    Display information about the configuration of the query service.
+
 -   **[describe region](#topic_DECF7D3D33F54071B6B8AD4EA7E3F90B)**
 
     Display the attributes and key information of a region.
@@ -445,6 +449,31 @@ PDX Enums:
   com.app.data.StockPdx$Day.Monday
 ```
 
+## <a id="topic_describe_query_service" class="no-quick-link"></a>describe query-service
+
+Print the information that describes the current configuration of the query service.
+
+**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command.
+
+**Syntax:**
+
+``` pre
+describe query-service
+```
+
+**Example Commands:**
+
+``` pre
+describe query-service
+```
+
+**Sample Output:**
+
+``` pre
+gfsh>describe query-service
+Method Authorizer Class : org.apache.geode.cache.query.security.JavaBeanAccessorMethodAuthorizer
+```
+
 ## <a id="topic_DECF7D3D33F54071B6B8AD4EA7E3F90B" class="no-quick-link"></a>describe region
 
 Display the attributes and key information of a region.

diff --git a/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb b/geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb
@@ -282,6 +282,7 @@ limitations under the License.
 | Command                                                                                                                                                                   | Description                                                                          | Availability    |
 |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|-----------------|
 | [alter query-service](command-pages/alter.html#topic_alter_query_service)                       | Alter configuration details of the query service.                     | online |
+| [describe query-service](command-pages/describe.html#topic_describe_query_service)                       | Print the information that describes the current configuration of the query service.                     | online |
 
 ## <a id="topic_EF03119A40EE492984F3B6248596E1DD" class="no-quick-link"></a>Region Commands
-Original file line number
+Diff line change
@@ Expand Up / @@ -1753,6 +1753,9 @@ gfsh</a> @@
                                                 <li>
                                                     <a href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/describe.html#topic_kys_yvk_2l">describe offline-disk-store</a>
                                                 </li>
+                                                <li>
+                                                    <a href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/describe.html#topic_describe_query_service">describe query-service</a>
+                                                </li>
                                                 <li>
                                                     <a href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/describe.html#topic_DECF7D3D33F54071B6B8AD4EA7E3F90B">describe region
                                                     </a>
@@ Expand Down @@