KibanaClusterTopologyElement

edit

Defines the topology of the Kibana nodes (eg number/capacity of nodes, and where they can be allocated)

Properties

edit
allocator_filter (object)
DEPRECATED: Scheduled for removal in a future version of the API. Controls the allocation strategy of this node type using a simplified version of the Elasticsearch filter DSL (together with 'node_configuration')
instance_configuration_id (string)
Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
kibana (KibanaConfiguration)
memory_per_node (integer as int32)
The memory capacity in MB for each node of this type built in each zone.
node_configuration (string)
DEPRECATED: Scheduled for removal in a future version of the API. Controls the allocation strategy of this node type by pointing to the names of pre-registered allocator settings. Unless otherwise specified for this deployment, should be omitted.
node_count_per_zone (integer as int32)
The number of nodes of this type that are allocated within each zone (i.e. total capacity per zone = node_count_per_zone * memory_per_node in MB).
size (TopologySize)
The size of a topology measured by the amount of some resource. The final cluster size is calculated using multipliers from the topology's instance configuration
zone_count (integer as int32)
number of zones in which nodes will be placed

Example

edit
{
   "allocator_filter" : {},
   "instance_configuration_id" : "string",
   "kibana" : {
      "docker_image" : "string",
      "system_settings" : {
         "elasticsearch_password" : "string",
         "elasticsearch_url" : "string",
         "elasticsearch_username" : "string"
      },
      "user_settings_json" : {},
      "user_settings_override_json" : {},
      "user_settings_override_yaml" : "string",
      "user_settings_yaml" : "string",
      "version" : "string"
   },
   "memory_per_node" : 0,
   "node_configuration" : "string",
   "node_count_per_zone" : 0,
   "size" : {
      "resource" : "string",
      "value" : 0
   },
   "zone_count" : 0
}