• Elastic Cloud Enterprise - Elastic Cloud on your Infrastructure: 3.83.73.63.53.43.33.23.13.02.2other versionsother versions: 3.83.73.63.53.43.33.23.13.02.132.122.112.102.92.82.72.62.52.42.32.22.12.01.11.0
• What is Elastic Cloud Enterprise?
  • Architecture
  • Basic terms
• Getting started
  • Quick start guide
  • Playbook for production
    • Example: A small baseline installation
    • Example: A medium installation with separate management services
    • Example: A large installation with separate management services and proxies
• Planning your installation
  • Choose the right host machines
  • Installation topology
  • Fault tolerance (high availability)
  • Separation of roles
  • Load balancers
  • Wildcard DNS record
  • Need more capacity?
  • Security considerations
  • Prerequisites
    • Hardware
    • Software
      • Linux distributions
      • File systems
    • Users
    • System Configuration
    • Networking
      • Outbound traffic
      • Inbound traffic
      • Hosts in multiple data centers
    • JVM heap sizes
• Preparing your environment
  • Ubuntu 14.04 LTS (Trusty Tahr)
  • Ubuntu 16.04 LTS (Xenial Xerus)
  • Red Hat Enterprise Linux (RHEL) 7 and CentOS 7
  • SUSE Linux Enterprise Server (SLES) 12
  • Amazon Machine Images (AMIs)
  • Google Cloud Platform (GCP)
  • Microsoft Azure virtual machines
    • Set Up Azure resource group and networking
    • Create your hosts
  • Ansible playbook
• Installing Elastic Cloud Enterprise
  • Install with internet access
  • Install without internet access
    • Install ECE Offline without your own Docker registry
  • Log into the Cloud UI
  • Post-installation steps
• Configuring your installation
  • System clusters configuration
  • Configure deployment templates
    • Tag your allocators
    • Edit instance configurations
    • Create instance configurations
    • Create deployment templates
    • Configure index management for templates
    • Default instance configurations
  • Manage snapshot repositories
    • Snapshotting to Google Cloud Storage (GCS) for Elasticsearch 6.x
    • Snapshotting to Azure Storage for Elasticsearch 5.x and 6.x
    • Snapshotting to Minio on-premise storage
  • Manage licenses
  • Change endpoint URLs
• Securing your installation
  • Security considerations
  • Generate roles tokens
  • Revoke roles tokens
  • Manage security certificates
  • Manage your IP filtering rule sets
  • Configure role-based access control
    • Add native users
    • Create LDAP provider profiles
    • Create SAML provider profiles
  • Manage system passwords
• Monitoring your installation
  • Access logs and metrics
  • Set the retention period for logging and metrics indices
  • Scenario: Knowing when you need more proxies
• Administering your installation
  • Scale out your installation
  • Assign roles to runners
  • Enable maintenance mode
  • Move nodes or instances from allocators
  • Delete runners
  • Perform host maintenance
  • Manage Elastic Stack versions
  • Upgrade your installation
• Getting started with deployments
  • Create your deployment
    • What are deployment templates?
    • Default template
    • Cross-cluster search template
    • Hot-warm architecture template
    • Customize your deployment
    • Configure index management
  • Access Kibana
  • Connect to Elasticsearch
  • Next steps
  • Migrating your Elasticsearch data
• Administering deployments
  • Change your deployment configuration
    • Resize your deployment
    • Add plugins
    • Add custom bundles and plugins to your deployment
    • Advanced cluster configuration
    • Migrate to index lifecycle management
  • Stop routing requests or pause nodes
  • Stop a deployment
  • Restart a deployment
  • Delete a deployment
  • Access the Elasticsearch API
  • Work with snapshots
  • Upgrade versions
    • Upgrade to Elasticsearch 7.x
    • Upgrade to Elasticsearch 6.x
    • Upgrade to Elasticsearch 5.x
  • Editing your user settings
    • Add Elasticsearch user settings
    • Add Kibana user settings
    • Add APM user settings
  • Configure Beats and Logstash with Cloud ID
  • Keep your clusters healthy
    • Finding deployments, finding problems
    • Access the Monitoring application in Kibana
  • Secure your clusters
    • Reset the password for the elastic user
    • Manage users and roles in X-Pack
    • Manage users and roles in Shield
    • Configure the Java Transport client
    • Filter IP traffic
    • Secure your settings
    • Secure your 7.x clusters with LDAP or Active Directory
    • Secure your 5.x and 6.x clusters with LDAP or Active Directory
    • Secure your clusters with SAML
      • Sign Outgoing SAML Message
      • Optional Settings
  • Manage your Kibana instance
  • Manage your APM Server
  • Enable Monitoring (formerly Marvel)
  • Enable Graph (versions before 5.0)
  • Connect to your cluster
  • Enable cross-cluster search
