checkpoint

package
v0.5.0 Latest Latest
Warning

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

Go to latest
Published: Aug 27, 2026 License: GPL-3.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source
const (
	WorkspaceSchemaVersion   = "notarius.workspace.v4"
	WorkspaceSchemaVersionV3 = "notarius.workspace.v3"
	WorkspaceSchemaVersionV2 = "notarius.workspace.v2"
	WorkspaceSchemaVersionV1 = "notarius.workspace.v1"
)

Variables

This section is empty.

Functions

func NewFilesystemLoader

func NewFilesystemLoader(root string, identity Identity) (pipeline.CheckpointLoader, error)

func NewFilesystemRecorder

func NewFilesystemRecorder(root string, identity Identity) (pipeline.CheckpointRecorder, error)

Types

type ExtractLaneManifest

type ExtractLaneManifest struct {
	StageManifest
	ChunkCount  int `json:"chunk_count,omitempty"`
	OutputCount int `json:"output_count,omitempty"`
}

type FilesystemLoader

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

func (*FilesystemLoader) AcceptedNormalize

func (l *FilesystemLoader) AcceptedNormalize(stepID, laneID, moduleKey string) (pipeline.NormalizeCheckpoint, pipeline.CheckpointDecision)

func (*FilesystemLoader) Enabled

func (l *FilesystemLoader) Enabled() bool

func (*FilesystemLoader) Extract

func (*FilesystemLoader) ExtractForStep

func (l *FilesystemLoader) ExtractForStep(stepID, laneID, moduleKey string, dependencies []pipeline.CheckpointFingerprint) (pipeline.ExtractCheckpoint, pipeline.CheckpointDecision)

func (*FilesystemLoader) Merge

func (*FilesystemLoader) MergeForStep

func (l *FilesystemLoader) MergeForStep(stepID, laneID, moduleKey string, dependencies []pipeline.CheckpointFingerprint) (pipeline.MergeCheckpoint, pipeline.CheckpointDecision)

func (*FilesystemLoader) Normalize

func (*FilesystemLoader) NormalizeForStep

func (l *FilesystemLoader) NormalizeForStep(stepID, laneID, moduleKey string, dependencies []pipeline.CheckpointFingerprint) (pipeline.NormalizeCheckpoint, pipeline.CheckpointDecision)

func (*FilesystemLoader) Source

type FilesystemRecorder

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

func (*FilesystemRecorder) ExtractFailed

func (r *FilesystemRecorder) ExtractFailed(laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint, err error) error

func (*FilesystemRecorder) ExtractFailedForStep

func (r *FilesystemRecorder) ExtractFailedForStep(stepID, laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint, err error) error

func (*FilesystemRecorder) ExtractRunning

func (r *FilesystemRecorder) ExtractRunning(laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint) error

func (*FilesystemRecorder) ExtractRunningForStep

func (r *FilesystemRecorder) ExtractRunningForStep(stepID, laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint) error

func (*FilesystemRecorder) ExtractSucceeded

func (r *FilesystemRecorder) ExtractSucceeded(laneID, moduleKey string, dependencies []pipeline.CheckpointFingerprint, outputs []pipeline.CheckpointArtifact, rejected []contracts.RejectedOutput) error

func (*FilesystemRecorder) ExtractSucceededForStep

func (r *FilesystemRecorder) ExtractSucceededForStep(stepID, laneID, moduleKey string, dependencies []pipeline.CheckpointFingerprint, outputs []pipeline.CheckpointArtifact, rejected []contracts.RejectedOutput) error

func (*FilesystemRecorder) MergeFailed

func (r *FilesystemRecorder) MergeFailed(laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint, err error) error

func (*FilesystemRecorder) MergeFailedForStep

func (r *FilesystemRecorder) MergeFailedForStep(stepID, laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint, err error) error

func (*FilesystemRecorder) MergeRejected

func (r *FilesystemRecorder) MergeRejected(laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint, rejected contracts.RejectedOutput) error

func (*FilesystemRecorder) MergeRejectedForStep

func (r *FilesystemRecorder) MergeRejectedForStep(stepID, laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint, rejected contracts.RejectedOutput) error

func (*FilesystemRecorder) MergeRunning

func (r *FilesystemRecorder) MergeRunning(laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint) error

func (*FilesystemRecorder) MergeRunningForStep

func (r *FilesystemRecorder) MergeRunningForStep(stepID, laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint) error

func (*FilesystemRecorder) MergeSucceeded

func (r *FilesystemRecorder) MergeSucceeded(laneID, moduleKey string, dependencies []pipeline.CheckpointFingerprint, output pipeline.CheckpointArtifact) error

func (*FilesystemRecorder) MergeSucceededForStep

func (r *FilesystemRecorder) MergeSucceededForStep(stepID, laneID, moduleKey string, dependencies []pipeline.CheckpointFingerprint, output pipeline.CheckpointArtifact) error

func (*FilesystemRecorder) NormalizeFailed

func (r *FilesystemRecorder) NormalizeFailed(laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint, err error) error

func (*FilesystemRecorder) NormalizeFailedForStep

func (r *FilesystemRecorder) NormalizeFailedForStep(stepID, laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint, err error) error

func (*FilesystemRecorder) NormalizeRejected

