Announce upcoming breaking changes in packaging

In opensearch-project#4043, we will introduce changes that might impact users. Add a note at installation time to warn them about this future change and how to proceed to not have trouble if they will be affected by the change. Signed-off-by: Romain Tartière <[email protected]>
smortex · Sep 20, 2023 · f6153c5 · f6153c5
1 parent 4d53d69
commit f6153c5
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 0 deletions.
diff --git a/scripts/pkg/build_templates/opensearch-dashboards/deb/debian/postinst b/scripts/pkg/build_templates/opensearch-dashboards/deb/debian/postinst
@@ -35,6 +35,10 @@ echo " sudo systemctl daemon-reload"
 echo " sudo systemctl enable opensearch-dashboards.service"
 echo "### You can start opensearch-dashboards service by executing"
 echo " sudo systemctl start opensearch-dashboards.service"
+echo "### Upcoming breaking change in packaging"
+echo " We are planing to tighten the permissions of installed files in a future version of the opensearch-dashboards package."
+echo " If you setup tooling that needs read access to the OpenSearch Dashboards configuration files, we invite you to add the user running these tools to the 'opensearch-dashboards' group."
+echo " More info: https://github.com/opensearch-project/opensearch-build/pull/4043"
 
 # Set owner
 chown -R opensearch-dashboards.opensearch-dashboards ${product_dir}

diff --git a/scripts/pkg/build_templates/opensearch-dashboards/rpm/opensearch-dashboards.rpm.spec b/scripts/pkg/build_templates/opensearch-dashboards/rpm/opensearch-dashboards.rpm.spec
@@ -89,6 +89,10 @@ echo " sudo systemctl daemon-reload"
 echo " sudo systemctl enable opensearch-dashboards.service"
 echo "### You can start opensearch-dashboards service by executing"
 echo " sudo systemctl start opensearch-dashboards.service"
+echo "### Upcoming breaking change in packaging"
+echo " We are planing to tighten the permissions of installed files in a future version of the opensearch-dashboards package."
+echo " If you setup tooling that needs read access to the OpenSearch Dashboards configuration files, we invite you to add the user running these tools to the 'opensearch-dashboards' group."
+echo " More info: https://github.com/opensearch-project/opensearch-build/pull/4043"
 exit 0
 
 %preun

diff --git a/scripts/pkg/build_templates/opensearch/deb/debian/postinst b/scripts/pkg/build_templates/opensearch/deb/debian/postinst
@@ -69,6 +69,10 @@ if [ -d ${product_dir}/plugins/opensearch-security ]; then
     echo "### Create opensearch demo certificates in ${config_dir}/"
     echo " See demo certs creation log in ${log_dir}/install_demo_configuration.log"
 fi
+echo "### Upcoming breaking change in packaging"
+echo " We are planing to tighten the permissions of installed files in a future version of the opensearch package."
+echo " If you setup tooling that needs read access to the OpenSearch configuration files, we invite you to add the user running these tools to the 'opensearch' group."
+echo " More info: https://github.com/opensearch-project/opensearch-build/pull/4043"
 exit 0
 
 
diff --git a/scripts/pkg/build_templates/opensearch/rpm/opensearch.rpm.spec b/scripts/pkg/build_templates/opensearch/rpm/opensearch.rpm.spec
@@ -132,6 +132,10 @@ if [ -d %{product_dir}/plugins/opensearch-security ]; then
     echo "### Create opensearch demo certificates in %{config_dir}/"
     echo " See demo certs creation log in %{log_dir}/install_demo_configuration.log"
 fi
+echo "### Upcoming breaking change in packaging"
+echo " We are planing to tighten the permissions of installed files in a future version of the opensearch package."
+echo " If you setup tooling that needs read access to the OpenSearch configuration files, we invite you to add the user running these tools to the 'opensearch' group."
+echo " More info: https://github.com/opensearch-project/opensearch-build/pull/4043"
 exit 0
 
 %preun