Skip to content

Commit 2a956f6

Browse files
author
guyplusplus
committed
Typos fixes
1 parent 31945e5 commit 2a956f6

File tree

1 file changed

+22
-18
lines changed

1 file changed

+22
-18
lines changed

README.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
This project is a simple tutorial for Kibana new comers trying to developer their own vizualisation plugin. The actual usecase is to create a custom form to filter data to help end-users search their data.
44

5-
This plugin is a demo for the accounts data which can be downloaded from elastic web site [here](https://download.elastic.co/demos/kibana/gettingstarted/accounts.zip).
5+
This plugin is a demo for the accounts data which can be downloaded from elastic web site [here](https://download.elastic.co/demos/kibana/gettingstarted/accounts.zip) then uploaded via `curl -H 'Content-Type: application/x-ndjson' -XPOST 'localhost:9200/bank/account/_bulk?pretty' --data-binary @accounts.json`.
66

7-
As plugin architecture is being under heavy redesign in 7.x and document is rather obscure, I did my best to create something simple that works.
7+
As plugin architecture is being under heavy redesign in 7.x and documentation is rather obscure, I did my best to create something simple that works.
88

9-
This repository is for 7.7 while [this repository](https://github.com/guyplusplus/Kibana-Plugin-Custom-Form-Filter-Visualization-Legacy) is for 7.6 legacy architecture.
9+
This repository is for Kibana v7.7 while [this repository](https://github.com/guyplusplus/Kibana-Plugin-Custom-Form-Filter-Visualization-Legacy) is for 7.6 legacy architecture.
1010

1111
## Sample Screenshots
1212

@@ -27,7 +27,7 @@ $ sudo apt install curl
2727
$ sudo apt install openjdk-11-jre-headless
2828
```
2929

30-
2. Install latest kibana and elasticsearch via apt
30+
2. Install latest Kibana and ElasticSearch via apt
3131

3232
```
3333
$ wget -qO - https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add -
@@ -36,11 +36,11 @@ $ sudo apt-get install elasticsearch
3636
$ sudo apt-get install kibana
3737
```
3838

39-
For testing purpose, it may be required to install a specific (not latest) version of kibana or elasticsearch.
39+
For testing purpose, it may be required to install a specific (not latest) version of kibana or ElasticSearch.
4040

4141
```
42-
$ sudo apt-get remove kibana
43-
$ sudo apt-get install kibana=7.6.2
42+
$ sudo apt-get remove kibana [for latest version]
43+
$ sudo apt-get install kibana=7.6.2 [for a specific version]
4444
```
4545

4646
3. Adjust listening IP address of kibana if network access is required
@@ -55,7 +55,6 @@ $ sudo vi /etc/kibana/kibana.yml
5555
```
5656
$ sudo systemctl start elasticsearch
5757
$ curl -X GET "localhost:9200"
58-
...
5958
$ sudo systemctl start kibana
6059
$
6160
```
@@ -82,20 +81,22 @@ $ git checkout v7.6.2
8281

8382
7. Copy the source code with modified name inside `kibana/plugins`
8483

85-
8. Start in dev. mode, ensuring only OSS (Open Source) is used
84+
8. Start in development mode, ensuring only OSS (Open Source) is used
8685

87-
nvm use
88-
yarn kbn bootstrap
89-
yarn start --oss
86+
```
87+
$ nvm use
88+
$ yarn kbn bootstrap
89+
$ yarn start --oss
90+
```
9091

9192
9. Kernel values for file monitoring may be required
9293

9394
```
94-
echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf
95-
sudo sysctl -p
95+
$ echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf
96+
$ sudo sysctl -p
9697
```
9798

98-
10. If you have problem to start Kibana dev 7.7.0 with ElasticSearch 7.7.0, add this line in kibana config file
99+
10. If you have problem to start Kibana dev 7.7.0 with ElasticSearch 7.7.0, add this line in `config/kibana.yml` config file. When upgrading from 7.6 to 7.0 I had to delete all indexes `curl -XDELETE localhost:9200/*`.
99100

100101
```
101102
elasticsearch.ignoreVersionMismatch: true
@@ -106,7 +107,7 @@ elasticsearch.ignoreVersionMismatch: true
106107
Simply add the plugin directory inside a kibana folder and zip the file. The zip structure is
107108

108109
```
109-
my-plugin_7.6.0.zip
110+
my-plugin_7.7.0.zip
110111
kibana/
111112
my-plugin/
112113
package.json
@@ -117,13 +118,16 @@ my-plugin_7.6.0.zip
117118
...
118119
```
119120

121+
## Installing the plugin
122+
120123
The plugin can then be installed like this.
121124

122125
```
123-
$ sudo ./bin/kibana-plugin --allow-root install file:///home/john/downloads/kbn_tp_custom_form_filter_accounts_7.6.0_1.0.0.zip
126+
$ sudo ./bin/kibana-plugin --allow-root install file:///home/john/downloads/kbn_tp_custom_form_filter_accounts_7.7.0_1.0.0.zip
127+
$ sudo ./bin/kibana-plugin --allow-root install https://github.com/guyplusplus/Kibana-Plugin-Custom-Form-Filter-Visualization-Legacy/releases/download/1.0.0/kbn_tp_custom_form_filter_accounts_7.7.0_1.0.0.zip
124128
```
125129

126-
Deleting then installing again fails often for me. I fix it by running this command.
130+
Deleting then installing the plugin often fails for me. I fix it by running this command.
127131

128132
```
129133
$ rm -rf /usr/share/kibana/optimize/bundles

0 commit comments

Comments
 (0)