TransientElasticsearchPlanConfiguration

`TransientElasticsearchPlanConfiguration`

Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.

Properties

edit

cluster_settings_json (object)

If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).

indices.store.throttle.max_bytes_per_sec: 120Mb
indices.recovery.max_bytes_per_sec: 120Mb
cluster.routing.allocation.cluster_concurrent_rebalance: 5
cluster.routing.allocation.node_initial_primaries_recoveries: 5
cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.

plan_configuration (ElasticsearchPlanControlConfiguration)

The configuration settings for the timeout and fallback parameters.

remote_clusters (RemoteResources)

The list of resources that will be configured as remote clusters

restore_snapshot (RestoreSnapshotConfiguration)

Restores a snapshot from a local or remote repository.

strategy (PlanStrategy)

The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

Example

edit

{
   "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_allocator_tags" : {
         "some_property" : "string"
      },
      "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" : {}
   }
}

« TransientAppSearchPlanConfiguration TransientEnterpriseSearchPlanConfiguration »