func (r *FilesystemRecorder) NormalizeRejected(laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint, rejected contracts.RejectedOutput) error

func (*FilesystemRecorder) NormalizeRejectedForStep

func (r *FilesystemRecorder) NormalizeRejectedForStep(stepID, laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint, rejected contracts.RejectedOutput) error

func (*FilesystemRecorder) NormalizeRunning

func (r *FilesystemRecorder) NormalizeRunning(laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint) error

func (*FilesystemRecorder) NormalizeRunningForStep

func (r *FilesystemRecorder) NormalizeRunningForStep(stepID, laneID string, moduleKey string, dependencies []pipeline.CheckpointFingerprint) error

func (*FilesystemRecorder) NormalizeSucceeded

func (r *FilesystemRecorder) NormalizeSucceeded(laneID, moduleKey string, dependencies []pipeline.CheckpointFingerprint, output pipeline.CheckpointArtifact) error

func (*FilesystemRecorder) NormalizeSucceededForStep

func (r *FilesystemRecorder) NormalizeSucceededForStep(stepID, laneID, moduleKey string, dependencies []pipeline.CheckpointFingerprint, output pipeline.CheckpointArtifact) error

func (*FilesystemRecorder) SourceFailed

func (r *FilesystemRecorder) SourceFailed(moduleKey string, err error) error

func (*FilesystemRecorder) SourceRunning

func (r *FilesystemRecorder) SourceRunning(moduleKey string) error

func (*FilesystemRecorder) SourceSucceeded

func (r *FilesystemRecorder) SourceSucceeded(moduleKey string, doc *source.SourceDocument) error

type Fingerprint

type Fingerprint struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type Identity

type Identity struct {
	Digest                 string        `json:"digest"`
	PipelineID             string        `json:"pipeline_id"`
	PipelineDigest         string        `json:"pipeline_digest"`
	PipelineTopology       []string      `json:"pipeline_topology,omitempty"`
	InputKey               string        `json:"input_key"`
	RawInputDigest         string        `json:"raw_input_digest,omitempty"`
	SourceDigest           string        `json:"source_digest,omitempty"`
	SelectedLanes          []string      `json:"selected_lanes,omitempty"`
	RuntimeOverrides       []Fingerprint `json:"runtime_overrides,omitempty"`
	ReferenceDigests       []Fingerprint `json:"reference_digests,omitempty"`
	ProvenanceFingerprints []Fingerprint `json:"provenance_fingerprints,omitempty"`
}

func NewIdentity

func NewIdentity(input IdentityInput) (Identity, error)

func (Identity) RelativePath

func (i Identity) RelativePath() (string, error)

type IdentityInput

type IdentityInput struct {
	Pipeline                               pipeline.ResolvedPipeline
	InputKey, RawInputDigest, SourceDigest string
	SelectedLanes                          []string
	RuntimeOverrides                       []Fingerprint
	References                             []artifacts.ReferenceProvenance
	ProvenanceFingerprints                 []Fingerprint
}

type MergeLaneManifest

type MergeLaneManifest struct {
	StageManifest
	InputCount int `json:"input_count,omitempty"`
}

type NormalizeLaneManifest

type NormalizeLaneManifest struct {
	StageManifest
	InputCount int `json:"input_count,omitempty"`
}

type RejectionSummary

type RejectionSummary struct {
	ValidatorName string `json:"validator_name,omitempty"`
	ReasonCode    string `json:"reason_code,omitempty"`
	Message       string `json:"message,omitempty"`
	Count         int    `json:"count,omitempty"`
}

type SourceManifest

type SourceManifest struct {
	StageManifest
	SourceID string `json:"source_id,omitempty"`
}

type StageManifest

type StageManifest struct {
	WorkspaceSchemaVersion string             `json:"workspace_schema_version"`
	Stage                  StageName          `json:"stage"`
	StepID                 string             `json:"step_id,omitempty"`
	LaneID                 string             `json:"lane_id,omitempty"`
	ModuleKey              string             `json:"module_key,omitempty"`
	DependencyFingerprints []Fingerprint      `json:"dependency_fingerprints,omitempty"`
	Status                 StageStatus        `json:"status"`
	OutputDigests          []Fingerprint      `json:"output_digests,omitempty"`
	ValidationStatus       string             `json:"validation_status,omitempty"`
	Rejections             []RejectionSummary `json:"rejections,omitempty"`
	StartedAt              *time.Time         `json:"started_at,omitempty"`
	CompletedAt            *time.Time         `json:"completed_at,omitempty"`
	Metadata               map[string]string  `json:"metadata,omitempty"`
}

func NewStageManifest

func NewStageManifest(stage StageName, status StageStatus) StageManifest

type StageName

type StageName string
const (
	StageSource    StageName = "source"
	StageExtract   StageName = "extract"
	StageMerge     StageName = "merge"
	StageNormalize StageName = "normalize"
)

type StageStatus

type StageStatus string
const (
	StatusPending                 StageStatus = "pending"
	StatusRunning                 StageStatus = "running"
	StatusSucceeded               StageStatus = "succeeded"
	StatusSucceededWithRejections StageStatus = "succeeded_with_rejections"
	StatusFailed                  StageStatus = "failed"
	StatusInvalidated             StageStatus = "invalidated"
)

Jump to

Keyboard shortcuts

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