Terraform Provider

Website: https://www.terraform.io
Mailing list: Google Groups

Requirements

Terraform 0.10.x
Go 1.9 (to build the provider plugin)

Usage

# For example, restrict kibana terraform provider to version 0.6.3 and use the default kibana version and configuration based on environment variables
provider "kibana" {
  version = "0.6.3"
}

# Connecting to Kibana 7.3.1
provider "kibana" {
  "kibana_version"  = "7.3.1"
  "kibana_username" = "admin"
  "kibana_password" = "123"
}

# Connecting to logz.io
provider "kibana" {
  "kibana_type"  = "KibanaTypeLogzio"
  "kibana_username" = "admin"
  "kibana_password" = "123"
}

# Connecting to logz.io using MFA
provider "kibana" {
  "kibana_type"       = "KibanaTypeLogzio"
  "kibana_username"   = "admin"
  "kibana_password"   = "123"
  "logzio_mfa_secret" = "MFSD56CBOEWGFRKTOE7WKMLRHEDXUMLY"
}

Argument Reference

In addition to generic provider arguments (e.g. alias and version), the following arguments are supported in the Kibana provider block:

kibana_version - (Optional) Version of kibana that is being configured see supported versions. If omitted, default value is 6.0.0.
kibana_type - (Optional) Type of Kibana back end, defaults to KibanaTypeVanilla which supports the standard open-source kibana distribution. To configure logz.io kibana use KibanaTypeLogzio
kibana_username - (Optional) username when authenticating with the Kibana API.
kibana_password - (Optional) password when authenticating with the Kibana API.
logzio_client_id - (Optional) client id used during authentication with logzio.
logzio_account_id - (Optional) logz.io account id.
logzio_mfa_secret - (Optional) MFA shared secret, create when signing up user account with MFA.
kibana_insecure - (Optional) Explicitly allow the provider to perform "insecure" SSL requests. If omitted, default value is false.

Supported kibana versions

Below is the list of kibana versions known to work

Standard Kibana:

5.5.3
6.2.1
6.3.2
6.4.1
7.3.1

Logzio kibana:

6.3.2

Authenticating with logz.io

Two modes are supported:

User name and password
User name and password + MFA

In both cases the logzio client id must be supplied, and can be found during login be inspecting the network traffic, this value is not considered sensitive and we have observed it is always kydHH8LqsLR6D6d2dlHTpPEdf0Bztz4c.

Building The Provider

Clone repository to: $GOPATH/src/github.com/ewilde/terraform-provider-kibana

$ mkdir -p $GOPATH/src/github.com/ewilde; cd $GOPATH/src/github.com/ewilde
$ git clone git@github.com:ewilde/terraform-provider-kibana

Enter the provider directory and build the provider

$ cd $GOPATH/src/github.com/ewilde/terraform-provider-kibana
$ ELK_VERSION=6.2.3 KIBANA_TYPE=KibanaTypeVanilla make build

Using the provider

Example creating saved search, visualization and dashboard resources

provider "kibana" {
}

data "kibana_index" "main" {
  filter {
    name = "title"
    values = ["logstash-*"]
  }
}

resource "kibana_search" "china" {
  name 	        = "Chinese origin - errors"
  description     = "Errors occured when source was from china"
  display_columns = ["_source"]
  sort_by_columns = ["@timestamp"]
  search {
    index   = "${data.kibana_index.main.id}"
    filters {
        match {
          field_name = "geo.src"
          query      = "CN"
          type       = "phrase"
        }
    }
    
    filters {
        match {
          field_name = "@tags"
          query      = "error"
          type       = "phrase"
        }
    }
  }
}

resource "kibana_visualization" "china_viz" {
	name 	            = "Chinese visualization - updated"
	description         = "Chinese error visualization - updated"
	saved_search_id     = "${kibana_search.china.id}"
	visualization_state = <<EOF
{
  "title": "Chinese search",
  "type": "gauge",
  "params": {
    "type": "gauge",
    "addTooltip": true,
    "addLegend": true,
    "gauge": {
      "verticalSplit": false,
      "extendRange": true,
      "percentageMode": false,
      "gaugeType": "Arc",
      "gaugeStyle": "Full",
      "backStyle": "Full",
      "orientation": "vertical",
      "colorSchema": "Green to Red",
      "gaugeColorMode": "Labels",
      "colorsRange": [
        {
          "from": 0,
          "to": 50
        },
        {
          "from": 50,
          "to": 75
        },
        {
          "from": 75,
          "to": 100
        }
      ],
      "invertColors": false,
      "labels": {
        "show": true,
        "color": "black"
      },
      "scale": {
        "show": true,
        "labels": false,
        "color": "#333"
      },
      "type": "meter",
      "style": {
        "bgWidth": 0.9,
        "width": 0.9,
        "mask": false,
        "bgMask": false,
        "maskBars": 50,
        "bgFill": "#eee",
        "bgColor": false,
        "subText": "",
        "fontSize": 60,
        "labelColor": true
      }
    }
  },
  "aggs": [
    {
      "id": "1",
      "enabled": true,
      "type": "count",
      "schema": "metric",
      "params": {}
    }
  ]
}
EOF
}

resource "kibana_dashboard" "china_dash" {
	name = "Chinese dashboard"
	description = "Chinese dashboard description"
	panels_json = <<EOF
[
  {
    "gridData": {
      "w": 6,
      "h": 3,
      "x": 0,
      "y": 0,
      "i": "1"
    },
	"version": "6.2.1",
    "panelIndex": "1",
    "type": "visualization",
    "id": "${kibana_visualization.china_viz.id}"
  },
  {
    "gridData": {
      "w": 6,
      "h": 3,
      "x": 6,
      "y": 0,
      "i": "2"
    },
	"version": "6.2.1",
    "panelIndex": "2",
    "type": "search",
    "id": "${kibana_search.china.id}"
  }
]
EOF
}

More examples can be found in the example folder

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.9+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.

To compile the provider, run make build. This will build the provider and put the provider binary in the $GOPATH/bin directory.

$ ELK_VERSION=6.2.3 KIBANA_TYPE=KibanaTypeVanilla make build
...
$ $GOPATH/bin/terraform-provider-kibana
...

In order to test the provider, you can simply run make test. Note that ELK_VERSION and KIBANA_TYPE are used to control the test targets. The full list of test targets is visible in .travis.yml.

$ ELK_VERSION=6.2.3 KIBANA_TYPE=KibanaTypeVanilla make test

In order to run the full suite of Acceptance tests, run ELK_VERSION=6.2.3 KIBANA_TYPE=KibanaTypeVanilla make testacc.

Note: Acceptance tests create real resources, and often cost money to run.

Debuging

Set KIBANA_DEBUG=1 to see http debug output

$ make testacc

Adding dependencies

This project uses govendor to manage dependencies

Add /Update a package

govendor fetch github.com/owner/repo

Recursive govendor fetch github.com/owner/repo/...

michal-franc / terraform-provider-kibana