addon

type AllowGoDefOverride struct{}

type AsyncReader = component.AsyncReader

type Cache struct {
	// contains filtered or unexported fields
}

type Client struct {
	Client  *http.Client
	BaseURL *url.URL
}

type Dependency struct {
	Name    string `json:"name,omitempty"`
	Version string `json:"version,omitempty"`
}

type DeployTo struct {
	// This field keep the compatible for older case
	LegacyRuntimeCluster bool `json:"runtime_cluster,omitempty"`
	DisableControlPlane  bool `json:"disableControlPlane"`
	RuntimeCluster       bool `json:"runtimeCluster"`
}

type ElementFile struct {
	Data string
	Name string
}

type File = component.File

type GitAddonSource = component.GitAddonSource

type GitLabItem struct {
	// contains filtered or unexported fields
}

type GiteeAddonSource = component.GiteeAddonSource

type GitlabAddonSource = component.GitlabAddonSource

type GoDefModule struct {
	// Path is the path to the godef/ directory
	Path string `json:"path"`
	// ModuleYAML is the contents of the module.yaml file
	ModuleYAML string `json:"moduleYAML,omitempty"`
	// GoFiles contains the Go source files
	GoFiles []ElementFile `json:"goFiles,omitempty"`
	// GoMod is the go.mod file content
	GoMod string `json:"goMod,omitempty"`
	// GoSum is the go.sum file content
	GoSum string `json:"goSum,omitempty"`
	// CompiledDefinitions contains the compiled CUE definitions from Go sources
	CompiledDefinitions []ElementFile `json:"compiledDefinitions,omitempty"`
}

type HelmSource = component.HelmSource

type InitCmd struct {
	AddonName        string
	NoSamples        bool
	HelmRepoURL      string
	HelmChartName    string
	HelmChartVersion string
	Path             string
	Overwrite        bool
	RefObjURLs       []string
	// EnableGoDef enables Go-based definition scaffolding in godef/ folder
	EnableGoDef bool
	// GoDefComponents is a comma-separated list of component names to scaffold
	GoDefComponents string
	// GoDefTraits is a comma-separated list of trait names to scaffold
	GoDefTraits string
	// GoDefPolicies is a comma-separated list of policy names to scaffold
	GoDefPolicies string
	// GoDefWorkflowSteps is a comma-separated list of workflow step names to scaffold
	GoDefWorkflowSteps string
	// We use string instead of v1beta1.Application is because
	// the cue formatter is having some problems: it will keep
	// TypeMeta (instead of inlined).
	AppTmpl     string
	Metadata    Meta
	Readme      string
	Resources   []ElementFile
	Schemas     []ElementFile
	Views       []ElementFile
	Definitions []ElementFile
	// GoDefFiles contains Go definition scaffolding files
	GoDefFiles []ElementFile
}

type InstallOption func(installer *Installer)

type InstallPackage struct {
	Meta

	// Definitions and CUEDefinitions are converted as OAM X-Definitions, they will only in control plane cluster
	Definitions    []ElementFile `json:"definitions"`
	CUEDefinitions []ElementFile `json:"CUEDefinitions"`

	// GoDefModule contains Go-based definition module info when godef/ folder exists
	GoDefModule *GoDefModule `json:"goDefModule,omitempty"`

	ConfigTemplates []ElementFile `json:"configTemplates"`

	// YAMLViews and CUEViews are the instances of velaql, they will only in control plane cluster
	YAMLViews []ElementFile `json:"YAMLViews"`
	CUEViews  []ElementFile `json:"CUEViews"`
	// DefSchemas are UI schemas read by VelaUX, it will only be installed in control plane clusters
	DefSchemas []ElementFile `json:"defSchemas,omitempty"`

	Parameters string `json:"parameters"`

	// CUETemplates and YAMLTemplates are resources needed to be installed in managed clusters
	CUETemplates   []ElementFile        `json:"CUETemplates"`
	YAMLTemplates  []ElementFile        `json:"YAMLTemplates,omitempty"`
	AppTemplate    *v1beta1.Application `json:"appTemplate"`
	AppCueTemplate ElementFile          `json:"appCueTemplate,omitempty"`
	Notes          ElementFile          `json:"notes,omitempty"`

	// Imports are the addon's modules/_imports.cue entries: external modules
	// the addon references, each installed as a type: module component in
	// the rendered addon Application. Empty when the addon has no
	// modules/_imports.cue file.
	Imports []ModuleImport `json:"imports,omitempty"`

	// InlineModules are modules developed directly inside the addon's own
	// modules/<name>/ directories and parsed from the addon's own
	// bundled files -- no registry, no fetch.
	// Empty when the addon has no inline modules.
	InlineModules []*module.Module `json:"inlineModules,omitempty"`
}

type Installer struct {
	// contains filtered or unexported fields
}

type Item = component.Item

type ItemInfo struct {
	Name              string
	Description       string
	AvailableVersions []string
}

type ItemInfoLister interface {
	ListAddonInfo() (map[string]ItemInfo, error)
}

type ListBucketResult = component.ListBucketResult

type ListOptions struct {
	GetDetail         bool
	GetDefinition     bool
	GetConfigTemplate bool
	GetResource       bool
	GetParameter      bool
	GetTemplate       bool
	GetDefSchema      bool
}

