feat: add the ability to set a MAILFROM value for local cron emails

Closes #7419
This commit is contained in:
Jose Diaz-Gonzalez committed 2024-12-17 00:28:21 -05:00
1 parent 819f9a84c9
commit b93a47c35b
7 files changed
+50 -5

No files matched your search

+20
View File
@@ -48,10 +48,30 @@ When running scheduled cron tasks, there are a few items to be aware of:
- Schedules are performed on the hosting server's timezone, which is typically UTC. - Schedules are performed on the hosting server's timezone, which is typically UTC.
- At this time, only the `PATH` and `SHELL` environment variables are specified in the cron template. - At this time, only the `PATH` and `SHELL` environment variables are specified in the cron template.
- A `MAILTO` value can be set via the `cron:set` command. - A `MAILTO` value can be set via the `cron:set` command.
- A `MAILFROM` value can be set via the `cron:set` command.
- Each scheduled task is executed within a one-off `run` container, and thus inherit any docker-options specified for `run` containers. Resources are never shared between scheduled tasks. - Each scheduled task is executed within a one-off `run` container, and thus inherit any docker-options specified for `run` containers. Resources are never shared between scheduled tasks.
- Scheduled cron tasks are supported on a per-scheduler basis, and are currently only implemented by the `docker-local` scheduler. - Scheduled cron tasks are supported on a per-scheduler basis, and are currently only implemented by the `docker-local` scheduler.
- Tasks for _all_ apps managed by the `docker-local` scheduler are written to a single crontab file owned by the `dokku` user. The `dokku` user's crontab should be considered reserved for this purpose. - Tasks for _all_ apps managed by the `docker-local` scheduler are written to a single crontab file owned by the `dokku` user. The `dokku` user's crontab should be considered reserved for this purpose.
#### Specifying a MAILFROM value
> [!IMPORTANT]
> New as of 0.35.14
Users can specify a value for `MAILFROM` via the global `mailfrom` cron property by using the `cron:set` command.
```shell
dokku cron:set --global mailfrom example@example.com
```
All output for individual cron runs will be sent from the specified email.
Cron emails can be reset to use the system email by running the `cron:set` command for the global `mailfrom` property with no value.
```shell
dokku cron:set --global mailfrom
```
#### Specifying a MAILTO value #### Specifying a MAILTO value
By default, cron tasks complete and do not perform any reporting. Users can specify a value for `MAILTO` via the global `mailto` cron property by using the `cron:set` command. By default, cron tasks complete and do not perform any reporting. Users can specify a value for `MAILTO` via the global `mailto` cron property by using the `cron:set` command.
+4 -2
View File
@@ -12,12 +12,14 @@ import (
var ( var (
// DefaultProperties is a map of all valid cron properties with corresponding default property values // DefaultProperties is a map of all valid cron properties with corresponding default property values
DefaultProperties = map[string]string{ DefaultProperties = map[string]string{
"mailto": "", "mailfrom": "",
"mailto": "",
} }
// GlobalProperties is a map of all valid global cron properties // GlobalProperties is a map of all valid global cron properties
GlobalProperties = map[string]bool{ GlobalProperties = map[string]bool{
"mailto": true, "mailfrom": true,
"mailto": true,
} }
) )
+5
View File
@@ -13,6 +13,7 @@ func ReportSingleApp(appName string, format string, infoFlag string) error {
} }
flags := map[string]common.ReportFunc{ flags := map[string]common.ReportFunc{
"--cron-mailfrom": reportMailfrom,
"--cron-mailto": reportMailto, "--cron-mailto": reportMailto,
"--cron-task-count": reportTasks, "--cron-task-count": reportTasks,
} }
@@ -28,6 +29,10 @@ func ReportSingleApp(appName string, format string, infoFlag string) error {
return common.ReportSingleApp("cron", appName, infoFlag, infoFlags, flagKeys, format, trimPrefix, uppercaseFirstCharacter) return common.ReportSingleApp("cron", appName, infoFlag, infoFlags, flagKeys, format, trimPrefix, uppercaseFirstCharacter)
} }
func reportMailfrom(_ string) string {
return common.PropertyGet("cron", "--global", "mailfrom")
}
func reportMailto(_ string) string { func reportMailto(_ string) string {
return common.PropertyGet("cron", "--global", "mailto") return common.PropertyGet("cron", "--global", "mailto")
} }
+4
View File
@@ -3,6 +3,10 @@ package cron
import "errors" import "errors"
func validateSetValue(appName string, key string, value string) error { func validateSetValue(appName string, key string, value string) error {
if key == "mailfrom" && appName != "--global" {
return errors.New("Property cannot be specified on a per-app basis")
}
if key == "mailto" && appName != "--global" { if key == "mailto" && appName != "--global" {
return errors.New("Property cannot be specified on a per-app basis") return errors.New("Property cannot be specified on a per-app basis")
} }
+3
View File
@@ -1,3 +1,6 @@
{{ if .Mailfrom -}}
MAILFROM={{ .Mailfrom }}
{{ end -}}
{{ if .Mailto -}} {{ if .Mailto -}}
MAILTO={{ .Mailto }} MAILTO={{ .Mailto }}
{{ end -}} {{ end -}}
+5 -1
View File
@@ -9,7 +9,11 @@ import (
// TriggerCronGetProperty writes the cron key to stdout for a given app container // TriggerCronGetProperty writes the cron key to stdout for a given app container
func TriggerCronGetProperty(appName string, key string) error { func TriggerCronGetProperty(appName string, key string) error {
if key != "mailto" { validProperties := map[string]bool{
"mailfrom": true,
"mailto": true,
}
if !validProperties[key] {
return errors.New("Invalid cron property specified") return errors.New("Invalid cron property specified")
} }
+9 -2
View File
@@ -124,14 +124,21 @@ func writeCronEntries() error {
return deleteCrontab() return deleteCrontab()
} }
results, _ := common.CallPlugnTrigger(common.PlugnTriggerInput{ resultfromResults, _ := common.CallPlugnTrigger(common.PlugnTriggerInput{
Trigger: "cron-get-property",
Args: []string{"--global", "mailfrom"},
})
mailfrom := resultfromResults.StdoutContents()
mailtoResults, _ := common.CallPlugnTrigger(common.PlugnTriggerInput{
Trigger: "cron-get-property", Trigger: "cron-get-property",
Args: []string{"--global", "mailto"}, Args: []string{"--global", "mailto"},
}) })
mailto := results.StdoutContents() mailto := mailtoResults.StdoutContents()
data := map[string]interface{}{ data := map[string]interface{}{
"Commands": commands, "Commands": commands,
"Mailfrom": mailfrom,
"Mailto": mailto, "Mailto": mailto,
} }