https://github.com/scalingo/kibana-buildpack
Buildpack to deploy Kibana as a simple application
https://github.com/scalingo/kibana-buildpack
buildpack kibana scalingo
Last synced: 6 months ago
JSON representation
Buildpack to deploy Kibana as a simple application
- Host: GitHub
- URL: https://github.com/scalingo/kibana-buildpack
- Owner: Scalingo
- License: mit
- Created: 2016-10-07T10:46:35.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-02-19T08:56:24.000Z (over 1 year ago)
- Last Synced: 2025-08-05T00:20:26.664Z (11 months ago)
- Topics: buildpack, kibana, scalingo
- Language: Shell
- Homepage:
- Size: 71.3 KB
- Stars: 0
- Watchers: 5
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Scalingo buildpack for Kibana
This buildpack downloads and installs Kibana into a Scalingo app image.
## Compatibility
Tested against Kibana 7.10.2 - ES 7.10.2
## Usage
To deploy your own Kibana, you've to do the following:
```console
$ git init
$ scalingo create my-kibana
$ scalingo env-set BUILDPACK_URL=https://github.com/Scalingo/kibana-buildpack
# If you don't already have an elasticsearch instance from another app
$ scalingo addons-add scalingo-elasticsearch elasticsearch-sandbox
# If you already have the ES instance, refer its URL
$ scalingo env-set ELASTICSEARCH_URL="http://user:password@host:port"
$ echo 'web: kibana --port $PORT' > Procfile
$ git add Procfile
$ git commit -m "Prepare Kibana for Scalingo deployment"
$ git push scalingo master
```
That's it, your Kibana is live! You may have to wait a few seconds for it to
create its indexes, then refresh and the dashboard will be available.
## Elasticsearch Configuration
### HTTPS with self-signed certificate
Use the environment variable `ELASICSEARCH_TLS_CA_URL` to specify an URL to
download the certificate from
- [https://db-api.osc-fr1.scalingo.com/api/ca_certificate](https://db-api.osc-fr1.scalingo.com/api/ca_certificate) for OSC-FR1
- or [https://db-api.osc-secnum-fr1.scalingo.com/api/ca_certificate](https://db-api.osc-secnum-fr1.scalingo.com/api/ca_certificate) for OSC-SECNUM-FR1
Alternatively you can add the CA to your GIT repository and configure its path
with the variable `ELASTICSEARCH_TLS_CA_PATH` (example: `ca.crt`)
## Plugins
You may want to install plugins to your Kibana installation like
[logtrail](https://github.com/sivasamyk/logtrail). To do
that, just create a file `kibana-plugins` with the urls of the plugins you
wish to install.
Example of `kibana-plugins` file:
```
https://github.com/sivasamyk/logtrail/releases/download/v0.1.18/logtrail-5.5.0-0.1.18.zip
```
## Plugins configuration
You may want to configure your plugins. To do that, just create a file 'plugins-config' with the local path of your config file and the path where this config file should be stored in the plugins directory.
Example of 'plugins-config' for the 'logtrail.json' file:
```
logtrail.json:logtrail/logtrail.json
```
## Security
If bother environment variables `KIBANA_USER` and `KIBANA_PASSWORD` are
defined, we'll deploy *nginx* alongside *Kibana*. All the requests will be
authenticating by nginx before being proxied to Kibana. The latter is not
longer directly reachable from the Internet.
## Extra configuration
* `KIBANA_VERSION`: Kibana version to install (e.g. `6.8.23`)
* `DOWNLOAD_URL`: Source of the kibana archive, default is: `https://artifacts.elastic.co/downloads/kibana/kibana-${KIBANA_VERSION}-linux-x86_64.tar.gz`
* `LOG_LEVEL`: Specify the logging level of Kibana. Set the [`logging.root.level` configuration key](https://www.elastic.co/guide/en/kibana/current/logging-settings.html) in the Kibana config file. Options are `all`, `fatal`, `error`, `warn`, `info`, `debug`, `trace`, `off`. Default is `info`.