Enterprise and Compliance Edition
Enterprise and Compliance License
For running Search Guard Enterprise or Compliance on production systems you need to obtain a license. Search Guard is licensed per cluster with an unlimited number of nodes. The license covers all non-production systems like development, staging and QA as well.
For a feature comparison between the Complince, Enterprise and Community Edition please refer to the feature comparison matrix on our website.
When installing Search Guard for the first time, a trial license is automatically generated. Depending on the installed version, it unlocks all Enteprise and Compliance features without any limitation.
This trial license is valid for 60 days. If you want to extend it, just contact us and we’re happy to send you an extended license.
Displaying your current license
You have several ways to check the validity of your current license.
On startup, Search Guard will print license information to the Elasticsearch logfile on
INFO level. If your license is about to expire, a message on
WARN level is printed. Running Search Guard with an expired license will result in
ERROR message in the logfile.
HTTP license endpoint
The following endpoint will return your current license and information about the active Search Guard modules in JSON format:
https://<Elasticsearch Host>:<HTTP Port>/_searchguard/license
You don’t need to authenticate to access this endpoint.
The REST API offers an endpoint to retrieve your current license information. To access it, you need to use an account that has the privilege to use the REST API. If you used the demo installation script for installing and initializing Search Guard, you can use the admin user for that, e.g.:
curl -Ss --insecure -u admin:admin -XGET https://example.com:9200/_searchguard/license?pretty
See the REST management API configuration chapter for further information on how to configure API users.
Kibana Configuration GUI
If you’re using the Search Guard Kibana plugin, you can display your license and system information by clicking on “Search Guard” / “License & System Info”.
Applying an Enterprise or Compliance License
After obtaining a license, you can apply it in two ways.
Add the license string to sg_config.yml and upload the configuration by using sgadmin. You can either configure the license on a single line, or use YAML multi-line format:
--- _sg_meta: type: "config" config_version: 2 sg_config: dynamic: license: LS0tLS1CRUdJTiBQR1A... http: ... authc: ...
--- _sg_meta: type: "config" config_version: 2 sg_config: dynamic: license: |- LS0tLS1CRUdJTiBQR1AgU0lHTkVEIE1FU 1NBR0UtLS0tLQpIYXNoOiBTSEE1M ... http: ... authc: ...
sgadmin to upload the changed
sg_config.yml with the new license, any existing license will be overwritten. In order to backup your existing license, you can use the the
--retrieve) switch with sgadmin, e.g.:
./sgadmin.sh \ -ks kirk.jks -kspass changeit \ -ts truststore.jks -tspass changeit \ -icl -nhnv -r
You can use the REST management API license endpoint to
POST an Enterprise License to Search Guard.
Kibana Configuration GUI
If you’re using the Search Guard Kibana plugin, you upload a new license by clicking on “Search Guard” / “License & System Info” / “Upload new license”. Paste the complete license string in the input field and click on “Upload”.