components

package
v1.10.13 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 7, 2026 License: AGPL-3.0 Imports: 2 Imported by: 0

Documentation

Overview

Package components describes the parts of Miabi that are versioned on their own, so the About page can show how far each has come independently of the Miabi release number.

Index

Constants

View Source
const (
	GitOpsVersion         = "1.0.1"
	PipelineVersion       = "1.0.0"
	MarketplaceVersion    = "1.0.0"
	RegistryVersion       = "1.0.1"
	StorageClassesVersion = "1.0.0"
	AnalyticsVersion      = "1.0.0"
	HealthProbeVersion    = "1.0.0"
)

Component versions, bumped in the PR that changes the component: major when users must act (a migration, a manifest change, a removed option), minor for a feature, patch for a fix. scripts/components/check-component-versions.sh warns when a component's code changes without a bump here. The Web UI ships with Miabi and carries Miabi's own version.

Variables

This section is empty.

Functions

This section is empty.

Types

type Catalog

type Catalog struct {
	Templates   int        `json:"templates"`
	SyncedAt    *time.Time `json:"synced_at,omitempty"`
	GeneratedAt string     `json:"generated_at,omitempty"`
}

Catalog reports the synced marketplace catalog: its template count, when it last synced (zero before the first sync), and when the marketplace generated it (empty when it does not say).

type Component

type Component struct {
	ID        string    `json:"id"`
	Name      string    `json:"name"`
	Version   string    `json:"version"`
	Stability Stability `json:"stability"`
	// FormatVersion is the apiVersion of the files users write for it, when it has any.
	FormatVersion string `json:"format_version,omitempty"`
	Status        Status `json:"status"`
	// Catalog is the synced marketplace catalog, on the Marketplace component only.
	Catalog      *Catalog `json:"catalog,omitempty"`
	ChangelogURL string   `json:"changelog_url"`
}

Component is one independently versioned part of Miabi.

type Probes

type Probes struct {
	RegistryEnabled  func() bool
	AnalyticsEnabled func() bool
	// HealthProbeBundled reports whether this build embeds the probe binaries.
	HealthProbeBundled func() bool
	Catalog            func() Catalog
}

Probes answer the runtime questions a component's status depends on. Any may be nil, which reads as "on" (or no detail), so a partially wired instance still lists every component.

type Service

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

Service lists the components with their live status.

func NewService

func NewService(p Probes) *Service

func (*Service) List

func (s *Service) List() []Component

List returns every component, in display order.

type Stability

type Stability string

Stability labels how settled a component is.

const (
	StabilityPreview Stability = "preview"
	StabilityBeta    Stability = "beta"
	StabilityStable  Stability = "stable"
)

type Status

type Status string

Status is whether a component can be used on this instance.

const (
	StatusOn         Status = "on"
	StatusOff        Status = "off"        // turned off in configuration or settings, or not in this build
	StatusEnterprise Status = "enterprise" // needs an Enterprise license this instance lacks
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL