succubus

Documentation

Index

• type CMD
• type Commands
• type Container
• type Docker
• type DockerCompose
• type Dockerfile
• type Engine
• type Env
  • func CreateEnv(origin string) (env Env, fail error)
• type HyperV
• type Image
• type LXC
• type Network
• type Objective
• type Objectives
• type Project
  • func LexProject(projectPath string) (project Project, fail error)
  • func Load(projectPath string) (project Project, fail error)
  • func ParseProject(origin Project) (project Project, fail error)
  • func SemanticAnalysis(origin Project) (project Project, fail error)
• type RKT
• type Services
• type System
• type Systems
• type Task
• type Usage
• type Volumes
• type WindowsContainers

Types

type CMD

type CMD struct {
	Name     string
	Usage    Usage
	Params   []string // Just the parameters name
	Function func(...interface{})
}

Stores the given command

type Commands

type Commands struct {
	// contains filtered or unexported fields
}

type Container

type Container struct {
	// contains filtered or unexported fields
}

type Docker

type Docker struct {
	// contains filtered or unexported fields
}

type DockerCompose

type DockerCompose struct {
	// contains filtered or unexported fields
}

type Dockerfile

type Dockerfile struct {
	// contains filtered or unexported fields
}

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

type Env

type Env struct {
	// contains filtered or unexported fields
}

func CreateEnv

func CreateEnv(origin string) (env Env, fail error)

CreateEnv Goes trough the process of checking whether or not a environment variable is properly declared -- even tho doesn't check whether or not is "valid" in a way to check whether the source value exists or the destiny value is required or not. It returns a Environment Variable object and whether or not some error occurred

type HyperV

type HyperV struct {
}

type Image

type Image struct {
	// contains filtered or unexported fields
}

type LXC

type LXC struct {
}

type Network

type Network struct {
}

type Objective

type Objective struct {
	// contains filtered or unexported fields
}

type Objectives

type Objectives struct {
	// contains filtered or unexported fields
}

type Project

type Project struct {
	// contains filtered or unexported fields
}

func LexProject

func LexProject(projectPath string) (project Project, fail error)

LexProject just reads the given Succubus config file and checks it whether or not it's a valid one. It returns whether or not the config file is valid and any error encountered.

func Load

func Load(projectPath string) (project Project, fail error)

Load checks for: 1. whether or not the project is has ambient issues 2. whether or not the project is has declaration issues 3. whether or not the project is has Project pattern issues It returns whether or not the Project is ok

func ParseProject

func ParseProject(origin Project) (project Project, fail error)

ParseProject goes trough the "logic" behind a Succubus' configuration file. It's important tho to point out that this or any other function presented in this package checks whether or not the given command is "plausible" just if all the key have a string as a value; if a image tag points to a non-existing image or if a command is wrongfull typed or even not exists, this function doesn't perform this kind of pre-processing due to the runtime nature of those tasks. It returns the processed config file

func SemanticAnalysis

func SemanticAnalysis(origin Project) (project Project, fail error)

SemanticAnalysis goes trough a Project definition and checks for:

1. commands/variables ambiguity
2. whether or not the current Project is from a different pattern from the one defined as the one to be followed

It returns the sanitized version of the Project or the error related to it

type RKT

type RKT struct {
}

type Services

type Services struct {
}

type System

type System struct {
	Objectives []string
	// contains filtered or unexported fields
}

type Systems

type Systems struct {
	// contains filtered or unexported fields
}

type Task

type Task struct {
	// contains filtered or unexported fields
}

type Usage

type Usage struct {
	Short string
	Long  string
}

Stores the description related to given command

type Volumes

type Volumes struct {
}

type WindowsContainers

type WindowsContainers struct {
}