You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ct...@apache.org on 2017/05/09 14:48:23 UTC
lucene-solr:jira/solr-10290: SOLR-10296: conversion, table cleanup,
last commit
Repository: lucene-solr
Updated Branches:
refs/heads/jira/solr-10290 029b600d0 -> a244450b2
SOLR-10296: conversion, table cleanup, last commit
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/a244450b
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/a244450b
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/a244450b
Branch: refs/heads/jira/solr-10290
Commit: a244450b27e1883acbbe13235990b373ce0e885f
Parents: 029b600
Author: Cassandra Targett <ct...@apache.org>
Authored: Tue May 9 09:48:01 2017 -0500
Committer: Cassandra Targett <ct...@apache.org>
Committed: Tue May 9 09:48:01 2017 -0500
----------------------------------------------------------------------
solr/solr-ref-guide/src/client-api-lineup.adoc | 4 +-
solr/solr-ref-guide/src/collections-api.adoc | 123 ++++++++++++++-----
.../src/command-line-utilities.adoc | 4 +-
solr/solr-ref-guide/src/configsets-api.adoc | 8 +-
.../cross-data-center-replication-cdcr-.adoc | 18 ++-
.../src/distributed-requests.adoc | 4 +-
.../src/hadoop-authentication-plugin.adoc | 6 +-
solr/solr-ref-guide/src/index-replication.adoc | 14 ++-
.../src/kerberos-authentication-plugin.adoc | 8 +-
.../src/making-and-restoring-backups.adoc | 16 ++-
.../src/mbean-request-handler.adoc | 4 +-
.../src/parallel-sql-interface.adoc | 2 -
.../solr-ref-guide/src/parameter-reference.adoc | 16 ++-
.../src/performance-statistics-reference.adoc | 13 +-
.../src/rule-based-authorization-plugin.adoc | 4 +-
.../src/running-solr-on-hdfs.adoc | 27 ++--
.../src/solr-jdbc-python-jython.adoc | 6 +-
solr/solr-ref-guide/src/v2-api.adoc | 10 +-
.../src/zookeeper-access-control.adoc | 24 ++--
19 files changed, 211 insertions(+), 100 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/client-api-lineup.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/client-api-lineup.adoc b/solr/solr-ref-guide/src/client-api-lineup.adoc
index 6dea6ec..06014e0 100644
--- a/solr/solr-ref-guide/src/client-api-lineup.adoc
+++ b/solr/solr-ref-guide/src/client-api-lineup.adoc
@@ -6,7 +6,9 @@ The Solr Wiki contains a list of client APIs at http://wiki.apache.org/solr/Inte
Here is the list of client APIs, current at this writing (November 2011):
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,20,60",options="header"]
|===
|Name |Environment |URL
|SolRuby |Ruby |https://github.com/rsolr/rsolr
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/collections-api.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/collections-api.adoc b/solr/solr-ref-guide/src/collections-api.adoc
index 1937368..f3342c3 100644
--- a/solr/solr-ref-guide/src/collections-api.adoc
+++ b/solr/solr-ref-guide/src/collections-api.adoc
@@ -14,13 +14,21 @@ The Collections API is used to enable you to create, remove, or reload collectio
*Query Parameters*
-// TODO: This table has cells that won't work with PDF: https://github.com/ctargett/refguide-asciidoc-poc/issues/13
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-[width="100%",options="header",]
+[cols="20,15,10,15,40",options="header"]
|===
|Key |Type |Required |Default |Description
|name |string |Yes | |The name of the collection to be created.
-|router.name |string |No |compositeId |The router name that will be used. The router defines how documents will be distributed among the shards. Possible values are *implicit* or *compositeId*. The 'implicit' router does not automatically route documents to different shards. Whichever shard you indicate on the indexing request (or within each document) will be used as the destination for those documents. The 'compositeId' router hashes the value in the uniqueKey field and looks up that hash in the collection's clusterstate to determine which shard will receive the document, with the additional ability to manually direct the routing. When using the 'implicit' router, the `shards` parameter is required. When using the 'compositeId' router, the `numShards` parameter is required. For more information, see also the section <<shards-and-indexing-data-in-solrcloud.adoc#ShardsandIndexingDatainSolrCloud-DocumentRouting,Document Routing>>.
+|router.name |string |No |compositeId |The router name that will be used. The router defines how documents will be distributed among the shards. Possible values are *implicit* or *compositeId*.
+
+The 'implicit' router does not automatically route documents to different shards. Whichever shard you indicate on the indexing request (or within each document) will be used as the destination for those documents.
+
+The 'compositeId' router hashes the value in the uniqueKey field and looks up that hash in the collection's clusterstate to determine which shard will receive the document, with the additional ability to manually direct the routing.
+
+When using the 'implicit' router, the `shards` parameter is required. When using the 'compositeId' router, the `numShards` parameter is required.
+
+For more information, see also the section <<shards-and-indexing-data-in-solrcloud.adoc#ShardsandIndexingDatainSolrCloud-DocumentRouting,Document Routing>>.
|numShards |integer |No |empty |The number of shards to be created as part of the collection. This is a required parameter when using the 'compositeId' router.
|shards |string |No |empty |A comma separated list of shard names, e.g., shard-x,shard-y,shard-z. This is a required parameter when using the 'implicit' router.
|replicationFactor |integer |No |1 |The number of replicas to be created for each shard.
@@ -92,9 +100,9 @@ It's possible to edit multiple attributes at a time. Changing these values only
*Query Parameters*
-// TODO: This table has cells that won't work with PDF: https://github.com/ctargett/refguide-asciidoc-poc/issues/13
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-[width="100%",options="header",]
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection |string |Yes |The name of the collection to be modified.
@@ -126,7 +134,10 @@ The RELOAD action is used when you have changed a configuration in ZooKeeper.
*Query Parameters*
-[cols=",,,",options="header",]
+
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|name |string |Yes |The name of the collection to reload.
@@ -196,7 +207,9 @@ Shard splitting can be a long running process. In order to avoid timeouts, you s
*Query Parameters*
-[cols=",,,",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection |string |Yes |The name of the collection that includes the shard to be split.
@@ -298,7 +311,9 @@ Shards can only created with this API for collections that use the 'implicit' ro
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection |string |Yes |The name of the collection that includes the shard that will be splitted.
@@ -409,7 +424,9 @@ The `CREATEALIAS` action will create a new alias pointing to one or more collect
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|name |string |Yes |The alias name to be created.
@@ -456,7 +473,9 @@ http://localhost:8983/solr/admin/collections?action=CREATEALIAS&name=testalias&c
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|name |string |Yes |The name of the alias to delete.
@@ -502,7 +521,9 @@ http://localhost:8983/solr/admin/collections?action=DELETEALIAS&name=testalias
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|name |string |Yes |The name of the collection to delete.
@@ -564,7 +585,9 @@ Delete a named replica from the specified collection and shard. If the correspon
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection |string |Yes |The name of the collection.
@@ -612,9 +635,9 @@ Add a replica to a shard in a collection. The node name can be specified if the
*Query Parameters*
-// TODO: This table has cells that won't work with PDF: https://github.com/ctargett/refguide-asciidoc-poc/issues/13
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-[width="100%",options="header",]
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection |string |Yes |The name of the collection.
@@ -678,7 +701,9 @@ Add, edit or delete a cluster-wide property.
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|name |string |Yes |The name of the property. The supported properties names are `urlScheme` and `autoAddReplicas and location`. Other names are rejected with an error.
@@ -732,7 +757,9 @@ Please note that the migrate API does not perform any de-duplication on the docu
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection |string |Yes |The name of the source collection from which documents will be split.
@@ -916,7 +943,9 @@ Assign a role to a given node in the cluster. The only supported role as of 4.7
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|role |string |Yes |The name of the role. The only supported role as of now is _overseer_.
@@ -962,7 +991,9 @@ Remove an assigned role. This API is used to undo the roles assigned using ADDRO
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|role |string |Yes |The name of the role. The only supported role as of now is _overseer_.
@@ -1083,7 +1114,9 @@ Fetch the cluster status including collections, shards, replicas, configuration
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection |string |No |The collection name for which information is requested. If omitted, information on all collections in the cluster will be returned.
@@ -1187,7 +1220,9 @@ Request the status and response of an already submitted <<CollectionsAPI-async,A
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|requestid |string |Yes |The user defined request-id for the request. This can be used to track the status of the submitted asynchronous task.
@@ -1254,7 +1289,9 @@ Delete the stored response of an already failed or completed <<CollectionsAPI-as
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|requestid |string |No |The request-id of the async call we need to clear the stored response for.
@@ -1366,9 +1403,9 @@ Assign an arbitrary property to a particular replica and give it the value speci
*Query Parameters*
-// TODO: This table has cells that won't work with PDF: https://github.com/ctargett/refguide-asciidoc-poc/issues/13
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-[width="100%",options="header",]
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection |string |Yes |The name of the collection this replica belongs to.
@@ -1451,9 +1488,9 @@ Deletes an arbitrary property from a particular replica.
*Query Parameters*
-// TODO: This table has cells that won't work with PDF: https://github.com/ctargett/refguide-asciidoc-poc/issues/13
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-[width="100%",options="header",]
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection |string |Yes |The name of the collection this replica belongs to
@@ -1511,7 +1548,9 @@ Insures that a particular property is distributed evenly amongst the physical no
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection |string |Yes |The name of the collection to balance the property in.
@@ -1567,7 +1606,9 @@ Assigns leaders in a collection according to the preferredLeader property on act
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection |string |Yes |The name of the collection to rebalance preferredLeaders on.
@@ -1666,7 +1707,9 @@ In the unlikely event of a shard losing its leader, this command can be invoked
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection |string |Yes |The name of the collection
@@ -1685,7 +1728,9 @@ A expert level utility API to move a collection from shared `clusterstate.json`
`/admin/collections?action=MIGRATESTATEFORMAT&collection=<collection_name>`
-[cols=",,,",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection |string |Yes |The name of the collection to be migrated from `clusterstate.json` to its own `state.json` zookeeper node
@@ -1708,7 +1753,9 @@ The backup command will backup Solr indexes and configurations for a specified c
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection |string |Yes |The name of the collection that needs to be backed up
@@ -1735,7 +1782,9 @@ You can use the collection <<CollectionsAPI-createalias,alias>> API to make sure
*Query Parameters*
-[cols=",,,",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection |string |Yes |The collection where the indexes will be restored into.
@@ -1748,7 +1797,9 @@ Additionally, there are several parameters that can be overridden:
*Override Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|collection.configName |String |No |Defines the name of the configurations to use for this collection. These must already be stored in ZooKeeper. If not provided, Solr will default to the collection name as the configuration name.
@@ -1770,7 +1821,9 @@ Deletes all replicas of all collections in that node. Please note that the node
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|node |string |Yes |The node to be cleaned up
@@ -1789,7 +1842,9 @@ This command recreates replicas in the source node to the target node. After eac
*Query Parameters*
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,55",options="header"]
|===
|Key |Type |Required |Description
|source |string |Yes |The source node from which the replicas need to be copied from
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/command-line-utilities.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/command-line-utilities.adoc b/solr/solr-ref-guide/src/command-line-utilities.adoc
index f12c5bb..78cd9e9 100644
--- a/solr/solr-ref-guide/src/command-line-utilities.adoc
+++ b/solr/solr-ref-guide/src/command-line-utilities.adoc
@@ -21,7 +21,9 @@ Many of the functions provided by the zkCli.sh script are also provided by the <
Both `zkcli.sh` (for Unix environments) and `zkcli.bat` (for Windows environments) support the following command line options:
-[width="100%",options="header"]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="10,30,60",options="header"]
|===
|Short |Parameter Usage |Meaning
| |`-cmd <arg>` |CLI Command to be executed: `bootstrap`, `upconfig`, `downconfig`, `linkconfig`, `makepath`, `get`, `getfile`, `put`, `putfile`, `list`, `clear` or `clusterprop`. This parameter is **mandatory**.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/configsets-api.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/configsets-api.adoc b/solr/solr-ref-guide/src/configsets-api.adoc
index 72037c7..505fcbe 100644
--- a/solr/solr-ref-guide/src/configsets-api.adoc
+++ b/solr/solr-ref-guide/src/configsets-api.adoc
@@ -29,7 +29,9 @@ Create a ConfigSet, based on an existing ConfigSet.
[[ConfigSetsAPI-Input]]
=== Input
-[cols=",,,,",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,15,40",options="header"]
|===
|Key |Type |Required |Default |Description
|name |String |Yes | |ConfigSet to be created
@@ -82,7 +84,9 @@ Delete a ConfigSet
*Query Parameters*
-[cols=",,,,",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,10,15,40",options="header"]
|===
|Key |Type |Required |Default |Description
|name |String |Yes | |ConfigSet to be deleted
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/cross-data-center-replication-cdcr-.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/cross-data-center-replication-cdcr-.adoc b/solr/solr-ref-guide/src/cross-data-center-replication-cdcr-.adoc
index 4efaf4c..9514ed7 100644
--- a/solr/solr-ref-guide/src/cross-data-center-replication-cdcr-.adoc
+++ b/solr/solr-ref-guide/src/cross-data-center-replication-cdcr-.adoc
@@ -236,7 +236,9 @@ The configuration details, defaults and options are as follows:
CDCR can be configured to forward update requests to one or more replicas. A replica is defined with a “replica” list as follows:
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,10,15,55",options="header"]
|===
|Parameter |Required |Default |Description
|zkHost |Yes |none |The host address for ZooKeeper of the target SolrCloud. Usually this is a comma-separated list of addresses to each node in the target ZooKeeper ensemble.
@@ -250,7 +252,9 @@ The CDC Replicator is the component in charge of forwarding updates to the repli
The replicator uses a fixed thread pool to forward updates to multiple replicas in parallel. If more than one replica is configured, one thread will forward a batch of updates from one replica at a time in a round-robin fashion. The replicator can be configured with a “replicator” list as follows:
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,10,15,55",options="header"]
|===
|Parameter |Required |Default |Description
|threadPoolSize |No |2 |The number of threads to use for forwarding updates. One thread per replica is recommended.
@@ -262,7 +266,9 @@ The replicator uses a fixed thread pool to forward updates to multiple replicas
Expert: Non-leader nodes need to synchronize their update logs with their leader node from time to time in order to clean deprecated transaction log files. By default, such a synchronization process is performed every minute. The schedule of the synchronization can be modified with a “updateLogSynchronizer” list as follows:
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,10,15,55",options="header"]
|===
|Parameter |Required |Default |Description
|schedule |No |60000 |The delay in milliseconds for synchronizing the updates log.
@@ -272,7 +278,9 @@ Expert: Non-leader nodes need to synchronize their update logs with their leader
CDCR is configured by default to buffer any new incoming updates. When buffering updates, the updates log will store all the updates indefinitely. Replicas do not need to buffer updates, and it is recommended to disable buffer on the target SolrCloud. The buffer can be disabled at startup with a “buffer” list and the parameter “defaultState” as follows:
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,10,15,55",options="header"]
|===
|Parameter |Required |Default |Description
|defaultState |No |enabled |The state of the buffer at startup.
@@ -685,7 +693,7 @@ As usual, it is good to start small. Sync a single cloud and monitor for a perio
+
For example, if there are 2 shards on collection1 with 2 replicas for each shard, copy the corresponding index directories from
+
-[width="100%"]
+[width="75%",cols="45,10,45"]
|===
|shard1replica1Source |to |shard1replica1Target
|shard1replica2Source |to |shard1replica2Target
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/distributed-requests.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/distributed-requests.adoc b/solr/solr-ref-guide/src/distributed-requests.adoc
index 544b0fd..ae77179 100644
--- a/solr/solr-ref-guide/src/distributed-requests.adoc
+++ b/solr/solr-ref-guide/src/distributed-requests.adoc
@@ -75,7 +75,9 @@ To configure the standard handler, provide a configuration like this in `solrcon
The parameters that can be specified are as follows:
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,65",options="header"]
|===
|Parameter |Default |Explanation
|`socketTimeout` |0 (use OS default) |The amount of time in ms that a socket is allowed to wait.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/hadoop-authentication-plugin.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/hadoop-authentication-plugin.adoc b/solr/solr-ref-guide/src/hadoop-authentication-plugin.adoc
index d2e3931..cbbb3a1 100644
--- a/solr/solr-ref-guide/src/hadoop-authentication-plugin.adoc
+++ b/solr/solr-ref-guide/src/hadoop-authentication-plugin.adoc
@@ -25,9 +25,11 @@ For most SolrCloud or standalone Solr setups, the `HadoopAuthPlugin` should suff
[[HadoopAuthenticationPlugin-PluginConfiguration]]
== Plugin Configuration
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,15,65",options="header"]
|===
-|Parameter name |Required |Description
+|Parameter Name |Required |Description
|class |Yes |Should be either `solr.HadoopAuthPlugin` or `solr.ConfigurableInternodeAuthHadoopPlugin`.
|type |Yes |The type of authentication scheme to be configured. See https://hadoop.apache.org/docs/stable/hadoop-auth/Configuration.html[configuration] options.
|sysPropPrefix |Yes |The prefix to be used to define the Java system property for configuring the authentication mechanism. The name of the Java system property is defined by appending the configuration parameter name to this prefix value. For example, if the prefix is 'solr' then the Java system property 'solr.kerberos.principal' defines the value of configuration parameter 'kerberos.principal'.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/index-replication.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/index-replication.adoc b/solr/solr-ref-guide/src/index-replication.adoc
index 94c8b6a..b606b00 100644
--- a/solr/solr-ref-guide/src/index-replication.adoc
+++ b/solr/solr-ref-guide/src/index-replication.adoc
@@ -35,7 +35,9 @@ When using SolrCloud, the `ReplicationHandler` must be available via the `/repli
The table below defines the key terms associated with Solr replication.
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Term |Definition
|Index |A Lucene index is a directory of files. These files make up the searchable and returnable data of a Solr Core.
@@ -62,7 +64,9 @@ In addition to `ReplicationHandler` configuration options specific to the master
Before running a replication, you should set the following parameters on initialization of the handler:
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Name |Description
|replicateAfter |String specifying action after which replication should occur. Valid values are commit, optimize, or startup. There can be multiple values for this parameter. If you use "startup", you need to have a "commit" and/or "optimize" entry also if you want to trigger replication on future commits or optimizes.
@@ -183,7 +187,9 @@ Here is an example of a ReplicationHandler configuration for a repeater:
When a commit or optimize operation is performed on the master, the RequestHandler reads the list of file names which are associated with each commit point. This relies on the `replicateAfter` parameter in the configuration to decide which types of events should trigger replication.
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Setting on the Master |Description
|commit |Triggers replication whenever a commit is performed on the master index.
@@ -240,8 +246,6 @@ To correct this problem, the slave then copies all the index files from master t
You can use the HTTP commands below to control the ReplicationHandler's operations.
-// TODO: This table has cells that won't work with PDF: https://github.com/ctargett/refguide-asciidoc-poc/issues/13
-
[width="100%",options="header",]
|===
|Command |Description
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/kerberos-authentication-plugin.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/kerberos-authentication-plugin.adoc b/solr/solr-ref-guide/src/kerberos-authentication-plugin.adoc
index 8f45083..ba4336f 100644
--- a/solr/solr-ref-guide/src/kerberos-authentication-plugin.adoc
+++ b/solr/solr-ref-guide/src/kerberos-authentication-plugin.adoc
@@ -216,7 +216,9 @@ The main properties we are concerned with are the `keyTab` and `principal` prope
While starting up Solr, the following host-specific parameters need to be passed. These parameters can be passed at the command line with the `bin/solr` start command (see <<solr-control-script-reference.adoc#solr-control-script-reference,Solr Control Script Reference>> for details on how to pass system parameters) or defined in `bin/solr.in.sh` or `bin/solr.in.cmd` as appropriate for your operating system.
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,10,60",options="header"]
|===
|Parameter Name |Required |Description
|`solr.kerberos.name.rules` |No |Used to map Kerberos principals to short names. Default value is `DEFAULT`. Example of a name rule: `RULE:[1:$1@$0](.\*EXAMPLE.COM)s/@.*//`
@@ -261,7 +263,9 @@ There are a few use cases for Solr where this might be helpful:
To enable delegation tokens, several parameters must be defined. These parameters can be passed at the command line with the `bin/solr` start command (see <<solr-control-script-reference.adoc#solr-control-script-reference,Solr Control Script Reference>> for details on how to pass system parameters) or defined in `bin/solr.in.sh` or `bin/solr.in.cmd` as appropriate for your operating system.
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,10,60",options="header"]
|===
|Parameter Name |Required |Description
|`solr.kerberos.delegation.token.enabled` |Yes, to enable tokens |False by default, set to true to enable delegation tokens.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/making-and-restoring-backups.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/making-and-restoring-backups.adoc b/solr/solr-ref-guide/src/making-and-restoring-backups.adoc
index 74f2973..a1fdaba 100644
--- a/solr/solr-ref-guide/src/making-and-restoring-backups.adoc
+++ b/solr/solr-ref-guide/src/making-and-restoring-backups.adoc
@@ -37,7 +37,9 @@ Only one backup call can be made against a core at any point in time. While an o
The backup request can also take the following additional parameters:
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Parameter |Description
|location |The path where the backup will be created. If the path is not absolute then the backup path will be relative to Solr's instance directory.
@@ -87,7 +89,9 @@ This will restore the named index snapshot into the current core. Searches will
The restore request can also take these additional parameters:
-[cols=",",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Parameter |Description
|location |The location of the backup snapshot file. If not specified, it looks for backups in Solr's data directory.
@@ -140,7 +144,9 @@ http://localhost:8983/solr/admin/cores?action=CREATESNAPSHOT&core=techproducts&c
The list snapshot request parameters are:
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Parameter |Description
|commitName |Specify the commit name to store the snapshot as
@@ -162,7 +168,9 @@ http://localhost:8983/solr/admin/cores?action=LISTSNAPSHOTS&core=techproducts&co
The list snapshot request parameters are:
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Parameter |Description
|core |name of the core to whose snapshots we want to list
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/mbean-request-handler.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/mbean-request-handler.adoc b/solr/solr-ref-guide/src/mbean-request-handler.adoc
index cd5e96e..0582b82 100644
--- a/solr/solr-ref-guide/src/mbean-request-handler.adoc
+++ b/solr/solr-ref-guide/src/mbean-request-handler.adoc
@@ -6,7 +6,9 @@ The MBean Request Handler offers programmatic access to the information provided
The MBean Request Handler accepts the following parameters:
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="10,20,10,60",options="header"]
|===
|Parameter |Type |Default |Description
|key |multivalued |all |Restricts results by object key.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/parallel-sql-interface.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/parallel-sql-interface.adoc b/solr/solr-ref-guide/src/parallel-sql-interface.adoc
index d32f990..d4bb2c0 100644
--- a/solr/solr-ref-guide/src/parallel-sql-interface.adoc
+++ b/solr/solr-ref-guide/src/parallel-sql-interface.adoc
@@ -214,8 +214,6 @@ WHERE (fieldA = 'term1') AND NOT (fieldB = 'term2')
The parallel SQL interface supports and pushes down most common SQL operators, specifically:
-// TODO: This table has cells that won't work with PDF: https://github.com/ctargett/refguide-asciidoc-poc/issues/13
-
[width="100%",options="header",]
|===
|Operator |Description |Example |Solr Query
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/parameter-reference.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/parameter-reference.adoc b/solr/solr-ref-guide/src/parameter-reference.adoc
index 45e9295..4942f57 100644
--- a/solr/solr-ref-guide/src/parameter-reference.adoc
+++ b/solr/solr-ref-guide/src/parameter-reference.adoc
@@ -4,7 +4,9 @@
== Cluster Parameters
-[width="100%"]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,20,60"]
|===
|`numShards` |Defaults to 1 |The number of shards to hash documents to. There must be one leader per shard and each leader can have N replicas.
|===
@@ -13,7 +15,9 @@
These are set in `solr.xml`, but by default the `host` and `hostContext` parameters are set up to also work with system properties.
-[width="100%",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,20,60"]
|===
|`host` |Defaults to the first local host address found |If the wrong host address is found automatically, you can override the host address with this parameter.
|`hostPort` |Defaults to the port specified via `bin/solr -p <port>`, or `8983` if not specified. |The port that Solr is running on. This value is only used when `-DzkRun` is specified without a value (see below), to calculate the default port on which embedded ZooKeeper will run. **I**n the `solr.xml` shipped with Solr, the `hostPort` system property is not referenced, and so is ignored. If you want to run Solr on a non-default port, use `bin/solr -p <port>` rather than specifying `-DhostPort`.
@@ -22,7 +26,9 @@ These are set in `solr.xml`, but by default the `host` and `hostContext` paramet
== SolrCloud Instance ZooKeeper Parameters
-[width="100%",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,20,60"]
|===
|`zkRun` |Defaults to `localhost:<hostPort+1000>` |Causes Solr to run an embedded version of ZooKeeper. Set to the address of ZooKeeper on this node; this allows us to know who you are in the list of addresses in the `zkHost` connect string. Use `-DzkRun` (with no value) to get the default value.
|`zkHost` |No default |The host address for ZooKeeper. Usually this is a comma-separated list of addresses to each node in your ZooKeeper ensemble.
@@ -33,7 +39,9 @@ These are set in `solr.xml`, but by default the `host` and `hostContext` paramet
== SolrCloud Core Parameters
-[width="100%",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,20,60"]
|===
|`shard` |Defaults to being automatically assigned based on numShards |Specifies which shard this core acts as a replica of.
|===
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/performance-statistics-reference.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/performance-statistics-reference.adoc b/solr/solr-ref-guide/src/performance-statistics-reference.adoc
index 8bd69d0..c0dfa1b 100644
--- a/solr/solr-ref-guide/src/performance-statistics-reference.adoc
+++ b/solr/solr-ref-guide/src/performance-statistics-reference.adoc
@@ -20,11 +20,13 @@ The update request handler is an endpoint to send data to Solr. We can see how m
Can be useful to measure and track number of search queries , response times etc. If you are not using the “select” handler then the path needs to be changed appropriately. Similarly if you are using the “sql” handler or “export” handler , the realtime handler “get”, or any other handler similar statistics can be found for that as well.
-**Path**: `/solr/<core>/select`
+*Path*: `/solr/<core>/select`
Both Update Request Handler and Search Request Handler along with handlers like “sql”, “export” and realtime “get” handler will provide the following attributes in their statistics.
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Attribute |Description
|15minRateReqsPerSecond |Requests per second received over the past 15 minutes.
@@ -50,8 +52,9 @@ Both Update Request Handler and Search Request Handler along with handlers like
*Update Handler:* This section has information on the total number of adds, how many commits have been fired against a solr core.
*Path:* `/solr/<core>/updateHandler/DirectUpdateHandler2`
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-[width="100%",options="header",]
+[cols="30,70",options="header"]
|===
|Attribute |Description
|adds |Total number of “add” requests since last commit.
@@ -94,7 +97,9 @@ This cache is used for filters for unordered sets of all documents that match a
*Path:* `/solr/<cache>/filterCache`
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,70",options="header"]
|===
|Attribute |Description
|cumulative_evictions |Number of cache evictions across all caches since this node has been running.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/rule-based-authorization-plugin.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/rule-based-authorization-plugin.adoc b/solr/solr-ref-guide/src/rule-based-authorization-plugin.adoc
index 15604ad3..cc85567 100644
--- a/solr/solr-ref-guide/src/rule-based-authorization-plugin.adoc
+++ b/solr/solr-ref-guide/src/rule-based-authorization-plugin.adoc
@@ -116,9 +116,9 @@ Permissions need to be created if they are not on the list of pre-defined permis
Several properties can be used to define your custom permission.
-// TODO: This table has cells that won't work with PDF: https://github.com/ctargett/refguide-asciidoc-poc/issues/13
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-[width="100%",options="header",]
+[cols="30,70",options="header"]
|===
|Property |Description
|name |The name of the permission. This is required only if it is a predefined permission.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/running-solr-on-hdfs.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/running-solr-on-hdfs.adoc b/solr/solr-ref-guide/src/running-solr-on-hdfs.adoc
index de0ecde..4e51446 100644
--- a/solr/solr-ref-guide/src/running-solr-on-hdfs.adoc
+++ b/solr/solr-ref-guide/src/running-solr-on-hdfs.adoc
@@ -87,7 +87,9 @@ The `HdfsDirectoryFactory` has a number of settings that are defined as part of
[[RunningSolronHDFS-SolrHDFSSettings]]
=== Solr HDFS Settings
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="20,30,10,40",options="header"]
|===
|Parameter |Example Value |Default |Description
|`solr.hdfs.home` |`hdfs://host:port/path/solr` |N/A |A root location in HDFS for Solr to write collection data to. Rather than specifying an HDFS location for the data directory or update log directory, use this to specify one root location and have everything automatically created within this HDFS location.
@@ -96,23 +98,24 @@ The `HdfsDirectoryFactory` has a number of settings that are defined as part of
[[RunningSolronHDFS-BlockCacheSettings]]
=== Block Cache Settings
-// TODO: This table has cells that won't work with PDF: https://github.com/ctargett/refguide-asciidoc-poc/issues/13
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-[width="100%",options="header",]
+[cols="30,10,60",options="header"]
|===
|Parameter |Default |Description
|`solr.hdfs.blockcache.enabled` |true |Enable the blockcache
|`solr.hdfs.blockcache.read.enabled` |true |Enable the read cache
|`solr.hdfs.blockcache.direct.memory.allocation` |true |Enable direct memory allocation. If this is false, heap is used
|`solr.hdfs.blockcache.slab.count` |1 |Number of memory slabs to allocate. Each slab is 128 MB in size.
-|`solr.hdfs.blockcache.global`
-|true |Enable/Disable using one global cache for all SolrCores. The settings used will be from the first HdfsDirectoryFactory created.
+|`solr.hdfs.blockcache.global` |true |Enable/Disable using one global cache for all SolrCores. The settings used will be from the first HdfsDirectoryFactory created.
|===
[[RunningSolronHDFS-NRTCachingDirectorySettings]]
=== NRTCachingDirectory Settings
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,10,60",options="header"]
|===
|Parameter |Default |Description
|`solr.hdfs.nrtcachingdirectory.enable` |true |Enable the use of NRTCachingDirectory
@@ -125,7 +128,9 @@ The `HdfsDirectoryFactory` has a number of settings that are defined as part of
solr.hdfs.confdir pass the location of HDFS client configuration files - needed for HDFS HA for example.
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="30,10,60",options="header"]
|===
|Parameter |Default |Description
|`solr.hdfs.confdir` |N/A |Pass the location of HDFS client configuration files - needed for HDFS HA for example.
@@ -136,9 +141,9 @@ solr.hdfs.confdir pass the location of HDFS client configuration files - needed
Hadoop can be configured to use the Kerberos protocol to verify user identity when trying to access core services like HDFS. If your HDFS directories are protected using Kerberos, then you need to configure Solr's HdfsDirectoryFactory to authenticate using Kerberos in order to read and write to HDFS. To enable Kerberos authentication from Solr, you need to set the following parameters:
-// TODO: This table has cells that won't work with PDF: https://github.com/ctargett/refguide-asciidoc-poc/issues/13
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-[width="100%",options="header",]
+[cols="30,10,60",options="header"]
|===
|Parameter |Default |Description
|`solr.hdfs.security.kerberos.enabled` |false |Set to true to enable Kerberos authentication
@@ -189,7 +194,9 @@ One benefit to running Solr in HDFS is the ability to automatically add new repl
Collections created using `autoAddReplicas=true` on a shared file system have automatic addition of replicas enabled. The following settings can be used to override the defaults in the `<solrcloud>` section of `solr.xml`.
-[width="100%",options="header",]
+// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+
+[cols="40,10,50",options="header"]
|===
|Param |Default |Description
|autoReplicaFailoverWorkLoopDelay |10000 |The time (in ms) between clusterstate inspections by the Overseer to detect and possibly act on creation of a replacement replica.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/solr-jdbc-python-jython.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/solr-jdbc-python-jython.adoc b/solr/solr-ref-guide/src/solr-jdbc-python-jython.adoc
index bb91425..4158bb0 100644
--- a/solr/solr-ref-guide/src/solr-jdbc-python-jython.adoc
+++ b/solr/solr-ref-guide/src/solr-jdbc-python-jython.adoc
@@ -25,7 +25,7 @@ python solr_jaydebeapi.py
----
.solr_jaydebeapi.py
-[source,py]
+[source,python]
----
#!/usr/bin/env python
@@ -66,7 +66,7 @@ jython [solr_java_native.py | solr_zxjdbc.py]
=== Java Native
.solr_java_native.py
-[source,py]
+[source,python]
----
#!/usr/bin/env jython
@@ -100,7 +100,7 @@ if __name__ == '__main__':
=== zxJDBC
.solr_zxjdbc.py
-[source,py]
+[source,python]
----
#!/usr/bin/env jython
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/v2-api.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/v2-api.adoc b/solr/solr-ref-guide/src/v2-api.adoc
index 782b00a..12ac623 100644
--- a/solr/solr-ref-guide/src/v2-api.adoc
+++ b/solr/solr-ref-guide/src/v2-api.adoc
@@ -46,20 +46,20 @@ Following are some v2 API URL paths and path prefixes, along with some of the op
Append `/_introspect` to any valid v2 API path and the API specification will be returned in JSON format.
-`http://localhost:8983/v2/c/_introspect`
+`\http://localhost:8983/v2/c/_introspect`
To limit the introspect output to include just one particular HTTP method, add request param `method` with value `GET`, `POST`, or `DELETE`.
-`http://localhost:8983/v2/c/_introspect?method=POST`
+`\http://localhost:8983/v2/c/_introspect?method=POST`
Most endpoints support commands provided in a body sent via POST. To limit the introspect output to only one command, add request param `command=__command-name__` .
-`http://localhost:8983/v2/c/gettingstarted/_introspect?method=POST&command=modify`
+`\http://localhost:8983/v2/c/gettingstarted/_introspect?method=POST&command=modify`
[[v2API-InterpretingtheIntrospectOutput]]
=== Interpreting the Introspect Output
-Example : `http://localhost:8983/v2/c/gettingstarted/get/_introspect`
+Example : `\http://localhost:8983/v2/c/gettingstarted/get/_introspect`
[source,json]
----
@@ -93,7 +93,7 @@ Description of some of the keys in the above example:
* `**spec/url/params**` : List of supported URL request params
* `**availableSubPaths**` : List of valid URL subpaths and the HTTP method(s) each supports
-Example of introspect for a POST API: `http://localhost:8983/v2/c/gettingstarted/_introspect?method=POST&command=modify`
+Example of introspect for a POST API: `\http://localhost:8983/v2/c/gettingstarted/_introspect?method=POST&command=modify`
[source,json]
----
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/a244450b/solr/solr-ref-guide/src/zookeeper-access-control.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/zookeeper-access-control.adoc b/solr/solr-ref-guide/src/zookeeper-access-control.adoc
index ef17062..c0fa805 100644
--- a/solr/solr-ref-guide/src/zookeeper-access-control.adoc
+++ b/solr/solr-ref-guide/src/zookeeper-access-control.adoc
@@ -33,9 +33,9 @@ But this content is also available to "the outside" via the ZooKeeper API. Outsi
We want to be able to:
-1. Control the credentials Solr uses for its ZooKeeper connections. The credentials are used to get permission to perform operations in ZooKeeper.
-2. Control which ACLs Solr will add to znodes (ZooKeeper files/folders) it creates in ZooKeeper.
-3. Control it "from the outside", so that you do not have to modify and/or recompile Solr code to turn this on.
+. Control the credentials Solr uses for its ZooKeeper connections. The credentials are used to get permission to perform operations in ZooKeeper.
+. Control which ACLs Solr will add to znodes (ZooKeeper files/folders) it creates in ZooKeeper.
+. Control it "from the outside", so that you do not have to modify and/or recompile Solr code to turn this on.
Solr nodes, clients and tools (e.g. ZkCLI) always use a java class called {solr-javadocs}/solr-solrj/org/apache/solr/common/cloud/SolrZkClient.html[`SolrZkClient`] to deal with their ZooKeeper stuff. The implementation of the solution described here is all about changing `SolrZkClient`. If you use `SolrZkClient` in your application, the descriptions below will be true for your application too.
@@ -83,12 +83,15 @@ You can give the readonly credentials to "clients" of your SolrCloud cluster - e
[[ZooKeeperAccessControl-bin_solr_solr.cmd_server_scripts_cloud-scripts_zkcli.sh_zkcli.bat]]
-=== `bin/solr` & `solr.cmd`, `server/scripts/cloud-scripts/zkcli.sh` & `zkcli.bat`
+=== ZooKeeper ACLs in Solr Scripts
-These Solr scripts can enable use of ZK ACLs by setting the appropriate system properties: uncomment the following and replace the passwords with ones you choose to enable the above-described VM parameters ACL and credentials providers in the following files:
+There are two scripts that impact ZooKeeper ACLs:
+* For *nix systems: `bin/solr` & `server/scripts/cloud-scripts/zkcli.sh`
+* For Windows systems: `bin/solr.cmd` & `server/scripts/cloud-scripts/zkcli.bat`
-*solr.in.sh*
+These Solr scripts can enable use of ZK ACLs by setting the appropriate system properties: uncomment the following and replace the passwords with ones you choose to enable the above-described VM parameters ACL and credentials providers in the following files:
+.solr.in.sh
[source,bash]
----
# Settings for ZK ACL
@@ -99,8 +102,7 @@ These Solr scripts can enable use of ZK ACLs by setting the appropriate system p
#SOLR_OPTS="$SOLR_OPTS $SOLR_ZK_CREDS_AND_ACLS"
----
-*solr.in.cmd*
-
+.solr.in.cmd
[source,powershell]
----
REM Settings for ZK ACL
@@ -111,8 +113,7 @@ REM -DzkDigestReadonlyUsername=readonly-user -DzkDigestReadonlyPassword=CHANGEM
REM set SOLR_OPTS=%SOLR_OPTS% %SOLR_ZK_CREDS_AND_ACLS%
----
-*zkcli.sh*
-
+.zkcli.sh
[source,bash]
----
# Settings for ZK ACL
@@ -122,8 +123,7 @@ REM set SOLR_OPTS=%SOLR_OPTS% %SOLR_ZK_CREDS_AND_ACLS%
# -DzkDigestReadonlyUsername=readonly-user -DzkDigestReadonlyPassword=CHANGEME-READONLY-PASSWORD"
----
-*zkcli.bat*
-
+.zkcli.bat
[source,powershell]
----
REM Settings for ZK ACL