Documentation
¶
Index ¶
Constants ¶
View Source
const (
// DefinitionFile is the filename for package metadata
DefinitionFile = "package.yaml"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Definition ¶
type Definition struct {
Name string `yaml:"name" json:"name"`
Type string `yaml:"type" json:"type"`
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"`
Module DefinitionModule `yaml:"module,omitempty" json:"module,omitempty"`
}
Definition represents package metadata loaded from package.yaml. It contains package identification, descriptions, requirements, and configuration options.
func (*Definition) ToApplication ¶
func (d *Definition) ToApplication() (apps.Definition, error)
ToApplication converts package definition to application definition
func (*Definition) ToModule ¶ added in v1.75.0
func (d *Definition) ToModule() (modules.Definition, error)
ToModule converts package definition to module definition
type DefinitionModule ¶ added in v1.75.0
type DefinitionModule struct {
Weight int `yaml:"weight" json:"weight"`
Critical bool `yaml:"critical,omitempty" json:"critical,omitempty"`
}
DefinitionModule specifies module specific fields
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 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.
Source Files
Click to show internal directories.
Click to hide internal directories.