Clarify ScheduledBackup.spec.schedule format.

The Kubernetes CronJob schedule syntax follows the five-field unix-style crontab syntax.

The robfig/cron package uses a six-field syntax where the additional fields denotes seconds.

Signed-off-by: Alex Pearce <alex@alexpearce.me>

Author: alexpearce

api/v1/scheduledbackup_types.go

@@ -31,7 +31,8 @@ type ScheduledBackupSpec struct {
 	// If the first backup has to be immediately start after creation or not
 	Immediate *bool `json:"immediate,omitempty"`
 
-	// The schedule follows the same format used in Kubernetes CronJobs,
+	// The schedule does not follow the same format used in Kubernetes CronJobs
+	// as it includes an additional seconds specifier,
 	// see https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format
 	Schedule string `json:"schedule"`
 

config/crd/bases/postgresql.cnpg.io_scheduledbackups.yaml

@@ -72,8 +72,9 @@ spec:
                   creation or not
                 type: boolean
               schedule:
-                description: The schedule follows the same format used in Kubernetes
-                  CronJobs, see https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format
+                description: The schedule does not follow the same format used in
+                  Kubernetes CronJobs as it includes an additional seconds specifier,
+                  see https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format
                 type: string
               suspend:
                 description: If this backup is suspended or not

docs/src/api_reference.md

@@ -883,7 +883,7 @@ Name                 | Description
 -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------
 `suspend             ` | If this backup is suspended or not                                                                                                                                                                                                                                                                                                   | *bool                                        
 `immediate           ` | If the first backup has to be immediately start after creation or not                                                                                                                                                                                                                                                                | *bool                                        
-`schedule            ` | The schedule follows the same format used in Kubernetes CronJobs, see https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format                                                                                                                                                                                           - *mandatory*  | string                                       
+`schedule            ` | The schedule does not follow the same format used in Kubernetes CronJobs as it includes an additional seconds specifier, see https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format                                                                                                                                    - *mandatory*  | string                                       
 `cluster             ` | The cluster to backup                                                                                                                                                                                                                                                                                                                | [LocalObjectReference](#LocalObjectReference)
 `backupOwnerReference` | Indicates which ownerReference should be put inside the created backup resources.<br /> - none: no owner reference for created backup objects (same behavior as before the field was introduced)<br /> - self: sets the Scheduled backup object as owner of the backup<br /> - cluster: set the cluster as owner of the backup<br /> | string