type MemoryReader = component.MemoryReader

type Meta struct {
	Name        string   `json:"name" validate:"required"`
	Version     string   `json:"version"`
	Description string   `json:"description"`
	Icon        string   `json:"icon"`
	URL         string   `json:"url,omitempty"`
	Tags        []string `json:"tags,omitempty"`
	// UXPlugins used for velaux plugins download/install with the use of addon registry.
	UXPlugins          map[string]string   `json:"uxPlugins,omitempty"`
	DeployTo           *DeployTo           `json:"deployTo,omitempty"`
	Dependencies       []*Dependency       `json:"dependencies,omitempty"`
	NeedNamespace      []string            `json:"needNamespace,omitempty"`
	Invisible          bool                `json:"invisible"`
	SystemRequirements *SystemRequirements `json:"system,omitempty"`
	// Annotations used for addon maintainers to add their own description or extensions to metadata.
	Annotations map[string]string `json:"annotations,omitempty"`
}

type ModuleImport struct {
	// Module is the module name; also the emitted component's name.
	Module string
	// Enabled gates whether this import is installed. Absent in the source
	// file defaults to true.
	Enabled bool
	// Registry is the named module registry to resolve Module from; empty
	// means search every configured registry.
	Registry string
	// Version is the exact module package version to install; empty means
	// latest. addon:build/addon:publish already reject a semver range here,
	// so this value is trusted as an exact pin by the time it reaches render time.
	Version string
}

type OCIAddonCatalog struct {
	APIVersion string                 `json:"apiVersion"`
	Addons     []OCIAddonCatalogEntry `json:"addons"`
}

type OCIAddonCatalogEntry struct {
	Name        string   `json:"name"`
	Description string   `json:"description,omitempty"`
	Versions    []string `json:"versions"`
}

type OSSAddonSource = component.OSSAddonSource

type OSSItem = component.OSSItem

type Pattern struct {
	IsDir bool
	Value string
}

type PushCmd struct {
	ChartName          string
	AppVersion         string
	ChartVersion       string
	RepoName           string
	Username           string
	Password           string
	PasswordStdin      bool
	AccessToken        string
	AuthHeader         string
	ContextPath        string
	ForceUpload        bool
	UseHTTP            bool
	CaFile             string
	CertFile           string
	KeyFile            string
	InsecureSkipVerify bool
	Out                io.Writer
	Timeout            int64
	KeepChartMetadata  bool
	// We need it to search in addon registries.
	// If you use URL, instead of registry names, then it is not needed.
	Client client.Client
	// contains filtered or unexported fields
}

type ReaderOption = component.ReaderOption

type ReaderType = component.ReaderType

type Registry = component.Registry

type RegistryDataStore = component.RegistryDataStore

type SafeCopier = component.SafeCopier

type SourceMeta = component.SourceMeta

type Status struct {
	AddonPhase string
	AppStatus  *commontypes.AppStatus
	// the status of multiple clusters
	Clusters         map[string]map[string]interface{} `json:"clusters,omitempty"`
	InstalledVersion string
	Parameters       map[string]interface{}
	// Where the addon is from. Can be empty if not installed.
	InstalledRegistry string
}

type SystemRequirements struct {
	VelaVersion       string `json:"vela,omitempty"`
	KubernetesVersion string `json:"kubernetes,omitempty"`
}

type TokenSource = component.TokenSource

type UIData struct {
	Meta

	APISchema *openapi3.Schema      `json:"schema"`
	UISchema  []*schema.UIParameter `json:"uiSchema"`
	// DefaultUISchema is the form generated from the addon's parameter, or
	// nil where it could not be generated.
	DefaultUISchema []*schema.UIParameter `json:"defaultUISchema,omitempty"`

	// Detail is README.md in an addon
	Detail string `json:"detail,omitempty"`

	Definitions      []ElementFile `json:"definitions"`
	CUEDefinitions   []ElementFile `json:"CUEDefinitions"`
	ConfigTemplates  []ElementFile `json:"configTemplates"`
	Parameters       string        `json:"parameters"`
	GlobalParameters string        `json:"globalParameters"`
	RegistryName     string        `json:"registryName"`

	AvailableVersions []string `json:"availableVersions"`
}

type VersionUnMatchError struct {
	// contains filtered or unexported fields
}

type VersionedRegistry interface {
	ListAddon() ([]*UIData, error)
	GetAddonUIData(ctx context.Context, addonName, version string) (*UIData, error)
	GetAddonInstallPackage(ctx context.Context, addonName, version string) (*InstallPackage, error)
	GetDetailedAddon(ctx context.Context, addonName, version string) (*WholeAddonPackage, error)
	// GetAddonAvailableVersion returns the addon's versions, newest first.
	GetAddonAvailableVersion(addonName string) ([]*repo.ChartVersion, error)
}

type WholeAddonPackage struct {
	InstallPackage

	APISchema *openapi3.Schema `json:"schema"`
	// DefaultUISchema is the form generated from the addon's parameter, or
	// nil where it could not be generated.
	DefaultUISchema []*schema.UIParameter `json:"defaultUISchema,omitempty"`

	// Detail is README.md in an addon
	Detail            string   `json:"detail,omitempty"`
	AvailableVersions []string `json:"availableVersions"`
	RegistryName      string   `json:"registryName"`
}