parser

package
Version: v1.2.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 31, 2020 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source
const (
	Name              = "Name"
	Ports             = "Ports"
	Memory            = "Memory"
	PortsDescription  = "Ports to be opened in all component containers"
	MemoryDescription = "The Maximum memory all the component containers can consume"
	NameDescription   = "The name of the component"
)
View Source
const (
	OutputDevfileJsonPath = "devfile.json"
	OutputDevfileYamlPath = "devfile.yaml"
)

Default filenames for create devfile

Variables

This section is empty.

Functions

func AsDevfileSupportedParameter added in v1.2.6

func AsDevfileSupportedParameter(param string) (string, bool)

AsDevfileSupportedParameter returns the parameter in lower case and a boolean indicating if it is a supported parameter

func FormatDevfileSupportedParameters added in v1.2.6

func FormatDevfileSupportedParameters() (result string)

FormatDevfileSupportedParameters outputs supported parameters and their description

func GetDevfileSupportedParameters added in v1.2.6

func GetDevfileSupportedParameters() []string

GetDevfileSupportedParameters returns the name of the supported global parameters

Types

type ConfigurableRepr added in v1.2.6

type ConfigurableRepr struct {
	Name    string          `yaml:"ComponentName,omitempty" json:"ComponentName,omitempty"`
	Memory  string          `yaml:"Memory,omitempty" json:"Memory,omitempty"`
	Configs []ContainerRepr `yaml:"Configs,omitempty" json:"Configs,omitempty"`
}

type ContainerRepr added in v1.2.6

type ContainerRepr struct {
	ContainerName        string            `yaml:"ContainerName" json:"ContainerName"`
	EnvironmentVariables config.EnvVarList `yaml:"EnvironmentVariables" json:"EnvironmentVariables,omitempty"`
	Ports                []PortRepr        `yaml:"Ports" json:"Ports,omitempty"`
}

type DevfileObj added in v1.1.2

type DevfileObj struct {

	// Ctx has devfile context info
	Ctx devfileCtx.DevfileCtx

	// Data has the devfile data
	Data data.DevfileData
}

DevfileObj is the runtime devfile object

func Parse added in v1.1.2

func Parse(path string) (d DevfileObj, err error)

Parse func populates the devfile data, parses and validates the devfile integrity. Creates devfile context and runtime objects

func ParseFromURL added in v1.2.5

func ParseFromURL(url string) (d DevfileObj, err error)

ParseFromURL func parses and validates the devfile integrity. Creates devfile context and runtime objects

func (DevfileObj) AddEnvVars added in v1.2.6

func (d DevfileObj) AddEnvVars(otherList config.EnvVarList) error

AddEnvVars adds environment variables to all the components in a devfile

func (DevfileObj) DeleteConfiguration added in v1.2.6

func (d DevfileObj) DeleteConfiguration(parameter string) error

DeleteConfiguration allows deleting the parameters that are configurable in a devfile

func (DevfileObj) IsSet added in v1.2.6

func (d DevfileObj) IsSet(parameter string) bool

IsSet checks if a parameter is set in the devfile

func (DevfileObj) OverrideCommands added in v1.2.5

func (d DevfileObj) OverrideCommands(overridePatch []common.DevfileCommand) error

OverrideCommands overrides the commands of the parent devfile overridePatch contains the patches to be applied to the parent's commands

func (DevfileObj) OverrideComponents added in v1.2.5

func (d DevfileObj) OverrideComponents(overridePatch []common.DevfileComponent) error

OverrideComponents overrides the components of the parent devfile overridePatch contains the patches to be applied to the parent's components

func (DevfileObj) OverrideEvents added in v1.2.5

func (d DevfileObj) OverrideEvents(overridePatch common.DevfileEvents) error

OverrideEvents overrides the events of the parent devfile overridePatch contains the patches to be applied to the parent's events

func (DevfileObj) OverrideProjects added in v1.2.5

func (d DevfileObj) OverrideProjects(overridePatch []common.DevfileProject) error

OverrideProjects overrides the projects of the parent devfile overridePatch contains the patches to be applied to the parent's projects

func (DevfileObj) OverrideStarterProjects added in v1.2.6

func (d DevfileObj) OverrideStarterProjects(overridePatch []common.DevfileStarterProject) error

OverrideStarterProjects overrides the starter projects of the parent devfile overridePatch contains the patches to be applied to the parent's starter projects

func (DevfileObj) RemoveEnvVars added in v1.2.6

func (d DevfileObj) RemoveEnvVars(keys []string) error

RemoveEnvVars removes the environment variables which have the keys from all the components in a devfile

func (DevfileObj) SetConfiguration added in v1.2.6

func (d DevfileObj) SetConfiguration(parameter string, value interface{}) error

SetConfiguration allows setting all the parameters that are configurable in a devfile

func (DevfileObj) ToRepresentation added in v1.2.6

func (d DevfileObj) ToRepresentation() ConfigurableRepr

func (DevfileObj) WrapFromJSONOutput added in v1.2.6

func (d DevfileObj) WrapFromJSONOutput(confRepr ConfigurableRepr) JSONConfigRepr

func (*DevfileObj) WriteJsonDevfile added in v1.1.2

func (d *DevfileObj) WriteJsonDevfile() error

WriteJsonDevfile creates a devfile.json file

func (*DevfileObj) WriteYamlDevfile added in v1.1.2

func (d *DevfileObj) WriteYamlDevfile() error

WriteYamlDevfile creates a devfile.yaml file

type JSONConfigRepr added in v1.2.6

type JSONConfigRepr struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	DevfileConfigSpec ConfigurableRepr `json:"spec" yaml:"spec"`
}

type PortRepr added in v1.2.6

type PortRepr struct {
	Name        string `yaml:"Name" json:"Name"`
	ExposedPort int32  `yaml:"ExposedPort" json:"ExposedPort"`
	Protocol    string `yaml:"Protocol" json:"Protocol"`
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL