Skip to content

Punchplatform Kibana plugin Guide

Configuration

Exhaustive Punchplatform plugin configuration fields with description. To put at the end in <install_dir>/kibana-<version>/config/kibana.yml

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
# Enables Punch plugin and path. Display Punch button in Kibana
punchplatform.enabled: true

# Set temporary working directory for Punch plugin. Kibana must have write rights 
punchplatform.tmp_path: "<kibana-install-dir>/tmp"

# Enables documentation component
punchplatform.documentation.enabled: true

# set the Punch documentation root directory. 
# You can use "{{__dirname}}../../doc/html" if doc is installed in same level as Kibana
punchplatform.documentation.path: "../../doc/html"

# Set Zookeeper hosts to pull Punchplatform configuration
punchplatform.zookeeper.hosts: ["localhost:2181"]

# Set Zookeeper cluster name to pull Punchplatform configuration
punchplatform.zookeeper.cluster: "punchplatform-primary"

# Enables role based security. 
punchplatform.security.enabled: false
# Set default roles for unauthentifed user
punchplatform.security.roles: ["pp_plugin_view", "pp_data_extraction", "pp_configuration_view", "pp_configuration_edit", "pp_platform_channel_control", "pp_pml_view", "pp_pml_edit", "pp_pml_execute", "pp_testers_view"]

# Enables Punch tools component
punchplatform.tools.enabled: true

# Enables Data extraction component
punchplatform.extraction.enabled: true

# Set tenant name for all extraction performed from kibana
punchplatform.extraction.tenant: "punch"

# Set extraction elasticsearch index name. All extraction will be saved in this index.
punchplatform.extraction.index: "jobs"

# Set output directory to store extractions in case of CSV/JSON output
punchplatform.extraction.path: "<kibana-install-dir>/extractions"

# Set allowed extraction formats   
punchplatform.extraction.format: ['csv', 'json', 'elasticsearch']

# Set which node type to use for the data cluster between 'data_node' or 'client_node'. 
punchplatform.extraction.es_data_cluster.type: "data_node"

# Set data node hosts to use 
punchplatform.extraction.es_data_cluster.hosts: ["localhost"]

# Set port to use
punchplatform.extraction.es_data_cluster.port: 9200

# Set Elasticsearch-Hadoop settings. Must match following "key:value" regex: "/^(.+):(.+|)$/" (e.g: "es.nodes.type:data_node")
punchplatform.extraction.es_data_cluster.settings: []

# Elasticsearch metric node use by default same settings like elasticsearch data node.
# But you can overrides all settings:

# Set which node type to use for the data cluster between 'data_node' or 'client_node'. 
punchplatform.extraction.es_metric_cluster.type: "data_node"

# Set data node hosts to use 
punchplatform.extraction.es_metric_cluster.hosts: ["localhost"]

# Set port to use
punchplatform.extraction.es_metric_cluster.port: 9200

# Set index __suffix__ to store daily extraction metrics: (e.g.: "metrics" will produces "tenant-metrics-YYYY.MM.DD)
punchplatform.extraction.es_metric_cluster.index: 'metrics'

# Set elasticsearch cluster metrics name
punchplatform.extraction.es_metric_cluster.name: 'es_metrics'

# Set Elasticsearch-Hadoop settings. Must match following "key:value" regex: "/^(.+):(.+|)$/" (e.g: "es.nodes.type:data_node")
punchplatform.extraction.es_metric_cluster.settings: []

# Enables PML Studio component
punchplatform.job_editor.enabled: true

# Set tenant name for all PML performed from kibana PML Studio component
punchplatform.job_editor.tenant: "punch"

# Set PML studio jobs elasticsearch index name. All jobs will be saved in this index.
punchplatform.job_editor.index: "jobs"

# Set
punchplatform.job_editor.path: "<kibana-install-dir>/editor"

# Allows "Execute Foreground" from PML studio 
punchplatform.job_editor.foreground.enabled: true

# Allows "Execute Background" from PML studio 
punchplatform.job_editor.background.enabled: true

# Set Analytics background options. {{job}} will dynamically replaced by the effective job.
# You can set for example: ["--job", "{{job}}", "--spark-master", "spark://localhost:7077", "--deploy-mode", "cluster"]
punchplatform.analytics.background.options: ["--job", "{{job}}"]

# Set Analytics foreground options. {{job}} will dynamically replaced by the effective job.
# You can set for example: ["--job", "{{job}}", "--spark-master", "spark://localhost:7077", "--deploy-mode", "client"]
punchplatform.analytics.foreground.options: ["--job", "{{job}}"]

# Set Analytics scanner options.
punchplatform.analytics.scanner.options: []

# Enables Platform studio component
punchplatform.platform_editor.enabled: true

# Restricts to specifics tenants. Leaves empty for all tenants
punchplatform.platform_editor.tenants: ['mytenant']

# Enables channel management (start/stop/reload)
punchplatform.platform_editor.channels.enabled: true

You can also configure plugin using indentation and with only a few parameters modified:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
punchplatform:
  documentation:
    path: "/data/opt/punchplatform-documentation-5.5.3/doc/html"
  platform_editor:
    tenants: ["mytenant", "punch"]
  extraction:
    path: "/tmp/extractions"
    es_data_cluster:
      hosts: ["localhost"]
      port: 9200
      settings:
        - "es.index.read.missing.as.empty: yes"
        - "es.nodes.discovery: true"
        - "es.nodes.client.only: false"
        - "es.nodes.data.only: false"
        - "es.nodes.ingest.only: false"
        - "es.nodes.wan.only: false"
        - "es.http.timeout: 1m"
        - "es.nodes.resolve.hostname: true"
        - "es.nodes.path.prefix:"
    es_metric_cluster:
      hosts: ["127.0.0.1", "localhost"]
      port: 9200