trombik.opensearch_dashboards

This manages opensearch-dashboards.

Please note that the latest version of opensearch-dashboards (1.1.0 at the time of writing) uses nodejs version 10.x and has several old and vulnerable nodejs modules. For more information, check Issue 835. It’s generally not recommended to use opensearch-dashboards in a production environment until a newer version is released with fixes. If this concerns you, consider using elasticsearch and kibana instead.

For FreeBSD users

The package in the official FreeBSD ports tree (1.1.0 at the time of writing) is not working properly. More details can be found in bug 259330. You will need my own port, which can be found at trombik/freebsd-ports-opensearch. This port relies on an old, deprecated version of node10. The node10 package has been removed from the ports tree. Therefore, my repository has updates to the node ports to restore node10. In summary, don't use it unless you know what you're doing.

For Debian and CentOS users

The role installs opensearch-dashboards from the official tar archive. This is a temporary solution until Amazon or other distributions provide proper packages.

The default changes include:

• Configuration directory is /etc/opensearch-dashboards
• Log file is located at /var/log/opensearch-dashboards
• The path.data is set to /var/lib/opensearch-dashboards
• The application gets installed in /var/www/opensearch-dashboards
• The user used to run the application is opensearch_dashboards

These changes will be updated once an official package is available.

The role downloads the official tar archive into the directory opensearch_dashboards_src_dir, which defaults to /var/dist. This directory is not just a cache; it also contains a PGP key, a signature file, and files to manage ansible tasks.

The role sets up a systemd unit file for opensearch-dashboards. The author does not have expert knowledge of systemd.

Requirements

None

Role Variables

Dependencies

None

Example Playbook

---
- hosts: localhost
  roles:
    - ansible-role-opensearch_dashboards
  vars:
    opensearch_dashboards_config:
      server.host: "{{ opensearch_dashboards_bind_address }}"
      server.port: "{{ opensearch_dashboards_bind_port }}"
      path.data: "{{ opensearch_dashboards_data_dir }}"
      opensearch.hosts: ["http://localhost:9200"]
      opensearch.ssl.verificationMode: none
      opensearch.username: "kibanaserver"
      opensearch.password: "kibanaserver"
      opensearch.requestHeadersWhitelist:
        - authorization,securitytenant
      opensearch_security.multitenancy.enabled: true
      opensearch_security.multitenancy.tenants.preferred: ["Private", "Global"]
      opensearch_security.readonly_mode.roles: ["kibana_read_only"]
      # Use this setting if you are running kibana without https
      opensearch_security.cookie.secure: false

License

Copyright (c) 2021 Tomoyuki Sakurai <[email protected]>

You are allowed to use, copy, modify, and distribute this software for any purpose, with or without a fee, as long as you include the copyright and permission notice in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES RELATED TO THIS SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. THE AUTHOR IS NOT LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES RESULTING FROM LOSS OF USE, DATA, OR PROFITS, WHETHER IN A CONTRACT, NEGLIGENCE, OR OTHER ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Author Information

Tomoyuki Sakurai y@trombik.org

This README was created by qansible