janopl / ddev-kibana

Kibana add-on for DDEV

Instalation

Uses Kibana official image

ddev get janopl/ddev-kibana

Configuration

From within the container, the kibana container is reached at hostname "kibana", port: 5601

Kibana Version

To adjust the version of your elastic search, you can use the new argument variable that docker compose provides for the version.

docker-compose.kibana.yml

services:
    kibana:
        build:
            ...
            args:
                - KIBANA_VERSION=7.17.14 // example: 8.10.2
        ...
        environment:
            KIBANA_VERSION: 7.17.14 // example: 8.10.2

OR

Post ddev get, run cp .ddev/elasticsearch/docker-compose.elasticsearch8.yaml .ddev/ to enable Kibana 8.

Configuration file

You can configure Kibana dashboard through the config file under: .ddev/kibana/config.yml

Connection

You can access the Kibana server directly from the host by visiting:

• https://<projectname>.ddev.site:5601
• http://<projectname>.ddev.site:5600

Contribution

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

License

This project is licensed under the APACHE license.

See LICENSE for more information.

ddev-kibana's Issues

Error after adding Kibana

Ran ddev get ddev/ddev-elasticsearch
Ran ddev get JanoPL/ddev-kibana
Ran ddev restart

Got:

failed to solve: rpc error: code = Unknown desc = failed to solve with frontend dockerfile.v0: failed to create LLB definition: rpc error: code = Unknown desc = error getting credentials - err: exit status 1, out: error getting credentials - err: docker-credential-osxkeychain resolves to executable in current directory (./docker-credential-osxkeychain), out: ``` Failed to restart elastic: docker-compose build failed: composeCmd failed to run 'COMPOSE_PROJECT_NAME=ddev-elastic docker-compose -f /Users/firesphere/Projects/elastic/.ddev/.ddev-docker-compose-full.yaml --progress=quiet build', action='[--progress=quiet build]', err='exit status 17', stdout='', stderr='failed to solve: rpc error: code = Unknown desc = failed to solve with frontend dockerfile.v0: failed to create LLB definition: rpc error: code = Unknown desc = error getting credentials - err: exit status 1, out: error getting credentials - err: docker-credential-osxkeychain resolves to executable in current directory (./docker-credential-osxkeychain), out: ', output='', stderr='failed to solve: rpc error: code = Unknown desc = failed to solve with frontend dockerfile.v0: failed to create LLB definition: rpc error: code = Unknown desc = error getting credentials - err: exit status 1, out: `error getting credentials - err: docker-credential-osxkeychain resolves to executable in current directory (./docker-credential-osxkeychain), out: '

🐛 BUG: Service NOT available on HTTPS

Documents state:

You can access the Kibana server directly from the host by visiting https://.ddev.site:5601

This accessing https://<projectname>.ddev.site:5601 geneartes an "ERR_SSL_PROTOCOL_ERROR" error in Chrome.
However, service appears to be http://<projectname>.ddev.site:5601 (HTTP only).

Actions error

Error:

{"command":"git push origin HEAD","exitCode":1,"outputData":"","errorData":"remote: error: GH006: Protected branch update failed for refs/heads/main.        \nremote: error: Changes must be made through a pull request.        \nTo [https://github.com/JanoPL/ddev-kibana.git\n](https://github.com/JanoPL/ddev-kibana.git/n) ! [remote rejected] HEAD -> main (protected branch hook declined)\nerror: failed to push some refs to '[https://github.com/JanoPL/ddev-kibana.git'\n](https://github.com/JanoPL/ddev-kibana.git'/n)"}

issue: Timeout failure on restart

Thanks for making the addon.

I've started learning elasticsearch for Drupal and thought I would try this addon too.
I have ElasticSearch in Drupal via the official addon for DDEV.

I tried to add this addon too with the following command: ddev get janopl/ddev-kibana

However, when I restart DDEV, I get the following error:

Failed to start elasticsearch-d94-demo: container(s) failed to become healthy before their configured timeout or in 120 seconds. This may be just a problem with the healthcheck and not a functional problem. (container /ddev-elasticsearch-d94-demo-kibana is unhealthy: ) 

When I run ddev logs -s kibana, I

...
{"type":"log","@timestamp":"2022-09-28T03:27:26+00:00","tags":["info","status"],"pid":7,"message":"Kibana is now available (was degraded)"}
{"type":"log","@timestamp":"2022-09-28T03:27:29+00:00","tags":["info","plugins","reporting","chromium"],"pid":7,"message":"Browser executable: /usr/share/kibana/x-pack/plugins/reporting/chromium/headless_shell-linux_x64/headless_shell"}agent":"curl/7.68.0","accept":"*/*"},"remoteAddress":"127.0.0.1","userAgent":"curl/7.68.0"},"res":{"statusCode":302,"responseTime":6},"message":"GET / 302 6ms"}
...

The last message appears about 20-30 times or so. I'm not familiar with kibana so I'm not sure if this is expected behavior or not.

Try out julienloizelet/ddev-add-on-test

You're very active and knowledgable here, @julienloizelet and I would love it if you'd incorporate their github action, see https://github.com/ulienloizelet/ddev-add-on-test

Add encrypted communication to Kibana

TLS comunication docs:

• https://www.elastic.co/guide/en/kibana/7.17/configuring-tls-communication.html

Add:

• configuration file to docker compose file - path in container: /usr/share/kibana/config/kibana.yml
• added security settings to kibana.yml - https://www.elastic.co/guide/en/kibana/current/Security-production-considerations.html

Related: #3

[Question]: Tests sometimes failed on GitHub action test

Hi,

I'm using your add-on to test the DDEV add-on test action with a custom checkout action.

It works great, but, sometimes, test failed on the "green" assertion because the result is "yellow". (maybe 2 failed on the last month)

For example: https://github.com/ddev/github-action-add-on-test/actions/runs/6182906096/job/16783556790

I don't see this kind of error on your repo test and I wonder if you have any idea of the root cause of this ? (and if there is something I could do to avoid this)

FYI, I'm testing with the v1.4.0 release of your add-on.

Thanks

Consider adding ddev-get label so it's discoverable

Would you consider adding the ddev-get label to make this discoverable? Somebody was just asking for Kibana the other day.