Skip to content

Latest commit

 

History

History
94 lines (57 loc) · 3.28 KB

beta-new-platform.md

File metadata and controls

94 lines (57 loc) · 3.28 KB
description
⚠ Nothing to see here, this code is now generally available for Kibana >= 7.9.0 🎉

[Beta] Enterprise New Platform

How can I get a build?

This is a closed beta for the current Enterprise subscribers. If you are one of them, please:

  • email us at: support AT readonlyrest DOT com
  • with subject: "ROR Enterprise BETA builds for <Your Company Name>"

We will be grateful for your kind feedback.

How can I get updates?

Simple: head to beta.readonlyrest.com and subscribe to the announcements.

What's different?

Kibana is a fast changing piece of software. In the past, it was very frequent that a new Kibana release would break or introduce regressions in our product, and fixing and adapting has been an endless manual work for our team.

Today, the new ReadonlyREST Enterprise has been completely re-enginered to be more robust to changes, modular and testable.

New internal plugin name

The internal plugin name had to change from "readonlyrest_kbn" to "readonlyrestkbn", to comply with new rules in the plugin API. Fortunately, we managed to keep the zip file names and kibana.yml configuration parameters unchanged (i.e. things like readonlyrest_kbn.cookiePass: xxx are still valid).

New way to hide apps

Previously we needed to keep track and document all Kibana apps IDs, and you had to look them up all the time. Now we made it simpler.

Imagine you want to hide "Machine Learning" app from "Kibana" sub menu. You type:

kibana_hide_apps: [ "Kibana|Machine Learning" ]

That is <submenu-title|app-title> . Other examples:

  • Enterprise Search|Workplace Search
  • Management|Stack Management
  • Security|Detections
  • Kibana|Maps

You get the gist.

Will users notice different UX?

Only subtle differences, and many of these are just total improvements.

For example, our administrative Kibana app has now become a modal window. It opens and closes quickly, and does not navigate your session away from what you were doing in Kibana.

Will our deployment scripts need a tweak?

The answer is: yes they will, but only one extra command. See installation/uninstallation instructions below.

Install and uninstall

This is because the new ROR owes its extra powers to a tiny bit of code injection in a couple of Kibana core files. And for legal reasons you have to patch them yourself using our patcher/unpatcher "ror-tools.js".

Installation

With the new plugin, you need a post-installation step. This will slightly modify some core Kibana files.

# Normal installation
$ bin/kibana-plugin install file:///tmp/readonlyrest_kbn_v1.27.0_es7.10.1.zip
...
# [NEW!] Patch Kibana core files 
$ node/bin/node plugins/readonlyrest_kbn/ror-tools.js patch

{% hint style="info" %} Don't forget to launch "unpatch" before updating the plugin or Kibana.

Even better, throw away the entire Kibana directory, and install from scratch. Like Docker would. {% endhint %}

Uninstall

There's also a pre-uninstallation step, to bring back the Kibana files to the original state.

# [NEW!] Un-patch Kibana core files 
$ node/bin/node plugins/readonlyrestkbn/ror-tools.js unpatch

# Uninstall normally
$ bin/kibana-plugin remove readonlyrestkbn