fuel-plugin-elasticsearch-kibana/environment_config.yaml

attributes:

  retention_period:
    value: '30'
    label: 'Retention period'
    description: 'The number of days after which data is automatically deleted within the Elasticsearch system (0 to never delete data).'
    weight: 5
    type: "text"
    regex: &number_validation
        source: '^\d+$'
        error: "You must provide a number"

  # Parameter hidden in the UI on purpose
  # this directory must match the mount point set in volumes.yaml
  data_dir:
    value: '/opt/es-data'
    label: 'Elasticsearch directory'
    description: 'Directory used by elasticsearch to store data.'
    weight: 15
    type: "text"
    restrictions:
      - condition: "true"
        action: hide

  jvm_heap_size:
    value: '1'
    label: 'JVM heap size'
    description: 'in GB (between 1 and 32). The amount of memory reserved for the JVM.'
    weight: 16
    type: "text"
    regex:
      source: '^([1-9]|[12][0-9]|3[0-2])$'
      error: 'Enter a value between 1 and 32'

  kibana_username:
    value: 'lma'
    label: 'User name'
    description: 'The username to access Kibana.'
    weight: 17
    type: "text"
    regex:
      source: '\S'
      error: "You must provide a username."

  kibana_password:
    value:
      generator: 'password'
    label: 'User password'
    description: 'The password to access Kibana.'
    weight: 18
    type: "password"
    regex:
      source: '^[\S]{4,}$'
      error: "You must provide a password with at least 4 characters"

  advanced_settings:
    label: "Advanced settings"
    value: false
    description: "The plugin determines the best settings if not set"
    weight: 19
    type: checkbox

  number_of_replicas:
    value: ''
    label: 'Number of replicas'
    description: "The number of replicas must be less than the total number of Elasticsearch nodes (total number of Elasticsearch nodes - 1 by default)."
    weight: 20
    type: "text"
    regex:
      source: '^\d?$'
      error: "You must provide either a number or leave it empty"
    restrictions:
      - condition: "settings:elasticsearch_kibana.advanced_settings.value == false"
        action: hide

  minimum_master_nodes:
    value: ''
    label: 'Minimum number of master eligible nodes'
    description: 'This must be less than or equal to the total number of Elasticsearch nodes (total number of Elasticsearch nodes / 2 + 1 by default).'
    weight: 21
    type: "text"
    regex:
      source: '^\d?$'
      error: "You must provide either a number or leave it empty"
    restrictions:
      - condition: "settings:elasticsearch_kibana.advanced_settings.value == false"
        action: hide

  recover_after_nodes:
    value: ''
    label: 'Recover after nodes'
    description: "The number of nodes to wait before starting a recovery action following a cluster restart. This must be less than or equal to the total number of nodes in the cluster (2/3 of the total number of nodes by default)."
    weight: 22
    type: "text"
    regex:
      source: '^\d?$'
      error: "You must provide either a number or leave it empty"
    restrictions:
      - condition: "settings:elasticsearch_kibana.advanced_settings.value == false"
        action: hide

  recover_after_time:
    value: '5'
    label: 'Recover after time'
    description: 'The number of minutes the cluster should wait before starting a recovery action following a cluster restart.'
    weight: 23
    type: "text"
    regex:
      source: '^\d+$'
      error: "You must provide a number"
    restrictions:
      - condition: "settings:elasticsearch_kibana.advanced_settings.value == false"
        action: hide

