This is an automated email from the ASF dual-hosted git repository.
rohit pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudstack.git
The following commit(s) were added to refs/heads/main by this push:
new b8d834e7596 quota: Improves email configurations descriptions (#6806)
b8d834e7596 is described below
commit b8d834e7596c3ba7d102db44fc7e7acbca54c9c6
Author: Stephan Krug <[email protected]>
AuthorDate: Sat Oct 8 03:29:55 2022 -0300
quota: Improves email configurations descriptions (#6806)
The alert.email.addresses description is ambiguous and can cause doubts to
operators. This description has been altered to avoid confusion. In addition,
typos in alert.smtp.useStartTLS and project.smtp.useStartTLS have been fixed.
Co-authored-by: Stephan Krug <[email protected]>
---
.../src/main/java/com/cloud/alert/AlertManager.java | 2 +-
.../main/resources/META-INF/db/schema-41710to41800.sql | 6 ++++++
.../apache/cloudstack/quota/constant/QuotaConfig.java | 18 +++++++++---------
.../src/main/java/com/cloud/configuration/Config.java | 2 +-
.../main/java/com/cloud/projects/ProjectManager.java | 2 +-
5 files changed, 18 insertions(+), 12 deletions(-)
diff --git
a/engine/components-api/src/main/java/com/cloud/alert/AlertManager.java
b/engine/components-api/src/main/java/com/cloud/alert/AlertManager.java
index 2b7ffc9436b..ecdb59667c9 100644
--- a/engine/components-api/src/main/java/com/cloud/alert/AlertManager.java
+++ b/engine/components-api/src/main/java/com/cloud/alert/AlertManager.java
@@ -36,7 +36,7 @@ public interface AlertManager extends Manager, AlertService {
ConfigKey.Scope.Cluster, null);
public static final ConfigKey<Boolean> AlertSmtpUseStartTLS = new
ConfigKey<Boolean>("Advanced", Boolean.class, "alert.smtp.useStartTLS", "false",
- "If set to true and if we enable security via alert.smtp.useAuth,
this will enable StartTLS to secure the conection.", true);
+ "If set to true and if we enable security via alert.smtp.useAuth,
this will enable StartTLS to secure the connection.", true);
public static final ConfigKey<String> AlertSmtpEnabledSecurityProtocols =
new ConfigKey<String>("Advanced", String.class,
"alert.smtp.enabledSecurityProtocols", "",
"White-space separated security protocols; ex: \"TLSv1 TLSv1.1\".
Supported protocols: SSLv2Hello, SSLv3, TLSv1, TLSv1.1 and TLSv1.2", true);
diff --git
a/engine/schema/src/main/resources/META-INF/db/schema-41710to41800.sql
b/engine/schema/src/main/resources/META-INF/db/schema-41710to41800.sql
index ce553cf4453..7aeee1aa22c 100644
--- a/engine/schema/src/main/resources/META-INF/db/schema-41710to41800.sql
+++ b/engine/schema/src/main/resources/META-INF/db/schema-41710to41800.sql
@@ -575,3 +575,9 @@ FROM
AND (`custom_speed`.`name` = 'CpuSpeed'))))
LEFT JOIN `user_vm_details` `custom_ram_size` ON
(((`custom_ram_size`.`vm_id` = `vm_instance`.`id`)
AND (`custom_ram_size`.`name` = 'memory'))));
+
+-- Improve alert.email.addresses description #6806.
+UPDATE cloud.configuration
+SET description = 'Comma separated list of email addresses which are going
to receive alert emails.'
+WHERE name = 'alert.email.addresses';
+
diff --git
a/framework/quota/src/main/java/org/apache/cloudstack/quota/constant/QuotaConfig.java
b/framework/quota/src/main/java/org/apache/cloudstack/quota/constant/QuotaConfig.java
index 4cb855f4fac..31875a167da 100644
---
a/framework/quota/src/main/java/org/apache/cloudstack/quota/constant/QuotaConfig.java
+++
b/framework/quota/src/main/java/org/apache/cloudstack/quota/constant/QuotaConfig.java
@@ -22,7 +22,7 @@ import org.apache.cloudstack.framework.config.ConfigKey;
public interface QuotaConfig {
public static final ConfigKey<Boolean> QuotaPluginEnabled = new
ConfigKey<Boolean>("Advanced", Boolean.class, "quota.enable.service", "false",
- "Indicates whether Quota plugin is enabled or not", true);
+ "Indicates whether Quota plugin is enabled or not.", true);
public static final ConfigKey<String> QuotaEnableEnforcement = new
ConfigKey<String>("Advanced", String.class, "quota.enable.enforcement", "false",
"Enable the usage quota enforcement, i.e. on true when exceeding
quota the respective account will be locked.", true);
@@ -33,29 +33,29 @@ public interface QuotaConfig {
public static final ConfigKey<Integer> QuotaStatementPeriod = new
ConfigKey<Integer>("Advanced", Integer.class, "quota.statement.period", "1",
"This variables define the statement generation interval. Values
correspond to bimonthly=0, monthly=1, quarterly=2, half-yearly=3 and
yearly=4.", true);
- public static final ConfigKey<String> QuotaSmtpHost = new
ConfigKey<String>("Advanced", String.class, "quota.usage.smtp.host", "", "Quota
SMTP host for quota related emails",
+ public static final ConfigKey<String> QuotaSmtpHost = new
ConfigKey<String>("Advanced", String.class, "quota.usage.smtp.host", "", "Quota
SMTP host for quota related emails.",
true);
public static final ConfigKey<String> QuotaSmtpTimeout = new
ConfigKey<String>("Advanced", String.class,
"quota.usage.smtp.connection.timeout", "60",
- "Quota SMTP server connection timeout duration", true);
+ "Quota SMTP server connection timeout duration.", true);
- public static final ConfigKey<String> QuotaSmtpUser = new
ConfigKey<String>("Advanced", String.class, "quota.usage.smtp.user", "", "Quota
SMTP server username", true);
+ public static final ConfigKey<String> QuotaSmtpUser = new
ConfigKey<String>("Advanced", String.class, "quota.usage.smtp.user", "", "Quota
SMTP server username.", true);
- public static final ConfigKey<String> QuotaSmtpPassword = new
ConfigKey<String>("Advanced", String.class, "quota.usage.smtp.password", "",
"Quota SMTP server password", true);
+ public static final ConfigKey<String> QuotaSmtpPassword = new
ConfigKey<String>("Advanced", String.class, "quota.usage.smtp.password", "",
"Quota SMTP server password.", true);
- public static final ConfigKey<String> QuotaSmtpPort = new
ConfigKey<String>("Advanced", String.class, "quota.usage.smtp.port", "", "Quota
SMTP port", true);
+ public static final ConfigKey<String> QuotaSmtpPort = new
ConfigKey<String>("Advanced", String.class, "quota.usage.smtp.port", "", "Quota
SMTP port.", true);
public static final ConfigKey<String> QuotaSmtpAuthType = new
ConfigKey<String>("Advanced", String.class, "quota.usage.smtp.useAuth", "",
"If true, use secure SMTP authentication when sending emails.",
true);
public static final ConfigKey<String> QuotaSmtpSender = new
ConfigKey<String>("Advanced", String.class, "quota.usage.smtp.sender", "",
- "Sender of quota alert email (will be in the From header of the
email)", true);
+ "Sender of quota alert email (will be in the From header of the
email).", true);
public static final ConfigKey<String> QuotaSmtpEnabledSecurityProtocols =
new ConfigKey<String>("Advanced", String.class,
"quota.usage.smtp.enabledSecurityProtocols", "",
- "White-space separated security protocols; ex: \"TLSv1 TLSv1.1\".
Supported protocols: SSLv2Hello, SSLv3, TLSv1, TLSv1.1 and TLSv1.2", true);
+ "White-space separated security protocols; ex: \"TLSv1 TLSv1.1\".
Supported protocols: SSLv2Hello, SSLv3, TLSv1, TLSv1.1 and TLSv1.2.", true);
public static final ConfigKey<String> QuotaSmtpUseStartTLS = new
ConfigKey<String>("Advanced", String.class, "quota.usage.smtp.useStartTLS",
"false",
- "If set to true and if we enable security via
quota.usage.smtp.useAuth, this will enable StartTLS to secure the conection.",
true);
+ "If set to true and if we enable security via
quota.usage.smtp.useAuth, this will enable StartTLS to secure the connection.",
true);
enum QuotaEmailTemplateTypes {
QUOTA_LOW, QUOTA_EMPTY, QUOTA_UNLOCK_ACCOUNT, QUOTA_STATEMENT
diff --git a/server/src/main/java/com/cloud/configuration/Config.java
b/server/src/main/java/com/cloud/configuration/Config.java
index 67fe9ad19a8..cb2c673aafb 100644
--- a/server/src/main/java/com/cloud/configuration/Config.java
+++ b/server/src/main/java/com/cloud/configuration/Config.java
@@ -53,7 +53,7 @@ public enum Config {
String.class,
"alert.email.addresses",
null,
- "Comma separated list of email addresses used for sending alerts.",
+ "Comma separated list of email addresses which are going to
receive alert emails.",
null),
AlertEmailSender("Alert", ManagementServer.class, String.class,
"alert.email.sender", null, "Sender of alert email (will be in the From header
of the email).", null),
AlertSMTPHost("Alert", ManagementServer.class, String.class,
"alert.smtp.host", null, "SMTP hostname used for sending out email alerts.",
null),
diff --git a/server/src/main/java/com/cloud/projects/ProjectManager.java
b/server/src/main/java/com/cloud/projects/ProjectManager.java
index 8eebfd3d158..7bc91c52874 100644
--- a/server/src/main/java/com/cloud/projects/ProjectManager.java
+++ b/server/src/main/java/com/cloud/projects/ProjectManager.java
@@ -23,7 +23,7 @@ import org.apache.cloudstack.framework.config.ConfigKey;
public interface ProjectManager extends ProjectService {
public static final ConfigKey<Boolean> ProjectSmtpUseStartTLS = new
ConfigKey<Boolean>("Advanced", Boolean.class, "project.smtp.useStartTLS",
"false",
- "If set to true and if we enable security via
project.smtp.useAuth, this will enable StartTLS to secure the conection.",
true);
+ "If set to true and if we enable security via
project.smtp.useAuth, this will enable StartTLS to secure the connection.",
true);
public static final ConfigKey<String> ProjectSmtpEnabledSecurityProtocols
= new ConfigKey<String>("Advanced", String.class,
"project.smtp.enabledSecurityProtocols", "",
"White-space separated security protocols; ex: \"TLSv1 TLSv1.1\".
Supported protocols: SSLv2Hello, SSLv3, TLSv1, TLSv1.1 and TLSv1.2", true);
