oci

Documentation

Overview

Package oci implements all the interactions with remote registry.

Index

• Constants
• func HumanReadableMediaType(s string) string
• func Platforms(ctx context.Context, ref string, client remote.Client) (map[string]struct{}, error)
• type ArtifactConfig
  • func (rc *ArtifactConfig) ParseDependencies(dependencies ...string) error
  • func (rc *ArtifactConfig) ParseRequirements(requirements ...string) error
  • func (rc *ArtifactConfig) SetDependency(name, version string, alternatives []Dependency) int
  • func (rc *ArtifactConfig) SetRequirement(name, version string) int
• type ArtifactDependency
  • func (a *ArtifactDependency) SetAlternative(name, version string)
• type ArtifactRequirement
• type ArtifactType
  • func (e *ArtifactType) Set(v string) error
  • func (e ArtifactType) String() string
  • func (e *ArtifactType) ToMediaType() string
  • func (e *ArtifactType) Type() string
• type ArtifactTypeSlice
  • func (e *ArtifactTypeSlice) Set(v string) error
  • func (e ArtifactTypeSlice) String() string
  • func (e *ArtifactTypeSlice) Type() string
• type Dependency
• type RegistryResult

Constants

const (

	// FalcoRulesfileConfigMediaType is the MediaType for rule's config layer.
	FalcoRulesfileConfigMediaType = "application/vnd.cncf.falco.rulesfile.config.v1+json"

	// FalcoRulesfileLayerMediaType is the MediaType for rules.
	FalcoRulesfileLayerMediaType = "application/vnd.cncf.falco.rulesfile.layer.v1+tar.gz"

	// FalcoPluginConfigMediaType is the MediaType for plugin's config layer.
	FalcoPluginConfigMediaType = "application/vnd.cncf.falco.plugin.config.v1+json"

	// FalcoPluginLayerMediaType is the MediaType for plugins.
	FalcoPluginLayerMediaType = "application/vnd.cncf.falco.plugin.layer.v1+tar.gz"

	// DefaultRegistry is the default container registry to use.
	DefaultRegistry = "ghcr.io"

	// DefaultTag is the default tag reference to be used when none is provided.
	DefaultTag = "latest"
)

Functions

func HumanReadableMediaType

func HumanReadableMediaType(s string) string

HumanReadableMediaType converts MediaType to its corresponding type in a human readable format.

func Platforms

func Platforms(ctx context.Context, ref string, client remote.Client) (map[string]struct{}, error)

Platforms returns a list of all available platforms for a given ref.

Types

type ArtifactConfig

type ArtifactConfig struct {
	// It's the unique name used by the index
	Name         string                `json:"name,omitempty"`
	Version      string                `json:"version,omitempty"`
	Dependencies []ArtifactDependency  `json:"dependencies,omitempty"`
	Requirements []ArtifactRequirement `json:"requirements,omitempty"`
}

ArtifactConfig is the struct stored in the config layer of rulesfile and plugin artifacts. Each type fills only the fields of interest.

func (*ArtifactConfig) ParseDependencies

func (rc *ArtifactConfig) ParseDependencies(dependencies ...string) error

ParseDependencies parses artifact dependencies in the format "name:version|alt1:version1|..." and set them in the config.

func (*ArtifactConfig) ParseRequirements

func (rc *ArtifactConfig) ParseRequirements(requirements ...string) error

ParseRequirements parses artifact requirements in the format "name:version" and set them in the config.

func (*ArtifactConfig) SetDependency

func (rc *ArtifactConfig) SetDependency(name, version string, alternatives []Dependency) int

SetDependency stores an artifact dependency in the config.

Return the insertion position.

func (*ArtifactConfig) SetRequirement

func (rc *ArtifactConfig) SetRequirement(name, version string) int

SetRequirement stores an artifact dependency in the config.

Return the insertion position.

type ArtifactDependency

type ArtifactDependency struct {
	Name         string       `json:"name"`
	Version      string       `json:"version"`
	Alternatives []Dependency `json:"alternatives,omitempty"`
}

ArtifactDependency represents the artifact's depedendency to be stored in the config.

func (*ArtifactDependency) SetAlternative

func (a *ArtifactDependency) SetAlternative(name, version string)

SetAlternative sets an alternative dependency for an artifact dependency.

type ArtifactRequirement

type ArtifactRequirement struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

ArtifactRequirement represents the artifact's requirement to be stored in the config.

type ArtifactType

type ArtifactType string

ArtifactType represents a rules file or a plugin. Used to select the right mediaType when interacting with the registry.

const (
	// Rulesfile represents a rules file artifact.
	Rulesfile ArtifactType = "rulesfile"
	// Plugin represents a plugin artifact.
	Plugin ArtifactType = "plugin"
)

func (*ArtifactType) Set

func (e *ArtifactType) Set(v string) error

Set an ArtifactType.

func (ArtifactType) String

func (e ArtifactType) String() string

String returns a string representation of ArtifactType.

func (*ArtifactType) ToMediaType

func (e *ArtifactType) ToMediaType() string

ToMediaType converts type to its corresponding media type. Ensure this is called after a Set().

func (*ArtifactType) Type

func (e *ArtifactType) Type() string

Type returns a string representing this type.

type ArtifactTypeSlice

type ArtifactTypeSlice struct {
	Types                []ArtifactType
	CommaSeparatedString string
}

ArtifactTypeSlice is a slice of ArtifactType, can be passed as comma separated values.

func (*ArtifactTypeSlice) Set

func (e *ArtifactTypeSlice) Set(v string) error

Set an ArtifactType. Given that we are appending values, the flag can be repeated multiple times.

func (ArtifactTypeSlice) String

func (e ArtifactTypeSlice) String() string

String returns a string representation of ArtifactTypeSlice.

func (*ArtifactTypeSlice) Type

func (e *ArtifactTypeSlice) Type() string

Type returns a string representing this type.

type Dependency

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

Dependency represent a dependency with its own name and version.

type RegistryResult

type RegistryResult struct {
	Digest   string
	Config   ArtifactConfig
	Type     ArtifactType
	Filename string
}

RegistryResult represents a generic result that is generated when interacting with a remote OCI registry.