elastic/elasticsearch

Support YAML anchors in elasticsearch.yml

Open

#51,652 opened on Jan 29, 2020

View on GitHub
 (4 comments) (3 reactions) (0 assignees)Java (76,700 stars) (25,882 forks)batch import
:Core/Infra/Settings>enhancementTeam:Core/Infrahelp wantedtriaged

Description

I wonder whether we should support YAML anchors.

Here is an example which I believe is not supported:

xpack:
  security:
    enabled: true
  http:
    ssl:
      enabled: true
      keystore: &keystore
      path: /usr/share/elasticsearch/config/keystore.p12
      type: PKCS12
      password: ${ES_SECRET}
      key_password: ${ES_SECRET}
  transport:
    ssl:
      enabled: true
      verification_mode: certificate
      keystore: *keystore
      truststore:
        path: /usr/share/elasticsearch/config/truststore.p12
        type: PKCS12
        password: ${ES_SECRET}

The example defines the &keystore "anchor" which is then referred to by the *keystore alias.

Contributor guide

Tech stack
java
Domain
backend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
YAML anchors specElasticsearch config parsingJavaSnakeYAML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Investigate how Elasticsearch currently parses elasticsearch.yml. The YAML parsing is likely done with SnakeYAML. Check if SnakeYAML supports anchors natively; if not, consider upgrading or adding anchor resolution. Look at the Yaml class in the config module. There are 4 comments suggesting alternative approaches. No linked PRs. This is a feature request that requires familiarity with YAML spec and Elasticsearch's config loading.