Watcher deprecate notification service settings (#36403)

Deprecates all the settings for watcher notifications account that are dynamic cluster filtered and have a corresponding secure sibling. They are deprecated in favor of the sibling that is stored in the keystore. Follow-up on #35610
elastic · Dec 18, 2018 · adc961f · adc961f
1 parent 15d1e70
commit adc961f
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 9 deletions.
diff --git a/docs/reference/migration/migrate_6_6.asciidoc b/docs/reference/migration/migrate_6_6.asciidoc
@@ -79,3 +79,31 @@ GET /stackoverflow/_search
 --------------------------------------------------
 // CONSOLE
 // TEST[setup:stackoverflow]
+
+[float]
+=== Settings changes
+
+[float]
+[[watcher-notifications-account-settings]]
+==== Watcher notifications account settings
+
+The following settings have been deprecated and the secure variants should
+be used instead. The <<secure-settings, secure settings>> have to be defined
+inside each cluster node's keystore, i.e., they are not to be specified via
+the cluster settings API.
+
+- `xpack.notification.email.account.<id>.smtp.password`, instead use
+`xpack.notification.email.account.<id>.smtp.secure_password`
+- `xpack.notification.hipchat.account.<id>.auth_token`, instead use
+`xpack.notification.hipchat.account.<id>.secure_auth_token`
+- `xpack.notification.jira.account.<id>.url`, instead use
+`xpack.notification.jira.account.<id>.secure_url`
+- `xpack.notification.jira.account.<id>.user`, instead use
+`xpack.notification.jira.account.<id>.secure_user`
+- `xpack.notification.jira.account.<id>.password`, instead use
+`xpack.notification.jira.account.<id>.secure_password`
+- `xpack.notification.pagerduty.account.<id>.service_api_key`, instead use
+`xpack.notification.pagerduty.account.<id>.secure_service_api_key`
+- `xpack.notification.slack.account.<id>.url`, instead use
+`xpack.notification.slack.account.<id>.secure_url`
+
diff --git a/...atcher/src/main/java/org/elasticsearch/xpack/watcher/notification/email/EmailService.java b/...atcher/src/main/java/org/elasticsearch/xpack/watcher/notification/email/EmailService.java
@@ -65,7 +65,7 @@ public class EmailService extends NotificationService<Account> {
 
     private static final Setting.AffixSetting<String> SETTING_SMTP_PASSWORD =
             Setting.affixKeySetting("xpack.notification.email.account.", "smtp.password",
-                    (key) -> Setting.simpleString(key, Property.Dynamic, Property.NodeScope, Property.Filtered));
+                    (key) -> Setting.simpleString(key, Property.Dynamic, Property.NodeScope, Property.Filtered, Property.Deprecated));
 
     private static final Setting.AffixSetting<SecureString> SETTING_SECURE_PASSWORD =
         Setting.affixKeySetting("xpack.notification.email.account.", "smtp.secure_password",

diff --git a/...er/src/main/java/org/elasticsearch/xpack/watcher/notification/hipchat/HipChatService.java b/...er/src/main/java/org/elasticsearch/xpack/watcher/notification/hipchat/HipChatService.java
@@ -32,9 +32,9 @@ public class HipChatService extends NotificationService<HipChatAccount> {
     static final Setting<Integer> SETTING_DEFAULT_PORT =
             Setting.intSetting("xpack.notification.hipchat.port", 443, Setting.Property.Dynamic, Setting.Property.NodeScope);
 
-    private static final Setting.AffixSetting<String> SETTING_AUTH_TOKEN =
-            Setting.affixKeySetting("xpack.notification.hipchat.account.", "auth_token",
-                    (key) -> Setting.simpleString(key, Setting.Property.Dynamic, Setting.Property.NodeScope, Setting.Property.Filtered));
+    private static final Setting.AffixSetting<String> SETTING_AUTH_TOKEN = Setting.affixKeySetting("xpack.notification.hipchat.account.",
+            "auth_token", (key) -> Setting.simpleString(key, Setting.Property.Dynamic, Setting.Property.NodeScope,
+                    Setting.Property.Filtered, Setting.Property.Deprecated));
 
     private static final Setting.AffixSetting<SecureString> SETTING_AUTH_TOKEN_SECURE =
             Setting.affixKeySetting("xpack.notification.hipchat.account.", "secure_auth_token",

diff --git a/.../watcher/src/main/java/org/elasticsearch/xpack/watcher/notification/jira/JiraService.java b/.../watcher/src/main/java/org/elasticsearch/xpack/watcher/notification/jira/JiraService.java
@@ -34,15 +34,15 @@ public class JiraService extends NotificationService<JiraAccount> {
 
     private static final Setting.AffixSetting<String> SETTING_URL =
             Setting.affixKeySetting("xpack.notification.jira.account.", "url",
-                    (key) -> Setting.simpleString(key, Property.Dynamic, Property.NodeScope, Property.Filtered));
+                    (key) -> Setting.simpleString(key, Property.Dynamic, Property.NodeScope, Property.Filtered, Property.Deprecated));
 
     private static final Setting.AffixSetting<String> SETTING_USER =
             Setting.affixKeySetting("xpack.notification.jira.account.", "user",
-                    (key) -> Setting.simpleString(key, Property.Dynamic, Property.NodeScope, Property.Filtered));
+                    (key) -> Setting.simpleString(key, Property.Dynamic, Property.NodeScope, Property.Filtered, Property.Deprecated));
 
     private static final Setting.AffixSetting<String> SETTING_PASSWORD =
             Setting.affixKeySetting("xpack.notification.jira.account.", "password",
-                    (key) -> Setting.simpleString(key, Property.Dynamic, Property.NodeScope, Property.Filtered));
+                    (key) -> Setting.simpleString(key, Property.Dynamic, Property.NodeScope, Property.Filtered, Property.Deprecated));
 
     private static final Setting.AffixSetting<SecureString> SETTING_SECURE_USER =
             Setting.affixKeySetting("xpack.notification.jira.account.", "secure_user",

diff --git a/...rc/main/java/org/elasticsearch/xpack/watcher/notification/pagerduty/PagerDutyService.java b/...rc/main/java/org/elasticsearch/xpack/watcher/notification/pagerduty/PagerDutyService.java
@@ -28,7 +28,7 @@ public class PagerDutyService extends NotificationService<PagerDutyAccount> {
 
     private static final Setting.AffixSetting<String> SETTING_SERVICE_API_KEY =
             Setting.affixKeySetting("xpack.notification.pagerduty.account.", "service_api_key",
-                    (key) -> Setting.simpleString(key, Property.Dynamic, Property.NodeScope, Property.Filtered));
+                    (key) -> Setting.simpleString(key, Property.Dynamic, Property.NodeScope, Property.Filtered, Property.Deprecated));
 
     private static final Setting.AffixSetting<SecureString> SETTING_SECURE_SERVICE_API_KEY =
             Setting.affixKeySetting("xpack.notification.pagerduty.account.", "secure_service_api_key",

diff --git a/...atcher/src/main/java/org/elasticsearch/xpack/watcher/notification/slack/SlackService.java b/...atcher/src/main/java/org/elasticsearch/xpack/watcher/notification/slack/SlackService.java
@@ -28,7 +28,7 @@ public class SlackService extends NotificationService<SlackAccount> {
 
     private static final Setting.AffixSetting<String> SETTING_URL =
             Setting.affixKeySetting("xpack.notification.slack.account.", "url",
-                    (key) -> Setting.simpleString(key, Property.Dynamic, Property.NodeScope, Property.Filtered));
+                    (key) -> Setting.simpleString(key, Property.Dynamic, Property.NodeScope, Property.Filtered, Property.Deprecated));
 
     private static final Setting.AffixSetting<SecureString> SETTING_URL_SECURE =
             Setting.affixKeySetting("xpack.notification.slack.account.", "secure_url", (key) -> SecureSetting.secureString(key, null));