Security and Alerting for Elasticsearch
Search Guard FLX Documentation
Welcome to Search Guard FLX, the next generation of Search Guard!
Search Guard FLX brings a number of fundamental improvements and updates to Search Guard. These require breaking changes in the configuration format.
Major changes include:
- Completely new approach for configuring authentication. The new configuration format is more coherent, more predictable and much more powerful. Simple setups require very little configuration; very complex setups are possible by straight-forward configuration. If something goes wrong, Search Guard provides extensive error messages and diagnostic information.
- Completely new approach for logging into Kibana. Logged in users now get an actual server-side session. This fixes a number of issues, such as:
- Issues with cookies exceeding the browser size limit.
- The “logout” menu item is able to invalidate the session. Thus, session cookies cannot be re-used any more.
- Configuration of SSO using OIDC or SAML for Kibana no longer interfers with backend authentication configuration. Thus, you can now have challenging basic authentication on the backend while using OIDC or SAML for Kibana.
- The configuration format is now more streamlined and consistent.
- Kibana authentication configuration can be changed without having to restart the node.
- New administration tool
sgctlis stateful; that means, you can define connection profiles once and use these later. Thus, you don’t have to specify all connection configuration on each invocation. The interface of
sgctlis more streamlined and offers you improved configuration validation functionality.
- Wildcard queries without hassle made possible by an improved method for handling unauthorized indices. You no longer have to worry that your wildcard query breaks because it might pick up an index you don’t have permissions for.
- More speed. Many components of Search Guard underwent major optimizations. Thus, Search Guard FLX can now handle more throughput with a lower CPU footprint.
- Easily reachable diagnostics and metrics; most modules of Search Guard FLX offer debug modes which deliver diagnostic information right at the place where you operate. You no longer have to grep through logfiles to find out why your OIDC authentication is not working.
You have several options to try Search Guard FLX:
If you want to start with a quick test of a fresh installation on your local system, you can use the Search Guard Demo Installer.
If you have docker installed you can just simply run
docker run -it --rm -p 5601:5601 floragunncom/flx-7-demoand point your browser to
http://localhost:5601and login with username
If you have an existing Search Guard setup and want to test its configuration with Search Guard FLX, you can use the migrate-config command of
sgctl. Please also review the list of release notes.
You might want to read the following sections of the documentation to get a comprehensive overview over the new possibilities of Search Guard:
- Using sgctl (See also the repository README).
- Using configuration variables
- Configuring authentication
- Configuring Kibana authentication
- Search Guard FLX release notes
- Migrating from Search Guard 53 and before
- SG 53 to FLX feature map
Your feedback is welcome! You can use the Search Guard Forum for questions and general feedback. You can also report issues at the Search Guard Gitlab repository.