Merge pull request #62 from fluxcd/runinterval-interval

RunInterval -> Interval

Author: squaremo

api/v1alpha1/imageupdateautomation_types.go

@@ -23,16 +23,18 @@ import (
 	"github.com/fluxcd/pkg/apis/meta"
 )
 
+const ImageUpdateAutomationKind = "ImageUpdateAutomation"
+
 // ImageUpdateAutomationSpec defines the desired state of ImageUpdateAutomation
 type ImageUpdateAutomationSpec struct {
 	// Checkout gives the parameters for cloning the git repository,
 	// ready to make changes.
 	// +required
 	Checkout GitCheckoutSpec `json:"checkout"`
-	// RunInterval gives a lower bound for how often the automation
-	// run should be attempted. Otherwise it will default.
-	// +optional
-	RunInterval *metav1.Duration `json:"minimumRunInterval,omitempty"`
+	// Interval gives an lower bound for how often the automation
+	// run should be attempted.
+	// +required
+	Interval metav1.Duration `json:"interval"`
 	// Update gives the specification for how to update the files in
 	// the repository
 	// +required

api/v1alpha1/zz_generated.deepcopy.go

@@ -82,9 +82,9 @@ spec:
                 - authorEmail
                 - authorName
                 type: object
-              minimumRunInterval:
-                description: RunInterval gives a lower bound for how often the automation
-                  run should be attempted. Otherwise it will default.
+              interval:
+                description: Interval gives an lower bound for how often the automation
+                  run should be attempted.
                 type: string
               suspend:
                 description: Suspend tells the controller to not run this automation,
@@ -110,6 +110,7 @@ spec:
             required:
             - checkout
             - commit
+            - interval
             - update
             type: object
           status:

config/crd/bases/image.toolkit.fluxcd.io_imageupdateautomations.yaml

@@ -57,8 +57,6 @@ import (
 	"github.com/fluxcd/image-automation-controller/pkg/update"
 )
 
-const defaultInterval = 2 * time.Minute
-
 // log level for debug info
 const debug = 1
 const originRemote = "origin"
@@ -249,10 +247,10 @@ func (r *ImageUpdateAutomationReconciler) SetupWithManager(mgr ctrl.Manager) err
 
 // intervalOrDefault gives the interval specified, or if missing, the default
 func intervalOrDefault(auto *imagev1.ImageUpdateAutomation) time.Duration {
-	if auto.Spec.RunInterval != nil {
-		return auto.Spec.RunInterval.Duration
+	if auto.Spec.Interval.Duration < time.Second {
+		return time.Second
 	}
-	return defaultInterval
+	return auto.Spec.Interval.Duration
 }
 
 // durationSinceLastRun calculates how long it's been since the last

controllers/imageupdateautomation_controller.go

@@ -210,7 +210,7 @@ var _ = Describe("ImageUpdateAutomation", func() {
 						Namespace: updateKey.Namespace,
 					},
 					Spec: imagev1.ImageUpdateAutomationSpec{
-						RunInterval: &metav1.Duration{Duration: 2 * time.Hour}, // this is to ensure any subsequent run should be outside the scope of the testing
+						Interval: metav1.Duration{Duration: 2 * time.Hour}, // this is to ensure any subsequent run should be outside the scope of the testing
 						Checkout: imagev1.GitCheckoutSpec{
 							GitRepositoryRef: corev1.LocalObjectReference{
 								Name: gitRepoKey.Name,

controllers/update_test.go

@@ -172,17 +172,16 @@ ready to make changes.</p>
 </tr>
 <tr>
 <td>
-<code>minimumRunInterval</code><br>
+<code>interval</code><br>
 <em>
 <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
 Kubernetes meta/v1.Duration
 </a>
 </em>
 </td>
 <td>
-<em>(Optional)</em>
-<p>RunInterval gives a lower bound for how often the automation
-run should be attempted. Otherwise it will default.</p>
+<p>Interval gives an lower bound for how often the automation
+run should be attempted.</p>
 </td>
 </tr>
 <tr>
@@ -212,6 +211,19 @@ CommitSpec
 <p>Commit specifies how to commit to the git repo</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>suspend</code><br>
+<em>
+bool
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Suspend tells the controller to not run this automation, until
+it is unset (or set to false). Defaults to false.</p>
+</td>
+</tr>
 </table>
 </td>
 </tr>
@@ -264,17 +276,16 @@ ready to make changes.</p>
 </tr>
 <tr>
 <td>
-<code>minimumRunInterval</code><br>
+<code>interval</code><br>
 <em>
 <a href="https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
 Kubernetes meta/v1.Duration
 </a>
 </em>
 </td>
 <td>
-<em>(Optional)</em>
-<p>RunInterval gives a lower bound for how often the automation
-run should be attempted. Otherwise it will default.</p>
+<p>Interval gives an lower bound for how often the automation
+run should be attempted.</p>
 </td>
 </tr>
 <tr>
@@ -304,6 +315,19 @@ CommitSpec
 <p>Commit specifies how to commit to the git repo</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>suspend</code><br>
+<em>
+bool
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Suspend tells the controller to not run this automation, until
+it is unset (or set to false). Defaults to false.</p>
+</td>
+</tr>
 </tbody>
 </table>
 </div>
@@ -365,6 +389,21 @@ int64
 <em>(Optional)</em>
 </td>
 </tr>
+<tr>
+<td>
+<code>ReconcileRequestStatus</code><br>
+<em>
+<a href="https://godoc.org/github.com/fluxcd/pkg/apis/meta#ReconcileRequestStatus">
+github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus
+</a>
+</em>
+</td>
+<td>
+<p>
+(Members of <code>ReconcileRequestStatus</code> are embedded into this type.)
+</p>
+</td>
+</tr>
 </tbody>
 </table>
 </div>