Skip to content

Latest commit

 

History

History
171 lines (128 loc) · 6.35 KB

multitenancy_guide.md

File metadata and controls

171 lines (128 loc) · 6.35 KB
Raw

Multi-tenancy Elastic Stack

(Enterprise)

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

  • There will be two tenancies: one for Sales and one for Ops department.
  • In each tenancy, 3 users will be able to login into Kibana using their own set of credentials
  • Each tenancy will contain its own, independant Kibana dashboards, visualizations and index patterns.
  • Each user within a tenancy may be restricted to visualizing distinct subsets of the whole data contained in Elasticsearch (i.e. only certain indices).

Users and capabilities

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

Sales Department

"sales_admin" "sales_rw_usr" "sales_ro_usr"
Can create,edit,delete Sales' dashboards ✅ ✅
Can change Kibana settings for Sales ✅ ✅
Only sees "sales_logstash*" data from 2018 ✅
Can see "add","delete","edit" buttons ✅ ✅
"dev-tools" Kibana App is hidden ✅ ✅
"readonlyrest" Kibana App is hidden ✅

Ops Department

"ops_admin" "ops_rw_usr" "ops_ro_usr"
Can create,edit,delete Ops dashboards ✅ ✅
Can change Kibana settings for Ops ✅ ✅
Only sees ops_logstash data from 2018 ✅
Can see "add","delete","edit" buttons ✅ ✅
"dev-tools" Kibana App is hidden ✅ ✅
"readonlyrest" Kibana App is hidden ✅

NB: ReadonlyREST for Elastisearch and ReadonlyREST Enterprise 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: The capabilities gained by admin users when they access the "readonlyrest" Kibana App are global, that is, they can add/remove tenancies, users, groups, etc.

Before you start

For the scope of this guide, we will assume:

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

IMPORTANT: disable Xpack Security module

Because ReadonlyREST is not compatible with XPack Security module please make sure you disable xpack.security module from both Kibana and Elasticsearch by adding the following line to both elasticsearch.yml and kibana.yml:

xpack.security.enabled: false # Skip this setting in the Kibana configuration for version 8.x, as it has been removed.

Setup: the Elasticsearch side

Right beside your elasticsearch.yml, create a file called readonlyrest.yml and write the following settings into it.

readonlyrest:

    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
      verbosity: error

    ##############################
    # SALES: Actual human users...
    ##############################
    - name: "::RO_SALES::"
      auth_key: sales_ro_usr:dev1
      indices: ["logstash-2018*"]
      kibana:
        access: ro
        hide_apps: ["readonlyrest_kbn", "kibana:dev_tools"]
        index: ".kibana_sales"

    - name: "::RW_SALES::"
      auth_key: sales_rw_usr:dev2
      indices: ["logstash-*"]
      kibana:
        access: rw
        hide_apps: ["readonlyrest_kbn", "timelion", "kibana:dev_tools", "kibana:management"]
        index: ".kibana_sales"

    - name: "::ADMIN_SALES::"
      auth_key: sales_admin_usr:dev3
      indices: ["logstash-*"]
      kibana:
        access: admin
        index: ".kibana_sales"

    ###########################
    # OPS Actual human users...
    ###########################
    - name: "::RO_OPS::"
      auth_key: ops_ro_usr:dev4
      indices: ["logstash-2018*"]
      kibana:
        access: ro
        hide_apps: ["readonlyrest_kbn", "kibana:dev_tools"]
        index: ".kibana_ops"

    - name: "::RW_OPS::"
      auth_key: ops_rw_usr:dev5
      indices: ["logstash-*"]
      kibana:
        access: rw
        hide_apps: ["readonlyrest_kbn", "timelion", "kibana:dev_tools", "kibana:management"]
        index: ".kibana_ops"

    - name: "::ADMIN_OPS::"
      auth_key: ops_admin_usr:dev6
      indices: ["logstash-*"]
      kibana:
        access: admin
        index: ".kibana_ops"

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"

# ReadonlyREST required properties
readonlyrest_kbn.cookiePass: '12312313123213123213123abcdefghijklm'

Running

Fire up Elasticsearch

$ bin/elasticsearch

And then Kibana

$ bin/kibana

Logging in

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

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