• Troubleshooting
  • Common issues
  • Using the emergency roles token
  • Removing Elastic Cloud Enterprise
  • Getting help
• RESTful API
  • Using the API
  • API examples
    • A first API call: What deployments are there?
      • A note on terminology
    • Create a first deployment: Just an Elasticsearch cluster
    • Applying a new plan: Resize and add high availability
    • Applying a new plan: Checking on progress
    • Applying a new deployment configuration: Upgrade
    • Enable more stack features: Add Kibana to a deployment
    • Dipping a toe into platform automation: Generate a roles token
    • Customize your deployment
      • Steps
    • Remove unwanted deployment templates and instance configurations
    • Secure your settings
      • Verify your credentials
  • API reference
    • Authentication
      • Disable elevated permissions
      • Enable elevated permissions
      • Login to ECE
      • Refresh authentication token
      • Available authentication methods
      • SAML callback
      • Initiate SAML protocol
    • Clusters - Apm - CRUD
      • Get clusters
      • Create cluster
      • Delete cluster
      • Get cluster
    • Clusters - Apm - CRUD - Configuration
      • Reset token
      • Set cluster name
      • Get cluster metadata
      • Set cluster metadata
      • Get cluster metadata settings
      • Update cluster metadata settings
      • Get plan
      • Update plan
      • Get plan activity
      • Cancel pending plan
      • Get pending plan
    • Clusters - Apm - Commands
      • Search clusters
      • Restart cluster
      • Resynchronize cluster
      • Shut down cluster
      • Upgrade cluster
      • Move instances (advanced)
      • Start all instances
      • Stop all instances
      • Start maintenance mode all instances
      • Stop maintenance mode all instances
      • Move instances
      • Start instances
      • Stop instances
      • Start maintenance mode
      • Stop maintenance mode
    • Clusters - Elasticsearch - CRUD
      • Get clusters
      • Create cluster
      • Search clusters that can be used as cross-cluster search remotes
      • Delete cluster
      • Get cluster
    • Clusters - Elasticsearch - CRUD - Configuration
      • Get cross-cluster search clusters
      • Get remote clusters for cross-cluster search
      • Set remote clusters for cross-cluster search
      • Get cluster curation settings
      • Update cluster curation settings
      • Set settings overrides (all instances)
      • Set settings overrides
      • Get settings from this cluster’s keystore
      • Add or remove settings from the cluster keystore
      • Set cluster name
      • Get cluster metadata
      • Set cluster metadata
      • Get cluster metadata settings
      • Update cluster metadata settings
      • Cancel monitoring
      • Set monitoring
      • Get plan
      • Update plan
      • Migrate plan
      • Get plan activity
      • Cancel pending plan
      • Get pending plan
      • Set legacy security settings
      • Get cluster snapshot settings
      • Update cluster snapshot settings
    • Clusters - Elasticsearch - Commands
      • Search clusters
      • Restart cluster
      • Resynchronize cluster
      • Shut down cluster
      • Take snapshot
      • Move instances (advanced)
      • Start all instances
      • Stop all instances
      • Start maintenance mode all instances
      • Stop maintenance mode all instances
      • Move instances
      • Start instances
      • Stop instances
      • Start maintenance mode
      • Stop maintenance mode
    • Clusters - Elasticsearch - Proxy
      • Proxies HTTP DELETE request to the cluster
      • Proxies HTTP GET request to the cluster
      • Proxies HTTP POST request to the cluster
      • Proxies HTTP PUT request to the cluster
    • Clusters - Elasticsearch - Support
      • Generate diagnostics
      • Generate logs
    • Clusters - Kibana - CRUD
      • Get clusters
      • Create cluster
      • Delete cluster
      • Get cluster
    • Clusters - Kibana - CRUD - Configuration
      • Set cluster name
      • Get cluster metadata
      • Set cluster metadata
      • Get cluster metadata settings
      • Update cluster metadata settings
      • Get plan
      • Update plan
      • Get plan activity
      • Cancel pending plan
      • Get pending plan
    • Clusters - Kibana - Commands
      • Search clusters
      • Restart cluster
      • Resynchronize cluster
      • Shut down cluster
      • Upgrade cluster
      • Move instances (advanced)
      • Start all instances
      • Stop all instances
      • Start maintenance mode all instances
      • Stop maintenance mode all instances
      • Move instances
      • Start instances
      • Stop instances
      • Start maintenance mode
      • Stop maintenance mode
    • Clusters - Kibana - Proxy
      • Proxy HTTP DELETE request
      • Proxy HTTP GET request
      • Proxy HTTP POST request
      • Proxy HTTP PUT request
    • Clusters - Search
      • Search clusters
    • Deployments - IP Filtering - CRUD
      • Get associated rulesets
      • Get all rulesets
      • Create a ruleset
      • Delete a ruleset
      • Get a ruleset
      • Updates a ruleset
      • Get associated deployments
      • Create ruleset association
      • Delete ruleset association
    • Deployments - Notes
      • Get deployment notes
      • Create deployment note
      • Delete deployment note
      • Get a deployment note
      • Update deployment note
    • Platform
      • Get platform
    • Platform - Allocators
      • Get allocators
      • Search allocators
      • Delete allocator
      • Get allocator
      • Resynchronize allocator
      • Move clusters
      • Move clusters by type
      • Start maintenance mode
      • Stop maintenance mode
      • Get allocator metadata
      • Set allocator metadata
      • Delete allocator metadata item
      • Set allocator metadata item
      • Get allocator settings
      • Update allocator settings
      • Set allocator settings
    • Platform - Configuration - Instances - CRUD
      • Get instance configurations
      • Create instance configuration
      • Delete a instance configuration
      • Get instance configuration
      • Set instance configuration
    • Platform - Configuration - Security
      • Get enrollment tokens
      • Create enrollment token
      • Delete enrollment token
    • Platform - Configuration - Security Deployment
      • Get current security deployment
      • Create security deployment
      • Disables the security deployment
      • Enables the security deployment
    • Platform - Configuration - Security Realms
      • List security realm configurations
      • Reorder security realms
      • Create LDAP configuration
      • Delete LDAP configuration
      • Get LDAP configuration
      • Update LDAP configuration
      • Create SAML configuration
      • Delete SAML configuration
      • Get SAML configuration
      • Update SAML configuration
    • Platform - Configuration - TLS
      • Get TLS certificate
      • Set TLS certificate
    • Platform - Constructors
      • Get constructors
      • Get constructor
      • Resynchronize constructor
      • Start maintenance mode
      • Stop maintenance mode
    • Platform - License
      • Delete license
      • Get license
      • Add or update license
    • Platform - Repository - CRUD
      • Get snapshot repositories
      • Delete snapshot repository
      • Get snapshot repository
      • Set snapshot repository
    • Platform - Runners
      • Get runners
      • Search runners
      • Delete runner
      • Get runner
      • Resynchronize runner
      • Set runner roles
    • Platform - configuration - Store
      • List Config Store Option
      • Delete Config Store Option by name
      • Find Config Store Option by name
      • Create Config Store Option
      • Update Config Store Option
    • Platform - proxies
      • Get proxies
      • Create filtered group of proxies
      • Delete filtered group of proxies
      • Get filtered group of proxies
      • Update filtered group of proxies
      • Get health for a filtered group of proxies
      • Get proxy health
      • Get proxies settings
      • Update proxy settings
      • Set proxy settings
      • Get proxy
    • Stack - Instance Types - CRUD
      • Get instance types
    • Stack - Versions - CRUD
      • Get stack versions
      • Upload stack pack
      • Delete stack version
      • Get stack version
      • Update stack version
    • Templates - Deployments
      • Get deployment templates
      • Create deployment template
      • Delete deployment template
      • Get deployment template
      • Set deployment template
    • Definitions
      • AllocatedInstancePlansInfo
      • AllocatedInstanceStatus
      • AllocatorBuildInfo
      • AllocatorCapacity
      • AllocatorCapacityMemory
      • AllocatorHealthStatus
      • AllocatorInfo
      • AllocatorMoveRequest
      • AllocatorOverview
      • AllocatorSettings
      • AllocatorZoneInfo
      • ApmConfiguration
      • ApmCrudResponse
      • ApmInfo
      • ApmPlan
      • ApmPlanControlConfiguration
      • ApmPlanInfo
      • ApmPlansInfo
      • ApmSettings
      • ApmSubInfo
      • ApmSystemSettings
      • ApmTopologyElement
      • ApmsInfo
      • AvailableAuthenticationMethods
      • BasicFailedReply
      • BasicFailedReplyElement
      • BoolQuery
      • CapacityConstraintsResource
      • ChangeSourceInfo
      • ClusterCommandResponse
      • ClusterCredentials
      • ClusterCrudResponse
      • ClusterCurationSettings
      • ClusterCurationSpec
      • ClusterInfo
      • ClusterInstanceConfigurationInfo
      • ClusterInstanceDiskInfo
      • ClusterInstanceInfo
      • ClusterInstanceMemoryInfo
      • ClusterLicenseInfo
      • ClusterMetadataCpuResourcesSettings
      • ClusterMetadataInfo
      • ClusterMetadataPortInfo
      • ClusterMetadataResourcesSettings
      • ClusterMetadataSettings
      • ClusterPlanMigrationResponse
      • ClusterPlanStepInfo
      • ClusterPlanStepLogMessageInfo
      • ClusterSnapshotRepositoryDefault
      • ClusterSnapshotRepositoryInfo
      • ClusterSnapshotRepositoryReference
      • ClusterSnapshotRepositoryStatic
      • ClusterSnapshotRequest
      • ClusterSnapshotResponse
      • ClusterSnapshotRetention
      • ClusterSnapshotSettings
      • ClusterSystemAlert
      • ClusterTopologyInfo
      • ClusterUpgradeInfo
      • ClustersInfo
      • CompatibleNodeTypesResource
      • CompatibleVersionResource
      • ConfigStoreOption
      • ConfigStoreOptionData
      • ConfigStoreOptionList
      • ConstructorHealthStatus
      • ConstructorInfo
      • ConstructorOverview
      • CreateApmInCreateElasticsearchRequest
      • CreateApmRequest
      • CreateElasticsearchClusterRequest
      • CreateKibanaInCreateElasticsearchRequest
      • CreateKibanaRequest
      • CrossClusterSearchClusters
      • CrossClusterSearchInfo
      • CrossClusterSearchSettings
      • DeploymentTemplateInfo
      • DeploymentTemplateReference
      • DiscreteSizes
      • ElasticsearchClusterBlockingIssueElement
      • ElasticsearchClusterBlockingIssues
      • ElasticsearchClusterInfo
      • ElasticsearchClusterInstanceSettingsOverrides
      • ElasticsearchClusterPlan
      • ElasticsearchClusterPlanInfo
      • ElasticsearchClusterPlansInfo
      • ElasticsearchClusterRole
      • ElasticsearchClusterSecurityInfo
      • ElasticsearchClusterSettings
      • ElasticsearchClusterTopologyElement
      • ElasticsearchClusterUser
      • ElasticsearchClustersInfo
      • ElasticsearchConfiguration
      • ElasticsearchCuration
      • ElasticsearchInfo
      • ElasticsearchMasterElement
      • ElasticsearchMasterInfo
      • ElasticsearchMonitoringInfo
      • ElasticsearchNodeType
      • ElasticsearchPlanControlConfiguration
      • ElasticsearchReplicaElement
      • ElasticsearchScriptTypeSettings
      • ElasticsearchScriptingUserSettings
      • ElasticsearchShardElement
      • ElasticsearchShardsInfo
      • ElasticsearchSystemSettings
      • ElasticsearchUserBundle
      • ElasticsearchUserPlugin
      • ElevatePermissionsRequest
      • EmptyResponse
      • EnrollmentTokenRequest
      • ExistsQuery
      • ExternalHyperlink
      • FilterAssociation
      • GrowShrinkStrategyConfig
      • Hyperlink
      • IdResponse
      • InstanceConfiguration
      • InstanceMoveRequest
      • InstanceTypeResource
      • IpFilterRule
      • IpFilterRuleset
      • IpFilterRulesets
      • IpFilteringSettings
      • KeystoreContents
      • KeystoreSecret
      • KibanaClusterInfo
      • KibanaClusterPlan
      • KibanaClusterPlanInfo
      • KibanaClusterPlansInfo
      • KibanaClusterSettings
      • KibanaClusterTopologyElement
      • KibanaClustersInfo
      • KibanaConfiguration
      • KibanaPlanControlConfiguration
      • KibanaSubClusterInfo
      • KibanaSystemSettings
      • LdapGroupSearch
      • LdapSecurityRealmLoadBalance
      • LdapSecurityRealmRoleMappingRule
      • LdapSecurityRealmRoleMappingRules
      • LdapSettings
      • LdapUserSearch
      • LegacySecuritySettings
      • LicenseInfo
      • LicenseObject
      • ListEnrollmentTokenElement
      • ListEnrollmentTokenReply
      • LoginRequest
      • LoginState
      • ManagedMonitoringSettings
      • MatchAllQuery
      • MatchNoneQuery
      • MatchQuery
      • MetadataItem
      • MetadataItemValue
      • MetadataItems
      • MoveApmClusterConfiguration
      • MoveApmClusterDetails
      • MoveClustersCommandResponse
      • MoveClustersDetails
      • MoveClustersRequest
      • MoveElasticsearchClusterConfiguration
      • MoveElasticsearchClusterDetails
      • MoveKibanaClusterConfiguration
      • MoveKibanaClusterDetails
      • NestedQuery
      • NodeTypeResource
      • Note
      • Notes
      • PlanStrategy
      • PlatformInfo
      • PlatformServiceImageInfo
      • PlatformServiceInfo
      • PrefixQuery
      • ProxiesAllocationsInfo
      • ProxiesFilter
      • ProxiesFilteredGroup
      • ProxiesFilteredGroupHealth
      • ProxiesHealth
      • ProxiesHttpSettings
      • ProxiesSSOSettings
      • ProxiesSettings
      • ProxyAllocationCounts
      • ProxyAllocationInfo
      • ProxyInfo
      • ProxyOverview
      • QueryContainer
      • QueryStringQuery
      • RangeQuery
      • RemoteClusterInfo
      • RemoteClusterRef
      • RepositoryConfig
      • RepositoryConfigs
      • RequestEnrollmentTokenReply
      • RestoreSnapshotApiConfiguration
      • RestoreSnapshotConfiguration
      • RestoreSnapshotRepoConfiguration
      • RollingGrowShrinkStrategyConfig
      • RollingStrategyConfig
      • RuleSetResponse
      • RulesetAssociations
      • RunnerBuildInfo
      • RunnerContainerInfo
      • RunnerInfo
      • RunnerOverview
      • RunnerRoleInfo
      • RunnerRolesInfo
      • SamlAttributeSettings
      • SamlIdpSettings
      • SamlSecurityRealmRoleMappingRule
      • SamlSecurityRealmRoleMappingRules
      • SamlSettings
      • SamlSpSettings
      • SearchRequest
      • SecurityDeployment
      • SecurityDeploymentCreateRequest
      • SecurityDeploymentTopology
      • SecurityRealmInfo
      • SecurityRealmInfoList
      • SecurityRealmsReorderRequest
      • SnapshotRepositoryConfiguration
      • SnapshotStatusInfo
      • StackVersionApmConfig
      • StackVersionArchiveProcessingError
      • StackVersionArchiveProcessingResult
      • StackVersionConfig
      • StackVersionConfigPost
      • StackVersionConfigs
      • StackVersionElasticsearchConfig
      • StackVersionInstanceCapacityConstraint
      • StackVersionKibanaConfig
      • StackVersionMetadata
      • StackVersionNodeType
      • StackVersionTemplateFileHash
      • StackVersionTemplateInfo
      • TargetElasticsearchCluster
      • TermQuery
      • TiebreakerTopologyElement
      • TlsPublicCertChain
      • TokenResponse
      • TopologySize
      • TransientApmPlanConfiguration
      • TransientElasticsearchPlanConfiguration
      • TransientKibanaPlanConfiguration
      • UsageStats
