We recently added a breaking changes section to the Kibana documentation, but they look more like single line items that are common in release notes.
It will be a much better user experience if we provide more context and impact information on these changes (similar to the Elasticsearch breaking changes documentation) so users will not have to dig through various github tickets to figure this out.
Here is a proposal on adding details and impact information to the guide:
Details and Impact sections are suggested additions to provide more background context and impact.
Pull Request 8013: Kibana binds to localhost by default
Details: Kibana (like Elasticsearch) now binds to localhost for security purposes instead of 0.0.0.0 (all addresses). Previous binding to 0.0.0.0 also caused issues for Windows users.
Impact: If you are running Kibana inside a container/environment that does not allow localhost binding, this will cause Kibana not to start up unless server.host is configured in the kibana.yml to a valid IP address/host, etc..
Pull Request 7855: Markdown headers require a space between the final hash and title
Details: As part of addressing the security issue ESA-2016-03 (CVE-2016-1000220) in the Kibana product, the markdown version has been bumped.
Impact: As a result of the fix to ESA-2016-03, there is a slight change in the markdown format for headers.
Previously, headers are defined using ### followed by the title:
###Packetbeat:
[Dashboard](/#/dashboard/Packetbeat-Dashboard)
[Web transactions](/#/dashboard/HTTP)
It should now be defined as follows (with a space between ### and the title):
### Packetbeat:
[Dashboard](/#/dashboard/Packetbeat-Dashboard)
[Web transactions](/#/dashboard/HTTP)
Pull Request 7308: Debian and rpm packages install assets to/usr/share/kibana, and configuration to /etc/kibana
Details: This is to align with the package assets install location of Elasticsearch where binaries are located under /usr/share/<product_name> and configuration files are located under /etc/<product_name>. Previously they are both located under /opt/kibana.
Impact: Apart from learning the new location of Kibana binaries and configuration files, you may have to update your automation scripts as needed.
Pull Request 6402: The plugin installer now has its own executable, it can be found at /bin/kibana-plugin
Details: This just means that when installing/removing Kibana plugins, you will now call kibana-plugin instead of the kibana script (pre-5.0)
Impact: You may have to update your automation scripts.
Note that this is not a 1-time change proposal. It will be nice for us to follow this as a best practice of writing breaking changes moving forward :)
We recently added a breaking changes section to the Kibana documentation, but they look more like single line items that are common in release notes.
It will be a much better user experience if we provide more context and impact information on these changes (similar to the Elasticsearch breaking changes documentation) so users will not have to dig through various github tickets to figure this out.
Here is a proposal on adding details and impact information to the guide:
Details and Impact sections are suggested additions to provide more background context and impact.
Pull Request 8013: Kibana binds to localhost by default
Details: Kibana (like Elasticsearch) now binds to localhost for security purposes instead of 0.0.0.0 (all addresses). Previous binding to 0.0.0.0 also caused issues for Windows users.
Impact: If you are running Kibana inside a container/environment that does not allow localhost binding, this will cause Kibana not to start up unless server.host is configured in the kibana.yml to a valid IP address/host, etc..
Pull Request 7855: Markdown headers require a space between the final hash and title
Details: As part of addressing the security issue ESA-2016-03 (CVE-2016-1000220) in the Kibana product, the markdown version has been bumped.
Impact: As a result of the fix to ESA-2016-03, there is a slight change in the markdown format for headers.
Previously, headers are defined using
###followed by the title:It should now be defined as follows (with a space between ### and the title):
Pull Request 7308: Debian and rpm packages install assets to/usr/share/kibana, and configuration to /etc/kibana
Details: This is to align with the package assets install location of Elasticsearch where binaries are located under /usr/share/<product_name> and configuration files are located under /etc/<product_name>. Previously they are both located under /opt/kibana.
Impact: Apart from learning the new location of Kibana binaries and configuration files, you may have to update your automation scripts as needed.
Pull Request 6402: The plugin installer now has its own executable, it can be found at /bin/kibana-plugin
Details: This just means that when installing/removing Kibana plugins, you will now call kibana-plugin instead of the kibana script (pre-5.0)
Impact: You may have to update your automation scripts.
Note that this is not a 1-time change proposal. It will be nice for us to follow this as a best practice of writing breaking changes moving forward :)