gerlowskija commented on a change in pull request #575: SOLR-13235: Split Collections API Ref Guide page URL: https://github.com/apache/lucene-solr/pull/575#discussion_r257728062
########## File path: solr/solr-ref-guide/src/cluster-node-management.adoc ########## @@ -0,0 +1,496 @@ += Cluster and Node Management Commands +:page-tocclass: right +:page-toclevels: 1 +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +A cluster is a set of Solr nodes operating in coordination with each other. + +These API commands work with a SolrCloud cluster at the entire cluster level, or on individual nodes. + +[[clusterstatus]] +== CLUSTERSTATUS: Cluster Status + +Fetch the cluster status including collections, shards, replicas, configuration name as well as collection aliases and cluster properties. + +`/admin/collections?action=CLUSTERSTATUS` + +=== CLUSTERSTATUS Parameters + +`collection`:: +The collection name for which information is requested. If omitted, information on all collections in the cluster will be returned. + +`shard`:: +The shard(s) for which information is requested. Multiple shard names can be specified as a comma-separated list. + +`\_route_`:: +This can be used if you need the details of the shard where a particular document belongs to and you don't know which shard it falls under. + +=== CLUSTERSTATUS Response + +The response will include the status of the request and the status of the cluster. + +=== Examples using CLUSTERSTATUS + +*Input* + +[source,text] +---- +http://localhost:8983/solr/admin/collections?action=CLUSTERSTATUS +---- + +*Output* + +[source,json] +---- +{ + "responseHeader":{ + "status":0, + "QTime":333}, + "cluster":{ + "collections":{ + "collection1":{ + "shards":{ + "shard1":{ + "range":"80000000-ffffffff", + "state":"active", + "replicas":{ + "core_node1":{ + "state":"active", + "core":"collection1", + "node_name":"127.0.1.1:8983_solr", + "base_url":"http://127.0.1.1:8983/solr";, + "leader":"true"}, + "core_node3":{ + "state":"active", + "core":"collection1", + "node_name":"127.0.1.1:8900_solr", + "base_url":"http://127.0.1.1:8900/solr"}}}, + "shard2":{ + "range":"0-7fffffff", + "state":"active", + "replicas":{ + "core_node2":{ + "state":"active", + "core":"collection1", + "node_name":"127.0.1.1:7574_solr", + "base_url":"http://127.0.1.1:7574/solr";, + "leader":"true"}, + "core_node4":{ + "state":"active", + "core":"collection1", + "node_name":"127.0.1.1:7500_solr", + "base_url":"http://127.0.1.1:7500/solr"}}}}, + "maxShardsPerNode":"1", + "router":{"name":"compositeId"}, + "replicationFactor":"1", + "znodeVersion": 11, + "autoCreated":"true", + "configName" : "my_config", + "aliases":["both_collections"] + }, + "collection2":{ + "..." + } + }, + "aliases":{ "both_collections":"collection1,collection2" }, + "roles":{ + "overseer":[ + "127.0.1.1:8983_solr", + "127.0.1.1:7574_solr"] + }, + "live_nodes":[ + "127.0.1.1:7574_solr", + "127.0.1.1:7500_solr", + "127.0.1.1:8983_solr", + "127.0.1.1:8900_solr"] + } +} +---- + + +[[clusterprop]] +== CLUSTERPROP: Cluster Properties + +Add, edit or delete a cluster-wide property. + +`/admin/collections?action=CLUSTERPROP&name=_propertyName_&val=_propertyValue_` + +=== CLUSTERPROP Parameters + +`name`:: +The name of the property. Supported properties names are `urlScheme` and `autoAddReplicas and location`. Other names are rejected with an error. Review comment: [0] Missing opening/closing backticks after `autoAddReplicas` and `location`. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
