Cron Schedule

README.md

@@ -36,24 +36,29 @@ As a common example, if you sleep all of your staging/ephemeral deployments for
     helm install snorlax moonbeam/snorlax --create-namespace --namespace snorlax
     ```
 
-2. Create your `SleepSchedule` resource to define the schedule for the deployment
+2. Create your `SleepSchedule` resource to define the schedule for the deployment. You can use either a daily window or cron schedule:
+
+    **Using Daily Window:**
     ```yaml
     # filename: your-app-sleep-schedule.yaml
-
     apiVersion: snorlax.moonbeam.nyc/v1beta1
     kind: SleepSchedule
     metadata:
       namespace: your-app-namespace
       name: your-app
     spec:
       # Required fields
-      wakeTime: '8:00am'
-      sleepTime: '10:00pm'
+      dailyWindow:
+        wakeTime: '8:00am'
+        sleepTime: '10:00pm'
       deployments:
       - name: your-app-frontend
       - name: your-app-db
       - name: your-app-redis
 
+      # (optional, defaults to UTC) timezone for the sleep schedule using IANA format
+      timezone: 'America/New_York'
+
       # (optional) the ingresses to update and point to the snorlax wake server,
       # which wakes your deployment when a request is received while it's
       # sleeping.
@@ -65,9 +70,33 @@ As a common example, if you sleep all of your staging/ephemeral deployments for
         requires:
         - deployment:
             name: your-app-frontend
+    ```
+
+    **Using Cron Schedule:**
+    ```yaml
+    # filename: your-app-sleep-schedule.yaml
+    apiVersion: snorlax.moonbeam.nyc/v1beta1
+    kind: SleepSchedule
+    metadata:
+      namespace: your-app-namespace
+      name: your-app
+    spec:
+      # Required fields
+      cronSchedule:
+        wakeSchedule: '0 8 * * 1-5'  # Wake at 8am on weekdays
+        sleepSchedule: '0 22 * * *'  # Sleep at 10pm daily
+      deployments:
+      - name: your-app-frontend
+      - name: your-app-db
+      - name: your-app-redis
 
-      # (optional, defaults to UTC) the timezone to use for the input times above
+      # Optional fields
       timezone: 'America/New_York'
