plan

Documentation

Index

• type Conf
• type File
• type Plan
  • func (p *Plan) String() string
• type PlanList
• type SharedFile
• type WorkflowStep

Types

type Conf

type Conf struct {
	CommandArgs string `json:"commandArgs,omitempty" description:"passed to command line for plugins with type:util"`
	Target      string `json:"target,omitempty" description:"used in script, taken from scan conf directly"`
	FormData    string `json:"formData,omitempty" description:"data from form is saved as json string here"`

	// this fields helps to communicate with container through files
	TakeFiles   []*File       `json:"takeFiles,omitempty" description:"copy this files from container when it's done"`
	SharedFiles []*SharedFile `json:"sharedFiles,omitempty" description:"share file to container"`
}

type File

type File struct {
	Path string `json:"path" description:"absolute path to file in container"`
	Name string `json:"name" description:"rename file to name or use path if empty"`
}

type Plan

type Plan struct {
	Id         bson.ObjectId     `json:"id,omitempty" bson:"_id,omitempty"`
	Name       string            `json:"name"`
	Desc       string            `json:"desc"` // human readable description
	Workflow   []*WorkflowStep   `json:"workflow"`
	Created    time.Time         `json:"created,omitempty" description:"when plan is created"`
	Updated    time.Time         `json:"updated,omitempty" description:"when plan is updated"`
	TargetType target.TargetType `json:"targetType" bson:"targetType" description:"what target type is supported"`
}

func (*Plan) String

func (p *Plan) String() string

type PlanList

type PlanList struct {
	pagination.Meta `json:",inline"`
	Results         []*Plan `json:"results"`
}

type SharedFile

type SharedFile struct {
	Path string `json:"path" description:"path is relative to /share/"`
	Text string `json:"text" description:"text is a content of text file"`
}

type WorkflowStep

type WorkflowStep struct {
	Plugin string `json:"plugin" description:"plugin name"`
	Name   string `json:"name" description:"step name"`
	Desc   string `json:"desc,omitempty" description:"step description"`
	Conf   *Conf  `json:"conf,omitempty"`
}