• Script reference
  • elastic-cloud-enterprise.sh install
  • elastic-cloud-enterprise.sh upgrade
  • elastic-cloud-enterprise.sh reset-adminconsole-password
  • elastic-cloud-enterprise.sh add-stack-version
  • elastic-cloud-enterprise.sh set-logging-and-metrics-policy
• Release notes
  • Elastic Cloud Enterprise 2.2.3
  • Elastic Cloud Enterprise 2.2.2
  • Elastic Cloud Enterprise 2.2.1
  • Elastic Cloud Enterprise 2.2.0
  • Elastic Cloud Enterprise 2.1.1
  • Elastic Cloud Enterprise 2.1.0
  • Elastic Cloud Enterprise 2.0.1
  • Elastic Cloud Enterprise 2.0.0
  • Elastic Cloud Enterprise 1.1.5
  • Elastic Cloud Enterprise 1.1.4
  • Elastic Cloud Enterprise 1.1.3
  • Elastic Cloud Enterprise 1.1.2
  • Elastic Cloud Enterprise 1.1.1
  • Elastic Cloud Enterprise 1.1.0
  • Elastic Cloud Enterprise 1.0.2
  • Elastic Cloud Enterprise 1.0.1
  • Elastic Cloud Enterprise 1.0.0
  • Limitations and known problems
