-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'lens/dynamic-coloring-table' of github.com:dej611/kiban…
…a into lens/dynamic-coloring-table
- Loading branch information
Showing
623 changed files
with
9,727 additions
and
7,052 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+1.22 MB
dev_docs/assets/target_folder_with_a_kibana_distributable_and_os_packages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,135 @@ | ||
--- | ||
id: kibDevTutorialBuildingDistributable | ||
slug: /kibana-dev-docs/tutorial/building-distributable | ||
title: Building a Kibana distributable | ||
summary: Learn how to build a Kibana distributable | ||
date: 2021-05-10 | ||
tags: ['kibana', 'onboarding', 'dev', 'tutorials', 'build', 'distributable'] | ||
--- | ||
|
||
On the course of that tutorial it will be possible to learn more about how we can create a Kibana distributable | ||
as well as handle its different main configurations. | ||
|
||
At any given point, you can get CLI help running the following command: | ||
|
||
```bash | ||
yarn build --help | ||
``` | ||
|
||
## Prerequisites | ||
|
||
For the basic steps of the build we only require you to use one of the following operating systems: | ||
|
||
- Linux | ||
- macOS | ||
|
||
However if as part of the build you also want to generate Linux installation packages (deb, rpm) or Docker images there | ||
are other dependencies to have in mind as those installation packages and Docker images generation are run using fpm, dpkg, rpm, and Docker. | ||
|
||
### For Linux Installation Packages Build | ||
|
||
Please make sure you have the following dependencies installed: | ||
|
||
#### Install FPM dependencies | ||
|
||
**On OSX/macOS:** | ||
|
||
```bash | ||
brew install gnu-tar rpm | ||
``` | ||
|
||
**On Red Hat systems (Fedora 22 or older, CentOS, etc):** | ||
|
||
```bash | ||
yum install ruby-devel gcc make rpm-build rubygems | ||
``` | ||
|
||
**On Fedora 23 or newer:** | ||
|
||
```bash | ||
dnf install ruby-devel gcc make rpm-build libffi-devel | ||
``` | ||
|
||
**On Oracle Linux 7.x systems:** | ||
|
||
```bash | ||
yum-config-manager --enable ol7_optional_latest | ||
yum install ruby-devel gcc make rpm-build rubygems | ||
``` | ||
|
||
**On Debian-derived systems (Debian, Ubuntu, etc):** | ||
|
||
```bash | ||
apt-get install ruby ruby-dev rubygems build-essential | ||
``` | ||
|
||
#### Install FPM | ||
|
||
Finally install fpm with the gem tool with: | ||
|
||
```bash | ||
gem install fpm -v 1.5.0 | ||
``` | ||
|
||
### For Docker Images Build | ||
|
||
For Docker, the installation instructions can be found at [Install Docker Engine](https://docs.docker.com/engine/install/). | ||
|
||
|
||
## Create a Kibana distributable | ||
|
||
In a great majority of the use cases where we need to build a Kibana distributable, we just need the archives containing the | ||
node executable and the bundled code of the application. | ||
|
||
By doing that Linux installation packages and Docker images will be excluded and as a result, the build will be quicker. | ||
|
||
We can do it by simply running: | ||
|
||
```bash | ||
yarn build --skip-os-packages | ||
``` | ||
|
||
Note that we used `--skip-os-packages` which will skip the OS packages build. | ||
|
||
> In case you are testing something and running that same command a couple of times, `--skip-node-download` can be used | ||
to speed up the process by a little. | ||
|
||
At the end of the process a Kibana distributable was created in a `target` folder created relative to your repository checkout. | ||
The folder will look like the following: | ||
|
||
![Target Folder Outlook With a Kibana Distributable](../assets/target_folder_with_simple_kibana_distributable.png) | ||
|
||
## Controlling the log levels | ||
|
||
By default, when building the distributable, the `debug` log level will be used across all the steps. | ||
That default setting should give us a good amount of information about the tasks being done. | ||
|
||
To turn it off you can run the build along `--no-debug` flag. At that point that information will no longer be printed out. | ||
|
||
For a longer and verbose logging than `debug` there is other option that can be passed along the build command which is `--verbose`. | ||
|
||
## Create a Kibana distributable with Linux installation packages and Docker images | ||
|
||
If you comply with every prerequisite and dependency listed above, then there is also the option to create a Kibana distributable along with | ||
Linux installation packages like rpm and deb or Docker images. | ||
|
||
To achieve it, you can run: | ||
|
||
```bash | ||
yarn build | ||
``` | ||
|
||
At the end you will get the Kibana distributable archives plus the Docker images and both an rpm and a deb package. | ||
|
||
To specify just a single installation package or Docker images to build instead of all of them you can add rpm, deb or docker-images as an argument: | ||
|
||
```bash | ||
yarn build --deb | ||
yarn build --rpm | ||
yarn build --docker-images | ||
``` | ||
|
||
Again the distributable contents resulting from running the build command can be found in a `target` folder created relative to the repository after the build completes. | ||
It will look something like: | ||
|
||
![Target Folder Outlook With a Kibana Distributable And OS Packages](../assets/target_folder_with_a_kibana_distributable_and_os_packages.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
39 changes: 39 additions & 0 deletions
39
docs/development/core/public/kibana-plugin-core-public.app.deeplinks.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [deepLinks](./kibana-plugin-core-public.app.deeplinks.md) | ||
|
||
## App.deepLinks property | ||
|
||
Input type for registering secondary in-app locations for an application. | ||
|
||
Deep links must include at least one of `path` or `deepLinks`<!-- -->. A deep link that does not have a `path` represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
deepLinks?: AppDeepLink[]; | ||
``` | ||
|
||
## Example | ||
|
||
|
||
```ts | ||
core.application.register({ | ||
id: 'my_app', | ||
title: 'Translated title', | ||
keywords: ['translated keyword1', 'translated keyword2'], | ||
deepLinks: [ | ||
{ id: 'sub1', title: 'Sub1', path: '/sub1', keywords: ['subpath1'] }, | ||
{ | ||
id: 'sub2', | ||
title: 'Sub2', | ||
deepLinks: [ | ||
{ id: 'subsub', title: 'SubSub', path: '/sub2/sub', keywords: ['subpath2'] } | ||
] | ||
} | ||
], | ||
mount: () => { ... } | ||
}) | ||
|
||
``` | ||
|
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-core-public.app.keywords.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [App](./kibana-plugin-core-public.app.md) > [keywords](./kibana-plugin-core-public.app.keywords.md) | ||
|
||
## App.keywords property | ||
|
||
Optional keywords to match with in deep links search. Omit if this part of the hierarchy does not have a page URL. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
keywords?: string[]; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 0 additions & 43 deletions
43
docs/development/core/public/kibana-plugin-core-public.app.meta.md
This file was deleted.
Oops, something went wrong.
26 changes: 26 additions & 0 deletions
26
docs/development/core/public/kibana-plugin-core-public.appdeeplink.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-public](./kibana-plugin-core-public.md) > [AppDeepLink](./kibana-plugin-core-public.appdeeplink.md) | ||
|
||
## AppDeepLink type | ||
|
||
Input type for registering secondary in-app locations for an application. | ||
|
||
Deep links must include at least one of `path` or `deepLinks`<!-- -->. A deep link that does not have a `path` represents a topological level in the application's hierarchy, but does not have a destination URL that is user-accessible. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type AppDeepLink = { | ||
id: string; | ||
title: string; | ||
keywords?: string[]; | ||
navLinkStatus?: AppNavLinkStatus; | ||
} & ({ | ||
path: string; | ||
deepLinks?: AppDeepLink[]; | ||
} | { | ||
path?: string; | ||
deepLinks: AppDeepLink[]; | ||
}); | ||
``` |
13 changes: 0 additions & 13 deletions
13
docs/development/core/public/kibana-plugin-core-public.appmeta.keywords.md
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.