+      ingresses:
+      - name: your-app-ingress
+        requires:
+        - deployment:
+            name: your-app-frontend
     ```
 
 3. Apply the `SleepSchedule` resource
@@ -77,7 +106,8 @@ As a common example, if you sleep all of your staging/ephemeral deployments for
 
 ## Other features
 
-- **Ingress controller awareness**: Snorlax determines which ingress controller you're running so it can create the correct ingress routes for sleep.
+- **Flexible scheduling**: Support for both daily windows and cron expressions for more complex scheduling needs
+- **Ingress controller awareness**: Snorlax determines which ingress controller you're running so it can create the correct ingress routes for sleep
 - **Stays awake until next sleep cycle**: If a request is received during the sleep time, the deployment will stay awake until the next sleep cycle
 - **Ignores ELB health checks**: Snorlax ignores health checks from ELBs so that they don't wake up the deployment
 
@@ -114,7 +144,6 @@ make dev-run
 - Scale entire namespaces
 - Sleep when no requests are received for a certain period of time
 - Add support for custom wake & sleep actions (e.g. hit a webhook on wake)
-- Add support for cron-style schedules (e.g. `0 8 * * *`)
 - Add a button to manually wake up the deployment (instead of auto-waking on request)
 - Custom image/gif for sleeping page
 - Always sleeping mode, reset at a certain time of day

charts/snorlax/templates/sleepschedule-crd.yaml

@@ -76,19 +76,42 @@ spec:
                   - name
                   type: object
                 type: array
-              sleepTime:
-                description: The time that the deployment will start sleeping
-                type: string
+              dailyWindow:
+                description: The daily times that the deployment will wake up and start sleeping
+                properties:
+                  wakeTime:
+                    description: The time that the deployment will wake up
+                    type: string
+                  sleepTime:
+                    description: The time that the deployment will start sleeping
+                    type: string
+                required:
+                - wakeTime
+                - sleepTime
+                type: object
+              cronSchedule:
+                description: The cron schedule that will be used to determine when the deployment will sleep/wake
+                properties:
+                  wakeSchedule:
+                    description: The cron schedule for when the deployment should wake up
+                    type: string
+                  sleepSchedule: 
+                    description: The cron schedule for when the deployment should go to sleep
+                    type: string
+                required:
+                - wakeSchedule
+                - sleepSchedule
+                type: object
               timezone:
                 description: The timezone that the input times are based in
                 type: string
-              wakeTime:
-                description: The time that the deployment will wake up
-                type: string
-            required:
-            - sleepTime
-            - timezone
-            - wakeTime
+            oneOf:
+            - required:
+              - dailyWindow
+              - timezone
+            - required:
+              - cronSchedule
+              - timezone
             type: object
           status:
             description: SleepScheduleStatus defines the observed state of SleepSchedule

dummy-app/k8s-manifests.yaml

@@ -4,8 +4,9 @@ metadata:
   namespace: default
   name: dummy
 spec:
-  wakeTime: '10:00am'
-  sleepTime: '10:01am'
+  dailyWindow:
+    wakeTime: '10:00am'
+    sleepTime: '10:01am'
   timezone: 'America/New_York'
   deployments:
   - name: dummy-frontend

operator/Makefile

@@ -113,7 +113,7 @@ vet: ## Run go vet against code.
 
 .PHONY: test
 test: manifests generate fmt vet envtest ## Run tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $$(go list ./... | grep -v /e2e) -coverprofile cover.out
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $$(go list ./... | grep -v /e2e) -v -ginkgo.v -coverprofile cover.out
 
 # Utilize Kind or modify the e2e tests to load the image locally, enabling compatibility with other vendors.
 .PHONY: test-e2e  # Run the e2e tests against a Kind k8s instance that is spun up.

operator/api/v1beta1/sleepschedule_types.go

@@ -23,20 +23,40 @@ import (
 // EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
 // NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
 
-type SleepScheduleSpec struct {
-	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
-	// Important: Run "make" to regenerate code after modifying this file
-
+type DailyWindow struct {
 	// The time that the deployment will wake up
 	// +kubebuilder:validation:Required
 	WakeTime string `json:"wakeTime"`
 
 	// The time that the deployment will start sleeping
 	// +kubebuilder:validation:Required
 	SleepTime string `json:"sleepTime"`
+}
 
-	// The timezone that the input times are based in
+type CronSchedule struct {
+	// The cron schedule for when the deployment should wake up
+	// +kubebuilder:validation:Required
+	WakeSchedule string `json:"wakeSchedule"`
+
+	// The cron schedule for when the deployment should go to sleep
 	// +kubebuilder:validation:Required
+	SleepSchedule string `json:"sleepSchedule"`
+}
+
+// SleepScheduleSpec defines optional and required fields for SleepSchedule
+// +kubebuilder:validation:XValidation:rule="has(self.dailyWindow) != has(self.cronSchedule)",message="exactly one of dailyWindow or cronSchedule must be specified"
+type SleepScheduleSpec struct {
+	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
+	// Important: Run "make" to regenerate code after modifying this file
+
+	// The time that the deployment will wake up and start sleeping
+	DailyWindow *DailyWindow `json:"dailyWindow,omitempty"`
+
+	// The cron schedule that will be used to determine when the deployment will sleep/wake
+	CronSchedule *CronSchedule `json:"cronSchedule,omitempty"`
+
+	// The timezone that the input times are based in
+	// +optional
 	Timezone string `json:"timezone"`
 
 	// The deployments that will be slept/woken.

operator/cmd/main.go

@@ -36,7 +36,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 
 	snorlaxv1beta1 "moonbeam-nyc/snorlax/api/v1beta1"
-	"moonbeam-nyc/snorlax/internal/controller"
+	controller "moonbeam-nyc/snorlax/internal/controller"
+	util "moonbeam-nyc/snorlax/internal/util"
 	//+kubebuilder:scaffold:imports
 )
 
@@ -124,10 +125,11 @@ func main() {
 		os.Exit(1)
 	}
 
-	if err = (&controller.SleepScheduleReconciler{
-		Client: mgr.GetClient(),
-		Scheme: mgr.GetScheme(),
-	}).SetupWithManager(mgr); err != nil {
+	if err = controller.NewReconciler(
+		mgr.GetClient(),
+		mgr.GetScheme(),
+		util.RealTime{},
+	).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "SleepSchedule")
 		os.Exit(1)
 	}

operator/config/crd/bases/snorlax.moonbeam.nyc_sleepschedules.yaml

@@ -37,7 +37,38 @@ spec:
           metadata:
             type: object
           spec:
+            description: SleepScheduleSpec defines optional and required fields for
+              SleepSchedule
             properties:
+              cronSchedule:
+                description: The cron schedule that will be used to determine when
+                  the deployment will sleep/wake
+                properties:
+                  sleepSchedule:
+                    description: The cron schedule for when the deployment should
+                      go to sleep
+                    type: string
+                  wakeSchedule:
+                    description: The cron schedule for when the deployment should
+                      wake up
+                    type: string
+                required:
+                - sleepSchedule
+                - wakeSchedule
+                type: object
+              dailyWindow:
+                description: The time that the deployment will wake up and start sleeping
+                properties:
+                  sleepTime:
+                    description: The time that the deployment will start sleeping
+                    type: string
+                  wakeTime:
+                    description: The time that the deployment will wake up
+                    type: string
+                required:
+                - sleepTime
+                - wakeTime
+                type: object
               deployments:
                 description: The deployments that will be slept/woken.
                 items:
@@ -75,20 +106,13 @@ spec:
                   - name
                   type: object
                 type: array
-              sleepTime:
-                description: The time that the deployment will start sleeping
-                type: string
               timezone:
                 description: The timezone that the input times are based in
                 type: string
-              wakeTime:
-                description: The time that the deployment will wake up
-                type: string
-            required:
-            - sleepTime
-            - timezone
-            - wakeTime
             type: object
+            x-kubernetes-validations:
+            - message: exactly one of dailyWindow or cronSchedule must be specified
+              rule: has(self.dailyWindow) != has(self.cronSchedule)
           status:
             description: SleepScheduleStatus defines the observed state of SleepSchedule
             properties:

operator/config/samples/snorlax_v1beta1_sleepschedule.yaml

@@ -10,8 +10,9 @@ metadata:
   namespace: default
   name: sleepschedule-sample
 spec:
-  wakeTime: 7am
-  sleepTime: 11pm
+  dailyWindow:
+    wakeTime: 7am
+    sleepTime: 11pm
   timezone: America/New_York
   deploymentName: dummy-deployment
   wakeReplicas: 3

operator/go.mod

@@ -13,6 +13,7 @@ require (
 )
 
 require (
+	github.com/adhocore/gronx v1.19.5 // indirect
 	github.com/antlr/antlr4/runtime/Go/antlr/v4 v4.0.0-20230305170008-8188dc5388df // indirect
 	github.com/blang/semver/v4 v4.0.0 // indirect
 	github.com/cenkalti/backoff/v4 v4.2.1 // indirect

operator/go.sum

@@ -1,3 +1,5 @@
+github.com/adhocore/gronx v1.19.5 h1:cwIG4nT1v9DvadxtHBe6MzE+FZ1JDvAUC45U2fl4eSQ=
+github.com/adhocore/gronx v1.19.5/go.mod h1:7oUY1WAU8rEJWmAxXR2DN0JaO4gi9khSgKjiRypqteg=
 github.com/antlr/antlr4/runtime/Go/antlr/v4 v4.0.0-20230305170008-8188dc5388df h1:7RFfzj4SSt6nnvCPbCqijJi1nWCd+TqAT3bYCStRC18=
 github.com/antlr/antlr4/runtime/Go/antlr/v4 v4.0.0-20230305170008-8188dc5388df/go.mod h1:pSwJ0fSY5KhvocuWSx4fz3BA8OrA1bQn+K1Eli3BRwM=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=