Docs
  • Release notes
  • Troubleshoot
  • Reference
  • Elastic fundamentals
  • Solutions and use cases
  • Manage data
  • Explore and analyze
  • Deploy and manage
  • Manage your Cloud account and preferences
  • Troubleshoot
  • Release notes
  • Reference
  • Extend and contribute
  • Contribute to the docs
  • Deploy
    • Detailed deployment comparison
    • Elastic Cloud
      • Compare Cloud Hosted and Serverless
      • Sign up
        • Subscribe from a marketplace
          • AWS Marketplace
          • Azure Native ISV Service
          • Google Cloud Platform Marketplace
          • Heroku
            • Install the add-on
              • Remove the add-on
            • Access the console
            • Work with Elasticsearch
            • Migrate between plans
            • Hardware
            • Regions
      • Elastic Cloud Serverless
        • Create a serverless project
        • Regions
        • Project settings
        • Manage projects with API
      • Elastic Cloud Hosted
        • Create an Elastic Cloud Hosted deployment
          • Available stack versions
        • Access Kibana
        • Plan for production
        • Manage deployments
          • Configure
            • Manage hardware profiles
              • Customize instance configuration
            • Customize deployment components
            • Edit Elastic Stack settings
            • Add plugins and extensions
              • Upload custom plugins and bundles
              • Manage plugins and extensions through the API
            • Custom endpoint aliases
          • Manage Integrations Server
            • Switch from APM to Integrations Server
          • Find your Cloud ID
        • vCPU boosting and credits
        • Manage deployments using the Elastic Cloud API
        • Keep track of deployment activity
        • Restrictions and known problems
      • Tools and APIs
    • Elastic Cloud Enterprise
      • Service-oriented architecture
      • Deploy an orchestrator
        • Prepare your environment
          • Hardware prerequisites
          • Software prerequisites
          • System configuration
          • Networking prerequisites
          • Users and permissions prerequisites
          • High availability
          • Separation of roles
          • Load balancers
          • JVM heap size
          • Wildcard DNS record
        • Install ECE
          • Identify the deployment scenario
          • Configure your operating system
            • Ubuntu
            • RHEL
            • SUSE
          • Installation procedures
            • Deploy a small installation
            • Deploy a medium installation
            • Deploy a large installation
            • Deploy using Podman
            • Migrate ECE to Podman hosts
              • Migrating to Podman 5
          • Post-installation steps
          • Install ECE on additional hosts
            • Manage roles tokens
          • Ansible playbook
          • Statistics collected by Elastic Cloud Enterprise
        • Air-gapped install
          • With your private Docker registry
          • Without a private Docker registry
          • Available Docker images
        • Configure ECE
          • Assign roles to hosts
          • System deployments configuration
            • Default system deployment versions
          • Manage deployment templates
            • Tag your allocators
            • Edit instance configurations
            • Create instance configurations
            • Create templates
            • Configure default templates
            • Configure index management
            • Data tiers and autoscaling support
            • Integrations server support
            • Default instance configurations
          • Change the ECE API URL
          • Change endpoint URLs
          • Enable custom endpoint aliases
          • Manage your allocators capacity
          • Configure allocator affinity
          • Change allocator disconnect timeout
          • Manage Elastic Stack versions
          • Include additional Kibana plugins
      • Log into the Cloud UI
      • Manage deployments
        • Deployment templates
        • Create a deployment
        • Access Kibana
        • Connect to Elasticsearch
        • Configure
          • Customize deployment components
          • Edit stack settings
            • Elasticsearch user settings
            • Kibana user settings
            • APM user settings
            • Enterprise search user settings
          • Resize deployment
          • Add plugins and extensions
          • Add custom bundles and plugins
          • Custom endpoint aliases
          • Resource overrides
          • Advanced cluster configuration
        • Search and filter deployments
        • Keep track of deployment activity
        • Manage Integrations Server
          • Enable Integrations Server through the API
          • Switch from APM to Integrations Server
      • Tools and APIs
    • Elastic Cloud on Kubernetes
      • Deploy an orchestrator
        • Install
          • YAML manifests
          • Helm chart
          • Required RBAC permissions
          • Deploy ECK on Openshift
            • Deploy the operator
            • Deploy an Elasticsearch instance with a route
            • Deploy a Kibana instance with a route
            • Deploy Docker images with anyuid SCC
            • Grant privileged permissions to Beats
            • Grant host access permission to Elastic Agent
          • Deploy ECK on GKE Autopilot
          • FIPS compatibility
        • Air-gapped environments
        • Configure
          • Apply configuration settings
          • Configure the validating webhook
          • Restrict cross-namespace resource associations
          • Service meshes
            • Istio
            • Linkerd
          • Webhook namespace selectors
      • Manage deployments
        • Deploy an Elasticsearch cluster
        • Deploy a Kibana instance
        • Elastic Stack Helm chart
        • Applying updates
        • Accessing services
        • Configure deployments
          • Elasticsearch configuration
            • Nodes orchestration
            • Storage recommendations
            • Node configuration
            • Volume claim templates
            • Virtual memory
            • Settings managed by ECK
            • Custom configuration files and plugins
            • Init containers for plugin downloads
            • Update strategy
            • Pod disruption budget
            • Advanced Elasticsearch node scheduling
            • Readiness probe
            • Pod PreStop hook
            • Security context
            • Requests routing to Elasticsearch nodes
          • Kibana configuration
            • Connect to an Elasticsearch cluster
            • Advanced configuration
            • Install Kibana plugins
          • Customize pods
          • Propagate labels and annotations
          • Manage compute resources
          • Recipes
          • Connect to external Elastic resources
          • Elastic Stack configuration policies
      • Orchestrate other Elastic applications
        • APM server
          • Use an Elasticsearch cluster managed by ECK
          • Advanced configuration
          • Connect to the APM Server
        • Standalone Elastic Agent
          • Quickstart
          • Configuration
          • Configuration examples
        • Fleet-managed Elastic Agent
          • Quickstart
          • Configuration
          • Configuration examples
          • Known limitations
        • Elastic Maps Server
          • Deploy Elastic Maps Server
          • Map data
          • Advanced configuration
          • Elastic Maps HTTP configuration
        • Beats
          • Quickstart
          • Configuration
          • Configuration examples
          • Troubleshooting
        • Logstash
          • Quickstart
          • Configuration
          • Securing Logstash API
          • Logstash plugins
          • Configuration examples
          • Update strategy
          • Advanced configuration
      • Create custom images
      • Tools and APIs
    • Self-managed cluster
      • Deploy an Elasticsearch cluster
        • Local installation (quickstart)
        • Important system configuration
          • Configure system settings
          • Disable swapping
          • Increase the file descriptor limit
          • Increase virtual memory
          • Increase max number of threads
          • Ensure JNA temporary directory permits executables
          • Decrease the TCP retransmission timeout
          • Bootstrap checks
        • Install on Linux or MacOS
        • Install on Windows
        • Install with Debian package
        • Install with RPM package
        • Install with Docker
          • Single-node cluster
          • Multi-node cluster
          • Production settings
          • Configure
      • Configure Elasticsearch
        • Important settings configuration
        • Add plugins
      • Install Kibana
        • Linux and MacOS
        • Windows
        • Debian
        • RPM
        • Docker
      • Configure Kibana
      • Access Kibana
      • Air gapped install
      • Tools and APIs
  • Distributed architecture
    • Clusters, nodes, and shards
      • Node roles
    • Reading and writing documents
    • Shard allocation, relocation, and recovery
      • Shard allocation awareness
      • Index-level shard allocation
        • Delaying allocation when a node leaves
    • The shard request cache
    • Discovery and cluster formation
      • Discovery
      • Quorum-based decision making
      • Voting configurations
      • Bootstrapping a cluster
      • Cluster state
      • Cluster fault detection
    • Kibana task management
  • Production guidance
    • Run Elasticsearch in production
      • Design for resilience
        • Resilience in small clusters
        • Resilience in larger clusters
        • Resilience in ECH and ECE
      • Scaling considerations
      • Performance optimizations
        • General recommendations
        • Tune for indexing speed
        • Tune for search speed
        • Tune approximate kNN search
        • Tune for disk usage
        • Size your shards
    • Run Kibana in production
      • High availability and load balancing
      • Configure memory
      • Manage background tasks
      • Traffic scaling considerations
      • Optimize alerting performance
      • Reporting production considerations
  • Reference architectures
    • Hot/Frozen - High Availability
  • Stack settings
  • Backup, high availability, and resilience tools
    • Snapshot and restore
      • Manage snapshot repositories
        • Self-managed
          • Azure repository
          • Google Cloud Storage repository
          • S3 repository
          • Shared file system repository
          • Read-only URL repository
          • Source-only repository
        • Elastic Cloud Hosted
          • AWS S3
          • Google Cloud Storage
          • Azure Blob Storage
          • Access isolation for the found-snapshots repository
            • Azure
            • AWS and GCP
        • Elastic Cloud Enterprise
          • AWS S3 repository
          • Google Cloud Storage
          • Azure Storage repository
          • MinIO self-managed repository
        • Elastic Cloud on Kubernetes
      • Create, monitor and delete snapshots
      • Restore a snapshot
        • Restore a snapshot across clusters
          • Restore snapshot into a new deployment
          • Restore snapshot into an existing deployment
          • Restore snapshots containing searchable snapshots indices across clusters
      • Searchable snapshots
    • Cross-cluster replication
      • Set up cross-cluster replication
        • Prerequisites
        • Connect to a remote cluster
        • Configure privileges for cross-cluster replication
        • Create a follower index to replicate a specific index
        • Create an auto-follow pattern to replicate time series indices
      • Manage cross-cluster replication
        • Inspect replication statistics
        • Pause and resume replication
        • Recreate a follower index
        • Terminate replication
      • Manage auto-follow patterns
        • Create auto-follow patterns
        • Retrieve auto-follow patterns
        • Pause and resume auto-follow patterns
        • Delete auto-follow patterns
      • Upgrading clusters
        • Uni-directional index following
        • Bi-directional index following
      • Uni-directional disaster recovery
        • Prerequisites
        • Failover when clusterA is down
        • Failback when clusterA comes back
      • Bi-directional disaster recovery
        • Initial setup
        • Failover when clusterA is down
        • Failback when clusterA comes back
        • Perform update or delete by query
  • Autoscaling
    • In ECE and ECH
    • In ECK
    • Autoscaling deciders
    • Trained model autoscaling
  • Cloud Connect
  • Security
    • Secure your orchestrator
      • Elastic Cloud Enterprise
        • Manage security certificates
        • Allow x509 Certificates Signed with SHA-1
        • Configure the TLS version
        • Migrate ECE on Podman hosts to SELinux enforce
      • Elastic Cloud on Kubernetes
    • Secure your cluster, deployment, or project
      • Self-managed security setup
        • Automatic security setup
        • Minimal security setup
        • Set up transport TLS
        • Set up HTTPS
        • Configure security in Kibana
      • Manage TLS encryption
        • Self-managed
          • Update TLS certificates
            • With the same CA
            • With a different CA
          • Mutual authentication
          • Supported SSL/TLS versions by JDK version
          • Enabling cipher suites for stronger encryption
        • ECK
          • Manage HTTP certificates on ECK
          • Manage transport certificates on ECK
      • Network security
        • How network security policies work in Cloud
        • How IP filtering rules work in ECE
        • Add IP filters
          • In ECH or Serverless
          • In ECE
          • In ECK and Self Managed
        • Remote cluster filters
        • Private connectivity
          • AWS PrivateLink
          • Azure Private Link
          • GCP Private Service Connect
          • Claim private connection ownership
        • Through the API
        • Kubernetes network policies
      • Elastic Cloud Static IPs
      • Kibana session management
      • Encrypt your deployment data
        • Use a customer-managed encryption key
      • Secure your settings
        • Secure settings on ECK
      • Secure Kibana saved objects
      • Security event audit logging
        • Enable audit logging
        • Configure audit logging
          • Elasticsearch audit events ignore policies
          • Elasticsearch logfile output
        • Audit Elasticsearch search queries
        • Correlate audit events
    • Secure other Elastic Stack components
    • Securing HTTP client applications
    • Limitations
    • FIPS 140-2 compliance
      • FIPS compliance for Elasticsearch
      • FIPS compliance for Kibana
      • FIPS mode for Ingest tools
  • Users and roles
    • Cloud organization
      • Manage users
      • User roles and privileges
      • Configure SAML SSO
        • Okta
        • Microsoft Entra ID
    • ECE orchestrator
      • Manage system passwords
      • Manage users and roles
        • Native users
        • Active Directory
        • LDAP
        • SAML
      • Configure SSO for deployments
    • Serverless project custom roles
    • Cluster or deployment
      • Quickstart
      • User authentication
        • Authentication realms
          • Realm chains
          • Security domains
        • Internal authentication
          • Native
          • File-based
        • External authentication
          • Active Directory
          • JWT
          • Kerberos
          • LDAP
          • OpenID Connect
            • With Azure, Google, or Okta
          • SAML
            • With Microsoft Entra ID
          • PKI
          • Custom realms
        • Built-in users
          • Change passwords
        • Orchestrator-managed users
          • ECH and ECE
          • ECK managed credentials
        • Kibana authentication
        • Kibana access agreement
        • Anonymous access
        • Token-based authentication services
        • Service accounts
        • Internal users
        • Operator privileges
          • Configure operator privileges
          • Operator-only functionality
          • Operator privileges for snapshot and restore
        • User profiles
        • Looking up users without authentication
        • Controlling the user cache
        • Manage authentication for multiple clusters
      • User roles
        • Built-in roles
        • Defining roles
          • Role structure
          • For data streams and aliases
          • Using Kibana
          • Role restriction
        • Elasticsearch privileges
        • Kibana privileges
        • Map users and groups to roles
          • Role mapping properties
        • Authorization delegation
        • Authorization plugins
        • Control access at the document and field level
        • Submit requests on behalf of other users
  • Spaces
    • Using Spaces with Fleet
  • API keys
    • Elasticsearch API keys
    • Serverless project API keys
    • Elastic Cloud API keys
    • Elastic Cloud Enterprise API keys
  • Connectors
  • Remote clusters
    • On Elastic Cloud Hosted
      • To the same Elastic Cloud organization
      • To a different Elastic Cloud organization
      • To Elastic Cloud Enterprise
      • To a self-managed cluster
      • To Elastic Cloud on Kubernetes
      • Manage trusted environments
      • Migrate from the CCS deployment template
    • On Elastic Cloud Enterprise
      • To the same ECE environment
      • To a different ECE environment
      • To Elastic Cloud
      • To a self-managed cluster
      • To Elastic Cloud on Kubernetes
      • Manage trusted environments
      • Migrate from the CCS deployment template
    • On self-managed Elastic Stack
      • Add remote clusters using API key authentication
      • Add remote clusters using TLS certificate authentication
      • Migrate from certificate to API key authentication
    • On Elastic Cloud on Kubernetes
  • Monitoring
    • AutoOps
      • For Elastic Cloud Hosted
      • For self-managed clusters
        • Connect your self-managed cluster
        • Connect your local development cluster
        • Manage connected cluster users
        • FAQ
        • Troubleshooting
      • Regions
      • Events
        • Event Settings
        • Notifications Settings
      • Views
        • Overview
        • Deployment or Cluster
        • Nodes
        • Indices
        • Shards
        • Template Optimizer
      • FAQ
    • Stack monitoring
      • Enable on ECH and ECE
      • Enable on ECK
      • Self-managed: Elasticsearch
        • Collecting monitoring data with Elastic Agent
        • Collecting monitoring data with Metricbeat
        • Collecting log data with Filebeat
        • Monitoring in a production environment
        • Legacy collection methods
          • Collectors
          • Exporters
          • Local exporters
          • HTTP exporters
          • Pausing data collection
      • Self-managed: Kibana
        • Collect monitoring data with Elastic Agent
        • Collect monitoring data with Metricbeat
        • Legacy collection methods
      • Access monitoring data in Kibana
      • Visualizing monitoring data
        • Beats metrics
        • Elasticsearch metrics
        • Kibana metrics
        • Logstash metrics
        • Troubleshooting
      • Stack monitoring alerts
      • Configuring monitoring data streams and indices
        • Configuring data streams created by Elastic Agent
        • Configuring data streams created by Metricbeat 8
        • Configuring indices created by Metricbeat 7 or internal collection
    • AutoOps vs. Stack Monitoring
    • Cloud deployment health
      • Performance metrics on Elastic Cloud
      • JVM memory pressure indicator
    • Kibana task manager monitoring
    • Monitoring orchestrators
      • ECK operator metrics
        • Enabling the metrics endpoint
        • Securing the metrics endpoint
        • Prometheus requirements
      • ECE platform monitoring
        • Platform monitoring deployment logs and metrics
        • Proxy log fields
        • Set the retention period for logging and metrics indices
    • Logging
      • Elasticsearch log4j configuration