# TLS Settings: BEGIN
  tls_enabled:
    value: false
    label: 'Enable TLS for Kibana'
    description: ''
    weight: 30
    type: "checkbox"

  kibana_hostname:
    value: 'kibana.fuel.local'
    label: 'DNS hostname for Kibana'
    description: 'Your DNS entries should point to this name.'
    weight: 40
    type: "text"
    restrictions:
      - condition: "settings:elasticsearch_kibana.tls_enabled.value == false"
        action: "hide"

  kibana_ssl_cert:
    value: ''
    label: 'Certificate for Kibana'
    description: 'Certificate and private key data, concatenated into a single file.'
    weight: 50
    type: "file"
    restrictions:
      - condition: "settings:elasticsearch_kibana.tls_enabled.value == false"
        action: "hide"
  # TLS Settings: END
  # LDAP Settings: BEGIN
  ldap_enabled:
    value: false
    label: 'Use LDAP for Kibana authentication'
    description: ''
    weight: 100
    type: "checkbox"

  ldap_protocol_for_kibana:
    type: "radio"
    value: 'ldap'
    weight: 110
    label: 'LDAP protocol'
    values:
      - data: "ldap"
        label: "LDAP"
      - data: "ldaps"
        label: "LDAPS"
    restrictions:
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: hide

  ldap_servers:
    value: ''
    label: 'LDAP servers'
    description: 'Specify one or several LDAP servers separated by space.'
    weight: 120
    type: "text"
    regex:
      source: '^\w[\w\-\s.]+$'
      error: "You must provide a hostname or IP"
    restrictions:
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: hide
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: disable

  ldap_server_port:
    value: ''
    label: 'Port'
    description: 'If empty, the default value is 389 for LDAP and 636 for LDAPS.'
    weight: 130
    type: "text"
    regex:
        source: '^\d{0,5}$'
        error: "You must provide a valid port number"
    restrictions:
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: hide
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: disable

  ldap_bind_dn:
    value: ''
    label: 'Bind DN'
    description: 'DN used to bind to the server when searching for entries.'
    weight: 140
    type: "text"
    regex: &not_empty_parameter
      source: '\S'
      error: "Invalid value"
    restrictions:
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: hide
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: disable

  ldap_bind_password:
    value: ''
    label: 'Bind password'
    description: 'Password to use in conjunction with the bind DN.'
    weight: 150
    type: "password"
    regex: *not_empty_parameter
    restrictions:
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: hide
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: disable

  ldap_user_search_base_dns:
    value: ''
    label: 'User search base DN'
    description: 'The base DN to search for users.'
    weight: 160
    type: "text"
    regex: *not_empty_parameter
    restrictions:
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: hide
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: disable

  ldap_user_attribute:
    value: 'uid'
    label: 'User search attribute'
    description: 'The attribute to search for.'
    weight: 165
    type: "text"
    regex: *not_empty_parameter
    restrictions:
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: hide
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: disable

  ldap_user_search_filter:
    value: '(objectClass=*)'
    label: 'User search filter'
    description: 'A valid LDAP search filter.'
    weight: 170
    type: "text"
    regex: *not_empty_parameter
    restrictions:
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: hide
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: disable

  ldap_authorization_enabled:
    value: false
    label: 'Enable group-based authorization'
    description: 'It allows to associate users with the Admin or Viewer role. Otherwise all users are assigned to Admin role by default.'
    weight: 200
    type: "checkbox"
    restrictions:
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: hide

  ldap_group_attribute:
    value: 'memberUid'
    label: 'LDAP group attribute'
    description: 'LDAP attribute used to identify the user members of groups.'
    weight: 205
    type: "text"
    regex: *not_empty_parameter
    restrictions:
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: hide
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: disable
      - condition: "settings:elasticsearch_kibana.ldap_authorization_enabled.value == false"
        action: disable

  ldap_admin_group_dn:
    value: ''
    label: 'Group DN mapping to the Admin role'
    description: ''
    weight: 210
    type: "text"
    regex: *not_empty_parameter
    restrictions:
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: hide
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: disable
      - condition: "settings:elasticsearch_kibana.ldap_authorization_enabled.value == false"
        action: disable

  ldap_viewer_group_dn:
    value: ''
    label: 'Group DN mapping to the Viewer role'
    description: ''
    weight: 220
    type: "text"
    regex: *not_empty_parameter
    restrictions:
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: hide
      - condition: "settings:elasticsearch_kibana.ldap_enabled.value == false"
        action: disable
      - condition: "settings:elasticsearch_kibana.ldap_authorization_enabled.value == false"
        action: disable
  # LDAP Settings: END