/readonlyrest-docs

Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
111 lines (80 sloc) 4.56 KB

Multiuser Elastic Stack with ReadonlyREST PRO

This document will guide you through setting up your Elasticsearch and Kibana stack with ReadonlyREST such that:

  • 3 users will be able to login into Kibana using their own set of credentials
  • All users will see the same Kibana dashboards, but may be seeing different subsets of the whole data contained in Elasticsearch.

Users and capabilities

For this tutorials, we want to have three users, each of them has a distinct access level to a shared Kibana tenancy (set of dashboards and settings).

"admin" "rw_usr" "ro_usr"
Can create, edit, delete dashboards ✅ ✅
Can change Kibana settings ✅ ✅
Only sees logstash data from 2017 ✅
Can see "add", "delete", "edit" buttons ✅ ✅
"dev-tools" Kibana App is hidden ✅ ✅
"readonlyrest" Kibana App is hidden ✅

NB: ReadonlyREST for Elastisearch and ReadonlyREST PRO for Kibana have an great amount of features like groups, connector for external systems like LDAP, etc. Don't forget to visit the full documentation and the forum to know more about it. NB: This guide works with ROR Enterprise as well.

Before you start

For the scope of this guide, we will assume:

If you don't have the ROR PRO (or Enterprise) plugin for Kibana, get yourself a two weeks free trial build

Setup: the Elasticsearch side

On the same directory with your elasticsearch.yml (default: config/, create a file called readonlyrest.yml and write the following settings into it.

readonlyrest:

    # IMPORTANT FOR LOGIN/LOGOUT TO WORK WITH ROR PLUGIN FOR KIBANA
    prompt_for_basic_auth: false

    access_control_rules:
    
    #########################################################
    # These credentials shall be used by the logstash daemon.
    #########################################################  
    - name: "::LOGSTASH::"
      auth_key: logstash:logstash
      actions: ["indices:data/read/*","indices:data/write/*","indices:admin/template/*","indices:admin/create"]
      indices: ["*logstash-*"]


    #####################################################################################
    # These credentials have no limitations, and shall be used only by the Kibana deamon.
    #####################################################################################
    - name: "::KIBANA-SRV::"
      auth_key: kibana:kibana

    #######################
    # Actual human users...
    #######################
    - name: "::RO::"
      auth_key: ro_usr:dev
      kibana_access: ro
      indices: [ ".kibana", ".kibana-devnull", "logstash-2017*"]
      kibana_hide_apps: ["readonlyrest_kbn", "kibana:dev_tools"]

    - name: "::RW::"
      auth_key: rw_usr:dev
      kibana_access: rw
      indices: [".kibana", ".kibana-devnull", "logstash-*"]
      kibana_hide_apps: ["readonlyrest_kbn", "timelion", "kibana:dev_tools", "kibana:management"]

    - name: "::ADMIN::"
      auth_key: admin_usr:dev
      kibana_access: admin
      indices: [".kibana", ".kibana-devnull", "logstash-*"]

Setup: the Kibana side

With ROR, we try as much as possible to keep all the settings withing the Elasticsearch domain. Therefore, you'll notice how few settings are needed on the Kibana side, apart from actually installing the plugin.

Open up config/kibana.yml and add/edit the following settings:

# Kibana server use ::KIBANA-SRV:: credentials
elasticsearch.username: "kibana"
elasticsearch.password: "kibana"

Running

Fire up Elasticsearch

$ bin/elasticsearch

And then Kibana

$ bin/kibana

Loggin in

Now you are ready to point your browser to the Kibana server IP (defauling on port 5601) and you should see a login prompt. You can login as any user i.e. "rw_usr", or "admin" and the password is always "dev".

Maybe just remember to login with a RW user first, so Kibana can create its own default settings.