IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
ElasticsearchClusterPlan
editElasticsearchClusterPlan
editThe plan for the Elasticsearch cluster.
Properties
edit-
autoscaling_enabled(boolean) - Enable autoscaling for this Elasticsearch cluster.
-
cluster_topology(array[ElasticsearchClusterTopologyElement], required) -
deployment_template(DeploymentTemplateReference) - Documents which deployment template was used in the creation of this plan
-
elasticsearch(ElasticsearchConfiguration, required) - The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
-
tiebreaker_override(boolean) - DEPRECATED: Scheduled for removal in a future version of the API. Whether to add a tiebreaker node in an unused zone (defaults to auto-decide based on topology). If master nodes are specified then this cannot be left blank, you must explicitly decide true or false.
-
tiebreaker_topology(TiebreakerTopologyElement) - DEPRECATED: Scheduled for removal in a future version of the API. Defines the topology (capacity and location) of the special tiebreaker node. If masters nodes are present, their topology acts as a default for the tiebreaker topology
-
transient(TransientElasticsearchPlanConfiguration) - Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.
-
zone_count(integerasint32) -
DEPRECATED: Scheduled for removal in a future version of the API. Please use
cluster_topology.zone_countinstead. The default number of zones in which data nodes will be placed, if not specified in the per topology settings
Example
edit{
"autoscaling_enabled" : true,
"cluster_topology" : [
{
"allocator_filter" : {},
"autoscaling_max" : {
"resource" : "string",
"value" : 0
},
"autoscaling_min" : {
"resource" : "string",
"value" : 0
},
"autoscaling_policy_override_json" : {},
"elasticsearch" : {
"curation" : {
"from_instance_configuration_id" : "string",
"to_instance_configuration_id" : "string"
},
"docker_image" : "string",
"enabled_built_in_plugins" : [
"string"
],
"node_attributes" : {
"some_property" : "string"
},
"system_settings" : {
"auto_create_index" : true,
"default_shards_per_index" : 0,
"destructive_requires_name" : true,
"enable_close_index" : true,
"monitoring_collection_interval" : 0,
"monitoring_history_duration" : "string",
"reindex_whitelist" : [
"string"
],
"scripting" : {
"expressions_enabled" : true,
"file" : {
"enabled" : true,
"sandbox_mode" : true
},
"inline" : {
"enabled" : true,
"sandbox_mode" : true
},
"mustache_enabled" : true,
"painless_enabled" : true,
"stored" : {
"enabled" : true,
"sandbox_mode" : true
}
},
"use_disk_threshold" : true,
"watcher_trigger_engine" : "string"
},
"user_bundles" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_plugins" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_settings_json" : {},
"user_settings_override_json" : {},
"user_settings_override_yaml" : "string",
"user_settings_yaml" : "string",
"version" : "string"
},
"id" : "string",
"instance_configuration_id" : "string",
"memory_per_node" : 0,
"node_configuration" : "string",
"node_count_per_zone" : 0,
"node_roles" : [
"string"
],
"node_type" : {
"data" : true,
"ingest" : true,
"master" : true,
"ml" : true
},
"size" : {
"resource" : "string",
"value" : 0
},
"topology_element_control" : {
"min" : {
"resource" : "string",
"value" : 0
}
},
"zone_count" : 0
}
],
"deployment_template" : {
"id" : "string",
"version" : "string"
},
"elasticsearch" : {
"curation" : {
"from_instance_configuration_id" : "string",
"to_instance_configuration_id" : "string"
},
"docker_image" : "string",
"enabled_built_in_plugins" : [
"string"
],
"node_attributes" : {
"some_property" : "string"
},
"system_settings" : {
"auto_create_index" : true,
"default_shards_per_index" : 0,
"destructive_requires_name" : true,
"enable_close_index" : true,
"monitoring_collection_interval" : 0,
"monitoring_history_duration" : "string",
"reindex_whitelist" : [
"string"
],
"scripting" : {
"expressions_enabled" : true,
"file" : {
"enabled" : true,
"sandbox_mode" : true
},
"inline" : {
"enabled" : true,
"sandbox_mode" : true
},
"mustache_enabled" : true,
"painless_enabled" : true,
"stored" : {
"enabled" : true,
"sandbox_mode" : true
}
},
"use_disk_threshold" : true,
"watcher_trigger_engine" : "string"
},
"user_bundles" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_plugins" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_settings_json" : {},
"user_settings_override_json" : {},
"user_settings_override_yaml" : "string",
"user_settings_yaml" : "string",
"version" : "string"
},
"tiebreaker_override" : true,
"tiebreaker_topology" : {
"memory_per_node" : 0
},
"transient" : {
"cluster_settings_json" : {},
"plan_configuration" : {
"calm_wait_time" : 0,
"cluster_reboot" : "string",
"extended_maintenance" : true,
"max_snapshot_age" : 0,
"max_snapshot_attempts" : 0,
"move_allocators" : [
{
"allocator_down" : true,
"from" : "string",
"to" : [
"string"
]
}
],
"move_instances" : [
{
"from" : "string",
"instance_down" : true,
"to" : [
"string"
]
}
],
"move_only" : true,
"override_failsafe" : true,
"preferred_allocators" : [
"string"
],
"reallocate_instances" : true,
"skip_data_migration" : true,
"skip_post_upgrade_steps" : true,
"skip_snapshot" : true,
"skip_snapshot_post_major_upgrade" : true,
"skip_upgrade_checker" : true,
"timeout" : 0
},
"remote_clusters" : {
"resources" : [
{
"alias" : "string",
"deployment_id" : "string",
"elasticsearch_ref_id" : "string",
"info" : {
"compatible" : true,
"connected" : true,
"healthy" : true,
"trusted" : true,
"trusted_back" : true
},
"skip_unavailable" : true
}
]
},
"restore_snapshot" : {
"repository_config" : {
"raw_settings" : {}
},
"repository_name" : "string",
"restore_payload" : {
"indices" : [
"string"
],
"raw_settings" : {}
},
"snapshot_name" : "string",
"source_cluster_id" : "string",
"strategy" : "string"
},
"strategy" : {
"autodetect" : {},
"grow_and_shrink" : {},
"rolling" : {
"allow_inline_resize" : true,
"group_by" : "string",
"shard_init_wait_time" : 0,
"skip_synced_flush" : true
},
"rolling_grow_and_shrink" : {}
}
},
"zone_count" : 0
}