We use cookies and other similar technology to collect data to improve your experience on our site, as described in our Privacy Policy.

AppsCode
  • KubeDB

    Run Production-Grade Databases on Kubernetes

    arrow_forward
    Stash

    Backup and Recovery Solution for Kubernetes

    arrow_forward
    KubeVault

    Run Production-Grade Vault on Kubernetes

    arrow_forward
    Voyager

    Secure HAProxy Ingress Controller for Kubernetes

    arrow_forward
    ConfigSyncer

    Kubernetes Configuration Syncer

    arrow_forward
    Guard

    Kubernetes Authentication WebHook Server

    arrow_forward
    KubeDB

    KubeDB simplifies Provision, Upgrade, Scaling, Volume Expansion, Monitor, Backup, Restore for various Databases in Kubernetes on any Public & Private Cloud

    • task_altLower administrative burden
    • task_altNative Kubernetes Support
    • task_altPerformance
    • task_altAvailability and durability
    • task_altManageability
    • task_altCost-effectiveness
    • task_altSecurity
    Stash

    A complete Kubernetes native disaster recovery solution for backup and restore your volumes and databases in Kubernetes on any public and private clouds.

    • task_altDeclarative API
    • task_altBackup Kubernetes Volumes
    • task_altBackup Database
    • task_altMultiple Storage Support
    • task_altDeduplication
    • task_altData Encryption
    • task_altVolume Snapshot
    • task_altPolicy Based Backup
    KubeVault

    KubeVault is a Git-Ops ready, production-grade solution for deploying and configuring Hashicorp's Vault on Kubernetes.

    • task_altVault Kubernetes Deployment
    • task_altAuto Initialization & Unsealing
    • task_altVault Backup & Restore
    • task_altConsume KubeVault Secrets with CSI
    • task_altManage DB Users Privileges
    • task_altStorage Backend
    • task_altAuthentication Method
    • task_altDatabase Secret Engine
    Voyager

    Secure HAProxy Ingress Controller for Kubernetes

    • task_altHTTP & TCP
    • task_altSSL
    • task_altPlatform support
    • task_altHAProxy
    • task_altPrometheus
    • task_altLet's Encrypt
    configsyncer

    Kubernetes Configuration Syncer

    • task_altConfiguration Syncer
    Guard

    Kubernetes Authentication WebHook Server

    • task_altIdentity Providers
    • task_altCLI
    • task_altRBAC
  • RESOURCES
  • Webinar New
CONTACT SALES
KubeDB KubeDB
github-icon twitterx-icon
TRY NOW FREE
You are looking at the documentation of a prior release. To read the documentation of the latest release, please visit here.

New to KubeDB? Please start here.

Using Custom Configuration File

KubeDB supports providing custom configuration for an Elasticsearch cluster. This tutorial will give you an overview of how custom configuration files for an Elasticsearch cluster are managed in KubeDB.

Overview

Elasticsearch is configured using elasticsearch.yml file. In KubeDB, this file is located in /elasticsearch/config directory of elasticsearch pods. To know more about configuring the Elasticsearch cluster see here.

KubeDB allows users to provide 4 different configuration files. These are,

  1. master-config.yml
  2. client-config.yml
  3. data-config.yml
  4. common-config.yml

master-config.yml: Users can provide master node specific configuration in this file. This configuration will be applied to all master nodes.

client-config.yml: Users can provide client/ingest node specific configuration in this file. This configuration will be applied to all client nodes.

data-config.yml: Users can provide data node specific configuration in this file. This configuration will be applied to all data nodes.

common-config.yml: The user can provide a common configuration file. This configuration will be applied to all nodes in the Elasticsearch cluster.

As KubeDB provides two different way to create an Elasticsearch cluster, this custom configuration will be applied according to respective modes. These are:

  1. With Topology
  2. Without Topology

With Topology: When users create an Elasticsearch cluster using KubeDB specifying spec.topology field, KubeDB creates Elasticsearch nodes according to the specification. In this case, the custom configuration will be applied according to node rule. i.e. configuration of master-config.yml file will be applied to only master nodes and so on. However, configuration of common-config.yml file will be applied to all nodes.

Without Topology: When users create an Elasticsearch cluster using KubeDB without specifying spec.topology field, KubeDB creates all nodes as combined node, i.e., every node acts as master, client and data node. In this case, configuration from all configuration files will be merged and applied to all nodes. If the same configuration key appears in more than one configuration file, the value from the highest precedence configuration file will be used in elasticsearch.yml. The precedence order of configuration files from lowest to highest is:

  1. common-config.yml
  2. data-config.yml
  3. client-config.yml
  4. master-config.yml

common-config.yml has the lowest precedence and master-config.yml has the highest precedence.

How to Provide Configuration Files

At first, you have to create configuration files with name specified earlier with your desired configuration. Then you have to put these files into a volume. You have to specify this volume in spec.configSecret section while creating Elasticsearch crd. KubeDB will mount this volume into /elasticsearch/custom-config directory of the elasticsearch pod. Configurations from these files will be merged to elasticsearch.yml file according to cluster mode described earlier. Finally, Elasticsearch server will use this configuration file.

Next Steps

  • Learn how to use custom configuration specifying topology from here.
  • Learn how to use custom configuration without specifying topology from here.

What's on this Page

Search
Improve This Page