package
1.2.6
Repository: https://github.com/redhat-developer/ocdev.git
Documentation: pkg.go.dev

# Functions

AsLocallySupportedParameter returns the parameter in lower case and a boolean indicating if it is a supported parameter.
FormatLocallySupportedParameters outputs supported parameters and their description.
GetLocallySupportedParameters returns the name of the supported global parameters.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetSrcType returns enum equivalent of passed component source type or error if unsupported type passed.
New returns the localConfigInfo.
NewEnvVarFromString takes a string of format "name=value" and returns an Env variable struct.
NewEnvVarListFromDevfileEnv creates an EnvVarList from the list of envs present in a devfile.
NewEnvVarListFromSlice takes multiple env variables with format "name=value" and returns an EnvVarList.
NewLocalConfig creates an empty LocalConfig struct with typeMeta populated.
NewLocalConfigInfo gets the LocalConfigInfo from local config file and creates the local config file in case it's not present then it.
RemoveEnvVarsFromList removes the env variables based on the keys provided and returns a new EnvVarList.

# Constants

Application indicates application of which component is part of.
ApplicationDescription is the description of app component setting.
BINARY Local Binary as source of component.
CPU is the name of the setting controlling the cpu a component consumes.
CPUDescription is the description of the setting controlling the min and max CPU to same value.
DebugPort is the port where the application is set to listen for debugger.
DebugPortDescription is the description for debug port.
DefaultDebugPort is the default port used for debugging on remote pod.
GIT as source of component.
Ignore is the name of the setting controlling the min memory a component consumes.
IgnoreDescription is the description of the setting controlling the use of .odoignore file.
LOCAL Local source path as source of component.
MaxCPU is the name of the setting controlling the use of .odoignore file.
MaxCPUDescription is the description of the setting controlling the max CPU value.
MaxMemory is the name of the setting controlling the min memory a component consumes.
MaxMemoryDescription is the description of the setting controlling the maximum memory.
Memory is the name of the setting controlling the memory a component consumes.
MemoryDescription is the description of the setting controlling the min and max memory to same value.
MinCPU is the name of the setting controlling minimum cpu.
MinCPUDescription is the description of the setting controlling the min CPU value.
MinMemory is the name of the setting controlling the min memory a component consumes.
MinMemoryDescription is the description of the setting controlling the minimum memory.
Name is the name of the setting controlling the component name.
NameDescription is human-readable description of the Name setting.
NONE indicates there's no information about the type of source of the component.
Ports is the space separated list of user specified ports to be opened in the component.
PortsDescription is the desctription of the ports component setting.
Project indicates project the component is part of.
ProjectDescription is the description of project component setting.
Ref indicates git ref for the component source.
RefDescription is the description of ref setting.
SourceLocation indicates path of the source e.g.
SourceLocationDescription is the human-readable description of path setting.
SourceType indicates type of component source -- git/binary/local.
SourceTypeDescription is the description of type setting.
Storage is the name of the setting controlling storage.
StorageDescription is the description of the storage.
Type is the name of the setting controlling the component type i.e.
TypeDescription is human-readable description of the Type setting.
URL.
URLDescription is the description of URL.

# Structs

ComponentSettings holds all component related information.
No description provided by the author
ConfigURL holds URL related information.
EnvVar represents an enviroment variable.
LocalConfig holds all the config relavent to a specific Component.
LocalConfigInfo wraps the local config and provides helpers to serialize it.

# Type aliases

EnvVarList represents a list of environment variables.
SrcType is an enum to indicate the type of source of component -- local source/binary or git for the generation of app/component names.