feat: playbook runners (#770)

* feat: playbook runners

[skip ci]

* feat: add pull playbooks job

[skip ci]

* feat: add push playbook action job

[skip ci]

* feat: action consumers

[skip ci]

* feat: remove old runner

[skip ci]

* feat: handle delays and filters on agent runners

* chore: revert playbook tests package to 'playbook'

* feat: add templatesOn

* fix: existing playbook tests

* tests: playbook runners

Author: adityathebe

api/v1/playbook_actions.go

@@ -11,7 +11,6 @@ import (
 	"github.com/flanksource/duty"
 	"github.com/flanksource/duty/models"
 	"github.com/flanksource/duty/types"
-	"github.com/flanksource/gomplate/v3"
 	"k8s.io/client-go/kubernetes"
 )
 
@@ -325,6 +324,17 @@ type PlaybookAction struct {
 	// skip(): skip running this action
 	Filter string `yaml:"if,omitempty" json:"if,omitempty"`
 
+	// RunsOn specifies the agents that can run this action.
+	// When left empty, the action will run on the main instance itself.
+	RunsOn []string `json:"runsOn,omitempty" yaml:"runsOn,omitempty"`
+
+	// TemplatesOn specifies where the templating happens.
+	// Available options:
+	//  - host
+	//  - agent
+	// When left empty, the templating is done on the main instance(host) itself.
+	TemplatesOn string `json:"templatesOn,omitempty" yaml:"templatesOn,omitempty"`
+
 	Exec         *ExecAction         `json:"exec,omitempty" yaml:"exec,omitempty" template:"true"`
 	GitOps       *GitOpsAction       `json:"gitops,omitempty" yaml:"gitops,omitempty" template:"true"`
 	HTTP         *HTTPAction         `json:"http,omitempty" yaml:"http,omitempty" template:"true"`
@@ -333,7 +343,7 @@ type PlaybookAction struct {
 	Notification *NotificationAction `json:"notification,omitempty" yaml:"notification,omitempty" template:"true"`
 }
 
-func (p *PlaybookAction) DelayDuration(templateEnv map[string]any) (time.Duration, error) {
+func (p *PlaybookAction) DelayDuration() (time.Duration, error) {
 	if p.delay != nil {
 		return *p.delay, nil
 	}
@@ -342,12 +352,7 @@ func (p *PlaybookAction) DelayDuration(templateEnv map[string]any) (time.Duratio
 		return 0, nil
 	}
 
-	exprResult, err := gomplate.RunTemplate(templateEnv, gomplate.Template{Expression: p.Delay})
-	if err != nil {
-		return 0, fmt.Errorf("error running action delay expression(%s): %w", p.Delay, err)
-	}
-
-	d, err := duration.ParseDuration(exprResult)
+	d, err := duration.ParseDuration(p.Delay)
 	if err != nil {
 		return 0, err
 	}

api/v1/playbook_types.go

@@ -133,6 +133,17 @@ type PlaybookSpec struct {
 	// If multiple triggering events occur at the same time, multiple playbook runs will be triggered.
 	On *PlaybookTrigger `json:"on,omitempty" yaml:"on,omitempty"`
 
+	// RunsOn specifies the agents that can run this playbook.
+	// When left empty, the playbook will run on the main instance itself.
+	RunsOn []string `json:"runsOn,omitempty" yaml:"runsOn,omitempty"`
+
+	// TemplatesOn specifies where the templating happens.
+	// Available options:
+	//  - host
+	//  - agent
+	// When left empty, the templating is done on the main instance(host) itself.
+	TemplatesOn string `json:"templatesOn,omitempty" yaml:"templatesOn,omitempty"`
+
 	// Permissions ...
 	Permissions []Permission `json:"permissions,omitempty" yaml:"permissions,omitempty"`
 

api/v1/zz_generated.deepcopy.go

@@ -90,12 +90,20 @@ func (k *kratosMiddleware) validateSession(ctx context.Context, r *http.Request)
 				return &client.Session{Active: lo.ToPtr(false)}, nil
 			}
 
+			var agent models.Agent
+			if err := ctx.DB().Where("person_id = ?", accessToken.PersonID.String()).Find(&agent).Error; err != nil {
+				return nil, err
+			}
+
 			s := &client.Session{
 				Id:        uuid.NewString(),
 				Active:    lo.ToPtr(true),
 				ExpiresAt: &accessToken.ExpiresAt,
 				Identity: client.Identity{
 					Id: accessToken.PersonID.String(),
+					Traits: map[string]any{
+						"agent": agent,
+					},
 				},
 			}
 
@@ -163,6 +171,10 @@ func (k *kratosMiddleware) Session(next echo.HandlerFunc) echo.HandlerFunc {
 			if e, ok := traits["email"].(string); ok {
 				email = e
 			}
+
+			if agent, ok := traits["agent"].(models.Agent); ok {
+				ctx = ctx.WithAgent(agent)
+			}
 		}
 
 		uid, err := uuid.Parse(session.Identity.GetId())

auth/kratos.go

@@ -1,11 +1,13 @@
 package auth
 
 import (
+	"errors"
 	"net/http"
 
 	"github.com/flanksource/duty/context"
 	"github.com/flanksource/duty/models"
 	"github.com/labstack/echo/v4"
+	"gorm.io/gorm"
 )
 
 // mockAuthMiddleware doesn't actually authenticate since we never store auth data.
@@ -25,6 +27,14 @@ func MockMiddleware(next echo.HandlerFunc) echo.HandlerFunc {
 		}
 
 		ctx = ctx.WithUser(&models.Person{ID: person.ID, Email: person.Email})
+
+		var agent models.Agent
+		if err := ctx.DB().Where("person_id = ?", person.ID.String()).First(&agent).Error; err != nil && !errors.Is(err, gorm.ErrRecordNotFound) {
+			return err
+		} else {
+			ctx = ctx.WithAgent(agent)
+		}
+
 		c.SetRequest(c.Request().WithContext(ctx))
 		return next(c)
 	}

auth/mock.go

@@ -877,6 +877,13 @@ spec:
                       - name
                       - spec
                       type: object
+                    runsOn:
+                      description: RunsOn specifies the agents that can run this action.
+                        When left empty, the action will run on the main instance
+                        itself.
+                      items:
+                        type: string
+                      type: array
                     sql:
                       properties:
                         connection:
@@ -896,6 +903,11 @@ spec:
                       - driver
                       - query
                       type: object
+                    templatesOn:
+                      description: 'TemplatesOn specifies where the templating happens.
+                        Available options: - host - agent When left empty, the templating
+                        is done on the main instance(host) itself.'
+                      type: string
                     timeout:
                       description: Timeout is the maximum duration to let an action
                         run before it's cancelled.
@@ -1302,6 +1314,17 @@ spec:
                       type: string
                   type: object
                 type: array
+              runsOn:
+                description: RunsOn specifies the agents that can run this playbook.
+                  When left empty, the playbook will run on the main instance itself.
+                items:
+                  type: string
+                type: array
+              templatesOn:
+                description: 'TemplatesOn specifies where the templating happens.
+                  Available options: - host - agent When left empty, the templating
+                  is done on the main instance(host) itself.'
+                type: string
             required:
             - actions
             type: object