def

Documentation

Index

• func ImportLessonDefs(syringeConfig *config.SyringeConfig, fileList []string) (map[int32]*LessonDefinition, error)
• type Connection
• type Endpoint
• type IframeResource
• type LessonDefinition
  • func (ld *LessonDefinition) HasDevices() bool
  • func (ld *LessonDefinition) JSON() string
• type LessonStage

Functions

func ImportLessonDefs

func ImportLessonDefs(syringeConfig *config.SyringeConfig, fileList []string) (map[int32]*LessonDefinition, error)

Types

type Connection

type Connection struct {
	A      string `json:"a" yaml:"a"`
	B      string `json:"b" yaml:"b"`
	Subnet string `json:"subnet" yaml:"subnet"`
}

type Endpoint

type Endpoint struct {
	Name        string  `json:"name" yaml:"name"`
	Image       string  `json:"image" yaml:"image"`
	Sshuser     string  `json:"sshuser" yaml:"sshuser"`
	Sshpassword string  `json:"sshpassword" yaml:"sshpassword"`
	Ports       []int32 `json:"ports" yaml:"ports"`
}

type IframeResource

type IframeResource struct {
	Name     string `json:"name" yaml:"name"`
	Image    string `json:"image" yaml:"image"`
	Protocol string `json:"protocol" yaml:"protocol"`
	URI      string `json:"uri" yaml:"uri"`
	Port     int32  `json:"port" yaml:"port"`
}

type LessonDefinition

type LessonDefinition struct {
	LessonName      string                 `json:"lessonName" yaml:"lessonName"`
	LessonID        int32                  `json:"lessonID" yaml:"lessonID"`
	IframeResources []*IframeResource      `json:"iframeresources" yaml:"iframeresources"`
	Devices         []*Endpoint            `json:"devices" yaml:"devices"`
	Utilities       []*Endpoint            `json:"utilities" yaml:"utilities"`
	Blackboxes      []*Endpoint            `json:"blackboxes" yaml:"blackboxes"`
	Connections     []*Connection          `json:"connections" yaml:"connections"`
	Stages          map[int32]*LessonStage `json:"stages" yaml:"stages"`
	Category        string                 `json:"category" yaml:"category"`
	LessonDiagram   string                 `json:"lessondiagram" yaml:"lessondiagram"`
	LessonVideo     string                 `json:"lessonvideo" yaml:"lessonvideo"`
	Tier            string                 `json:"tier" yaml:"tier"`
}

func (*LessonDefinition) HasDevices

func (ld *LessonDefinition) HasDevices() bool

func (*LessonDefinition) JSON

func (ld *LessonDefinition) JSON() string

JSON exports the lesson definition as JSON

type LessonStage

type LessonStage struct {
	LabGuide    string `json:"labguide" yaml:"labguide"`
	Description string `json:"description" yaml:"description"`
}