openstack/monasca-kibana-plugin
Code Issues Proposed changes

Convert README.md to ReStructuredTest format

Browse Source 
Change-Id: I846064e4294691e346754bc03ae454ec60adfe79
story: 2002163
task: 22254
This commit is contained in:
Denis Poisson 2018-06-20 10:17:16 +02:00
parent 209b830334
commit a36eec6ae9
2 changed files with 50 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -1,48 +0,0 @@
Monasca Kibana plugin
=====
Keystone authentication support and multi-tenancy for Kibana 4.6.x
Build
-----
```
npm install
npm run package
```
Installation
-----
Requires a working version of Kibana. The kibana configuration file (/opt/kibana/config/kibana.yml) should be updated
where keystone_port should be the keystone admin port (default: 35357) not the keystone member port (default: 5000):
```
monasca-kibana-plugin.port: ${keystone_port}
monasca-kibana-plugin.url: http://${keystone_host}
monasca-kibana-plugin.enabled: True
monasca-kibana-plugin.defaultTimeField: '@timestamp'
```
Then install using the Kibana plugin manager tool:
```
$ /opt/kibana/bin/kibana plugin --install monasca-kibana-plugin --url file:///tmp/monasca-kibana-plugin-0.0.1.tar.gz
Installing monasca-kibana-plugin
Attempting to transfer from file:///tmp/monasca-kibana-plugin-0.0.1.tar.gz
Transferring 7567007 bytes....................
Transfer complete
Extracting plugin archive
Extraction complete
Optimizing and caching browser bundles...
Plugin installation complete
$ /opt/kibana/bin/kibana plugin --list
monasca-kibana-plugin
```
Now start/restart your Kibana server by running:
```
$ service kibana restart
```

50
README.rst Normal file
View File

@ -0,0 +1,50 @@
Monasca Kibana plugin
=====================
Keystone authentication support and multi-tenancy for Kibana 4.6.x
Build
-----
::
npm install
npm run package
Installation
------------
Requires a working version of Kibana. The kibana configuration file
(/opt/kibana/config/kibana.yml) should be updated where keystone_port
should be the keystone admin port (default: 35357) not the keystone
member port (default: 5000):
::
monasca-kibana-plugin.port: ${keystone_port}
monasca-kibana-plugin.url: http://${keystone_host}
monasca-kibana-plugin.enabled: True
monasca-kibana-plugin.defaultTimeField: '@timestamp'
Then install using the Kibana plugin manager tool:
::
$ /opt/kibana/bin/kibana plugin --install monasca-kibana-plugin --url file:///tmp/monasca-kibana-plugin-0.0.1.tar.gz
Installing monasca-kibana-plugin
Attempting to transfer from file:///tmp/monasca-kibana-plugin-0.0.1.tar.gz
Transferring 7567007 bytes....................
Transfer complete
Extracting plugin archive
Extraction complete
Optimizing and caching browser bundles...
Plugin installation complete
$ /opt/kibana/bin/kibana plugin --list
monasca-kibana-plugin
Now start/restart your Kibana server by running:
::
$ service kibana restart