OpenSearch Operator

Description 📝

The OpenSearch Operator provides a easy way of deploying a highly scalable, reliable and secure OpenSearch cluster with an out of the box 🎁 experience.

OpenSearch is a community-driven, open source search and analytics engine for all types of data, including textual, numerical, geospatial, structured, and unstructured. It's suited for a broad of use cases like real-time application monitoring, log analytics, and website search.

Usage 🔮

Self-signed certificates 🔏

You can easily generate your certificates following these steps:

Clone this repo, get inside of it and be sure to have openssl on your machine and create a new template file named openssl.conf that has the following fields:

[req]
distinguished_name = dn
default_keyfile    = {{ node_name }}.csr
prompt             = no

[dn]
CN={{ node_name }}
OU="Data Platform"
O="Canonical"
L="TORONTO"
ST="ONTARIO"
C="CA"

Note: You can edit CN, OU, O, L, ST and CA fields.

Edit the bin/helpers/admin.conf and bin/helpers/root.conf if you wish to change [dn] fields.
Run the the following command:

./bin/helpers/root_admin_certs.sh

This will generate the admin-key.pem, admin.pem, root-ca-key.pem, root-ca.pem that will be used as juju resources.

Deploy it:

juju deploy opensearch \
    --resource tls_ca=./root-ca.pem \
    --resource tls_key=./root-ca-key.pem \
    --resource admin_key=admin-key.pem \
    --resource admin_cert=./admin.pem \
    --resource open_ssl_conf=./openssl.conf

For more information about self-signed certificates, please check the OpenSearch documentation.

Relating with a Certificate Authority charms (EasyRSA, Vault and etc) 👮

Not supported yet.

Relations

Currently supported relations are:

Client: pass the cluster name and port over the elasticsearch interface

Contributing

Please see the Juju SDK docs for guidelines on enhancements to this charm following best practice guidelines, and CONTRIBUTING.md for developer guidance.

License

The Charmed OpenSearch Operator is free software, distributed under the Apache Software License, version 2.0. See LICENSE for more information.

gabrielcocenza/opensearch-operator