opendistro-for-elasticsearch / opendistro-build

🧰 Open Distro Build Scripts
https://opendistro.github.io/
Apache License 2.0
344 stars 175 forks source link

Helm README.md Security Configuration incorrect #758

Open mconner opened 3 years ago

mconner commented 3 years ago

Describe the bug The Helm README.md Security Configuration section shows:

or You can specify all the security configurations in the values.yaml file as

securityConfig:
  enabled: true
  path: "/usr/share/elasticsearch/plugins/opendistro_security/securityconfig"
  securityConfigSecret:
  data: {}
    # config.yml: |-
    # internal_users.yml: |-
    # roles.yml: |-
    # rolesMapping.yml: |-
    # tenants.yml: |-

However, the structure is actually expected to be:

securityConfig:
  enabled: true
  path: "/usr/share/elasticsearch/plugins/opendistro_security/securityconfig"
  config:
    securityConfigSecret:
    data: {}
    # config.yml: |-
    # internal_users.yml: |-
    # roles.yml: |-
    # rolesMapping.yml: |-
    # tenants.yml: |-

That is, there's a configbetween securityConfigand securityConfigSecret, as evidenced by es-security-config.yaml {{- if and .Values.elasticsearch.securityConfig.config.securityConfigSecret .Values.elasticsearch.securityConfig.config.data }}

To Reproduce Read the Helm README.md

Expected behavior Accurate documentation.

Configuration (please complete the following information): na

Relevant information