• What’s new with the Elastic Stack
  • Elastic Stack 7.5.1 released
  • Elastic Stack 7.5.0 released
  • Elastic Stack 7.4.2 released
  • Elastic Stack 7.4.1 released
  • Elastic Stack 7.4.0 released
  • Elastic Stack 7.3.2 released
  • Elastic Stack 7.3.1 released
  • Elastic Stack 7.3.0 released
  • Elastic Stack 7.2.1 and 6.8.2 released
  • Elastic Stack 7.2.0 released
  • Elastic Stack 7.1.1 released
  • Elastic Stack 7.1.0 released
  • Elastic Stack 7.0.1 released
  • Elastic Stack 7.0.0 released
  • Elastic Stack 6.8.6 released
  • Elastic Stack 6.8.5 released
  • Elastic Stack 6.8.4 released
  • Elastic Stack 6.8.3 released
  • Elastic Stack 6.8.1 released
  • Elastic Stack 6.8.0 released
  • Elastic Stack 6.7.2 released
  • Elastic Stack 6.7.1 released
  • Elastic Stack 6.7.0 released
  • Elastic Stack 6.6.2 released
  • Elastic Stack 6.6.0 released
  • Elastic Stack 6.5.4 released
  • Elastic Stack 5.6.14 and 6.5.3 released
  • Elastic Stack 6.5.2 released
  • Elastic Stack 6.5.1 released
  • Elastic Stack 6.5.0 released
  • Elastic Stack 5.6.13 and 6.4.3 released
  • Elastic Stack 5.6.11 and 6.4.0 released
  • Elastic Stack 6.3.2 released
  • Elastic Stack 6.3.1 released
  • Known issue affecting 5.6.10 to 6.3.0 upgrades
  • Elastic Stack 5.6.10 and 6.3.0 released
• About this product
  • Statistics collected by Elastic Cloud Enterprise
  • Third-party software dependencies