capabilitycontract

package
v0.1.0-alpha.3 Latest Latest
Warning

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

Go to latest
Published: Sep 10, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package capabilitycontract defines provider-neutral capability vocabulary shared by Molejo binaries. It contains no persistence or provider behavior.

Index

Constants

View Source
const (
	ReasonAccessDenied             = "access_denied"
	ReasonAPIMissing               = "api_missing"
	ReasonNoResource               = "no_resource"
	ReasonReadabilityNotVerified   = "readability_not_verified"
	ReasonProbeFailed              = "probe_failed"
	ReasonClusterNotAttached       = "cluster_not_attached"
	ReasonClusterAgentOffline      = "cluster_agent_offline"
	ReasonClusterObservationStale  = "cluster_observation_stale"
	ReasonCapabilityIncompatible   = "cluster_capability_incompatible"
	ReasonProviderNotConfigured    = "provider_not_configured"
	ReasonProviderHealthUnknown    = "provider_health_unknown"
	ReasonProviderUnreachable      = "provider_unreachable"
	ReasonBindingDegraded          = "binding_degraded"
	ReasonHistoricalBackendMissing = "historical_backend_missing"
	ReasonSecretBackendMissing     = "secret_backend_missing"
	ReasonRuntimeQueryUnsupported  = "runtime_query_unsupported"
	ReasonRuntimeNotDeployed       = "runtime_not_deployed"
)
View Source
const (
	MaxObservations         = 64
	MaxFieldLength          = 128
	MaxMessageLength        = 256
	MaxLimitations          = 16
	MaxLimitationLength     = 128
	MaxObservationClockSkew = 10 * time.Minute
)
View Source
const ContractVersion = "v1alpha1"

Variables

View Source
var ErrInvalidObservation = errors.New("invalid capability observation")

Functions

func Known

func Known(id ID) bool

func ValidateObservation

func ValidateObservation(value Observation, now time.Time) error

Types

type Health

type Health string
const (
	HealthHealthy     Health = "Healthy"
	HealthDegraded    Health = "Degraded"
	HealthUnavailable Health = "Unavailable"
	HealthUnknown     Health = "Unknown"
)

type ID

type ID string
const (
	RuntimeWorkloadApply        ID = "runtime.workload.apply"
	RuntimeWorkloadObserve      ID = "runtime.workload.observe"
	RuntimeLogsCurrent          ID = "runtime.logs.current"
	RuntimeMetricsCurrent       ID = "runtime.metrics.current"
	RuntimeEventsCurrent        ID = "runtime.events.current"
	TelemetryLogsHistorical     ID = "telemetry.logs.historical"
	TelemetryMetricsHistorical  ID = "telemetry.metrics.historical"
	TelemetryEventsHistorical   ID = "telemetry.events.historical"
	ParametersPlain             ID = "parameters.plain"
	ParametersSecretStatic      ID = "parameters.secret.static"
	PublicationHTTP             ID = "publication.http"
	PublicationTCP              ID = "publication.tcp"
	StorageRWO                  ID = "storage.rwo"
	StorageExpand               ID = "storage.expand"
	SourceGitHub                ID = "source.github"
	BuildManaged                ID = "build.managed"
	ReleaseExternal             ID = "release.external"
	ReleaseHistory              ID = "release.history"
	ControlPlaneOperationEvents ID = "events.control-plane"
	WorkspaceProvisioning       ID = "workspace.provisioning.namespaced"
)

type Observation

type Observation struct {
	ID              ID
	ContractVersion string
	Support         Support
	Health          Health
	ProviderKind    string
	ReasonCode      string
	Message         string
	Limitations     []string
	SampledAt       time.Time
	ReceivedAt      time.Time
	ExpiresAt       time.Time
}

type Support

type Support string
const (
	SupportSupported   Support = "Supported"
	SupportUnsupported Support = "Unsupported"
	SupportUnknown     Support = "Unknown"
)

Jump to

Keyboard shortcuts

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