blob: ca1dbe4f0dacf1e1df3e5fe7ab9aa6380f2fca1b [file] [log] [blame]
= SolrCloud Autoscaling
:page-children: solrcloud-autoscaling-overview, solrcloud-autoscaling-policy-preferences, solrcloud-autoscaling-triggers, solrcloud-autoscaling-trigger-actions, solrcloud-autoscaling-listeners, solrcloud-autoscaling-auto-add-replicas, solrcloud-autoscaling-fault-tolerance, solrcloud-autoscaling-api, migrate-to-policy-rule
// 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.
[WARNING]
.Autoscaling is deprecated
====
The autoscaling framework in its current form is deprecated and will be removed in Solr 9.0.
Some features relating to replica placement will be replaced in 9.0, but other features are not likely to be replaced.
====
[.lead]
The goal of autoscaling is to make SolrCloud cluster management easier by providing a way for changes to the cluster to be more automatic and more intelligent.
Autoscaling includes an API to manage cluster-wide and collection-specific policies and preferences and a rules syntax to define the guidelines for your cluster. Also included are features to utilize the policies and preferences so they perform actions automatically when certain conditions are met.
The following sections describe the autoscaling features of SolrCloud:
* <<solrcloud-autoscaling-overview.adoc#,Overview of Autoscaling in SolrCloud>>
* <<solrcloud-autoscaling-policy-preferences.adoc#,Autoscaling Policy and Preferences>>
* <<solrcloud-autoscaling-triggers.adoc#,Autoscaling Triggers>>
* <<solrcloud-autoscaling-trigger-actions.adoc#,Autoscaling Trigger Actions>>
* <<solrcloud-autoscaling-listeners.adoc#,Autoscaling Listeners>>
* <<solrcloud-autoscaling-auto-add-replicas.adoc#,Automatically Adding Replicas>>
* <<solrcloud-autoscaling-fault-tolerance.adoc#,Autoscaling Fault Tolerance>>
* <<solrcloud-autoscaling-api.adoc#,Autoscaling API>>
* <<migrate-to-policy-rule.adoc#, Migrating Rule-Based Replica Rules to Autoscaling Policies>>