parser

Documentation

Index

• Constants
• func AsDevfileSupportedParameter(param string) (string, bool)
• func FormatDevfileSupportedParameters() (result string)
• func GetDevfileSupportedParameters() []string
• type ConfigurableRepr
• type ContainerRepr
• type DevfileObj
  • func Parse(path string) (d DevfileObj, err error)
  • func ParseFromURL(url string) (d DevfileObj, err error)
  • func (d DevfileObj) AddEnvVars(otherList config.EnvVarList) error
  • func (d DevfileObj) DeleteConfiguration(parameter string) error
  • func (d DevfileObj) IsSet(parameter string) bool
  • func (d DevfileObj) OverrideCommands(overridePatch []common.DevfileCommand) error
  • func (d DevfileObj) OverrideComponents(overridePatch []common.DevfileComponent) error
  • func (d DevfileObj) OverrideEvents(overridePatch common.DevfileEvents) error
  • func (d DevfileObj) OverrideProjects(overridePatch []common.DevfileProject) error
  • func (d DevfileObj) OverrideStarterProjects(overridePatch []common.DevfileStarterProject) error
  • func (d DevfileObj) RemoveEnvVars(keys []string) error
  • func (d DevfileObj) SetConfiguration(parameter string, value interface{}) error
  • func (d DevfileObj) ToRepresentation() ConfigurableRepr
  • func (d DevfileObj) WrapFromJSONOutput(confRepr ConfigurableRepr) JSONConfigRepr
  • func (d *DevfileObj) WriteJsonDevfile() error
  • func (d *DevfileObj) WriteYamlDevfile() error
• type JSONConfigRepr
• type PortRepr

Constants

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"
)

const (
	OutputDevfileJsonPath = "devfile.json"
	OutputDevfileYamlPath = "devfile.yaml"
)

Default filenames for create devfile

Functions

func AsDevfileSupportedParameter

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

func FormatDevfileSupportedParameters() (result string)

FormatDevfileSupportedParameters outputs supported parameters and their description

func GetDevfileSupportedParameters

func GetDevfileSupportedParameters() []string

GetDevfileSupportedParameters returns the name of the supported global parameters

Types

type ConfigurableRepr

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

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

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

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

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

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

AddEnvVars adds environment variables to all the components in a devfile

func (DevfileObj) DeleteConfiguration

func (d DevfileObj) DeleteConfiguration(parameter string) error

DeleteConfiguration allows deleting the parameters that are configurable in a devfile

func (DevfileObj) IsSet

func (d DevfileObj) IsSet(parameter string) bool

IsSet checks if a parameter is set in the devfile

func (DevfileObj) OverrideCommands

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

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

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

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

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

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

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

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

func (DevfileObj) ToRepresentation

func (d DevfileObj) ToRepresentation() ConfigurableRepr

func (DevfileObj) WrapFromJSONOutput

func (d DevfileObj) WrapFromJSONOutput(confRepr ConfigurableRepr) JSONConfigRepr

func (*DevfileObj) WriteJsonDevfile

func (d *DevfileObj) WriteJsonDevfile() error

WriteJsonDevfile creates a devfile.json file

func (*DevfileObj) WriteYamlDevfile

func (d *DevfileObj) WriteYamlDevfile() error

WriteYamlDevfile creates a devfile.yaml file

type JSONConfigRepr

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

type PortRepr

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