Documentation
¶
Index ¶
Constants ¶
View Source
const ( // DefinitionFile is the filename for package metadata DefinitionFile = "package.yaml" TypeModule = "Module" TypeApplication = "Application" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApplicationDefinition ¶ added in v1.76.0
type ApplicationDefinition struct {
TypeMeta `yaml:",inline"`
Definition `yaml:",inline"`
}
ApplicationDefinition extends Definition for application packages.
func (*ApplicationDefinition) Convert ¶ added in v1.76.0
func (d *ApplicationDefinition) Convert() (apps.Definition, error)
Convert converts application definition to application domain model
type Definition ¶
type Definition struct {
Name string `yaml:"name" json:"name"`
Version string `yaml:"version" json:"version"`
Stage string `yaml:"stage" json:"stage"`
Descriptions Descriptions `yaml:"descriptions,omitempty" json:"descriptions,omitempty"`
Requirements Requirements `yaml:"requirements,omitempty" json:"requirements,omitempty"`
DisableOptions DisableOptions `yaml:"disable,omitempty" json:"disable,omitempty"`
}
Definition represents common package metadata loaded from package.yaml.
type Descriptions ¶
type Descriptions struct {
Ru string `json:"ru,omitempty" yaml:"ru,omitempty"`
En string `json:"en,omitempty" yaml:"en,omitempty"`
}
Descriptions holds localized description text for the package.
type DisableOptions ¶
type DisableOptions struct {
Confirmation bool `json:"confirmation" yaml:"confirmation"` // Whether confirmation is required to disable
Message string `json:"message" yaml:"message"` // Message to display when disabling
}
DisableOptions configures package disablement behavior.
type ModuleDefinition ¶ added in v1.76.0
type ModuleDefinition struct {
TypeMeta `yaml:",inline"`
Definition `yaml:",inline"`
Weight int `yaml:"weight" json:"weight"`
Critical bool `yaml:"critical,omitempty" json:"critical,omitempty"`
}
ModuleDefinition extends Definition with module-specific fields.
func (*ModuleDefinition) Convert ¶ added in v1.76.0
func (d *ModuleDefinition) Convert() (modules.Definition, error)
Convert converts module definition to module domain model
type Requirements ¶
type Requirements struct {
Kubernetes string `yaml:"kubernetes,omitempty" json:"kubernetes,omitempty"`
Deckhouse string `yaml:"deckhouse,omitempty" json:"deckhouse,omitempty"`
Modules map[string]string `yaml:"modules,omitempty" json:"modules,omitempty"`
}
Requirements specifies dependencies required by this package.
Click to show internal directories.
Click to hide internal directories.