controlpacks

Documentation

Overview

Package controlpacks installs, manages, and enumerates Concord control packs distributed as OCI artifacts. The manifest schema and read-only on-disk discovery now live in the public pkg/controlpacks so other modules (the platform server) can read an installed catalog; this package re-exports them and adds the OCI fetch + cosign-verify install path that stays internal.

Index

• Constants
• func ControlsDirs(packs []Discovered) []string
• func PackDir(installRoot, framework, version string) string
• func Uninstall(framework string, opts InstallOptions) error
• type Discovered
  • func Discover(installRoot string) ([]Discovered, error)
• type EvidenceSource
• type InstallOptions
• type Installed
  • func Install(ctx context.Context, ref string, opts InstallOptions) (*Installed, error)
• type Pack
  • func ParsePack(path string) (*Pack, error)
  • func ParsePackTarball(tgz []byte) (*Pack, error)
• type PackMetadata
• type PackSpec

Constants

const PackFile = pcp.PackFile

PackFile is the metadata file at the root of every control pack.

Functions

func ControlsDirs

func ControlsDirs(packs []Discovered) []string

ControlsDirs returns the dirs containing per-control YAML for the loader to walk.

func PackDir

func PackDir(installRoot, framework, version string) string

PackDir is the on-disk location for an installed pack.

func Uninstall

func Uninstall(framework string, opts InstallOptions) error

Uninstall removes the extracted pack on disk and drops the lockfile entry.

Types

type Discovered

type Discovered = pcp.Discovered

Re-exported manifest + discovery types so existing internal/CLI callers keep their controlpacks.Pack / controlpacks.Discovered spellings.

func Discover

func Discover(installRoot string) ([]Discovered, error)

Discover walks installRoot and returns every readable, schema-valid pack.

type EvidenceSource

type EvidenceSource = pcp.EvidenceSource

Re-exported manifest + discovery types so existing internal/CLI callers keep their controlpacks.Pack / controlpacks.Discovered spellings.

type InstallOptions

type InstallOptions struct {
	InstallRoot       string
	LockfilePath      string
	PlainHTTP         bool
	RequireSignature  bool
	SkipSignature     bool
	AllowSignerChange bool
	ExpectedIdentity  string
	GitHubRepo        string
	CosignBin         string
	ProgressW         io.Writer
}

InstallOptions tune Install.

type Installed

type Installed struct {
	Framework string
	Version   string
	Artifact  string
	Digest    string
	Dir       string
	Pack      *Pack
}

Installed describes a successfully installed control pack.

func Install

func Install(ctx context.Context, ref string, opts InstallOptions) (*Installed, error)

Install pulls, verifies, extracts, and locks a control-pack OCI artifact.

type Pack

type Pack = pcp.Pack

Re-exported manifest + discovery types so existing internal/CLI callers keep their controlpacks.Pack / controlpacks.Discovered spellings.

func ParsePack

func ParsePack(path string) (*Pack, error)

ParsePack reads and validates a pack.yaml file.

func ParsePackTarball

func ParsePackTarball(tgz []byte) (*Pack, error)

ParsePackTarball reads pack.yaml from a gzipped tar byte slice.

type PackMetadata

type PackMetadata = pcp.PackMetadata

Re-exported manifest + discovery types so existing internal/CLI callers keep their controlpacks.Pack / controlpacks.Discovered spellings.

type PackSpec

type PackSpec = pcp.PackSpec

Re-exported manifest + discovery types so existing internal/CLI callers keep their controlpacks.Pack / controlpacks.Discovered spellings.