versionsapi

package
v2.20.0 Latest Latest
Warning

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

 Go to latest Published: Dec 3, 2024 License: AGPL-3.0 Imports: 14 Imported by: 0

Documentation

Overview

Versions API

The Versions API provides information about versions of Constellation components.

This package defines API types that represents objects of the versions API. The types provide helper methods for validation and commonly used operations on the information contained in the objects. Especially the paths used for the API are defined in these helper methods.

The package also provides helper functions that can be used in context of the versions API, e.g. to validate versions.

Index

Constants

View Source 
const ReleaseRef = "-"

ReleaseRef is the ref used for release versions.

Variables

View Source 
var (
	// APIV1 is the v1 API version.
	APIV1 = apiVersion{/* contains filtered or unexported fields */}
	// APIV2 is the v2 API version.
	APIV2 = apiVersion{/* contains filtered or unexported fields */}
)

Functions

func CanonicalizeRef 

func CanonicalizeRef(ref string) string

CanonicalizeRef returns the canonicalized ref for the given ref.

func MeasurementURL 

func MeasurementURL(version Version) (measurementURL, signatureURL *url.URL, err error)

MeasurementURL builds the measurement and signature URLs for the given version.

func NewClient 

func NewClient(ctx context.Context, region, bucket, distributionID string, dryRun bool,
	log *slog.Logger,
) (*Client, CloseFunc, error)

NewClient creates a new client for the versions API.

func NewReadOnlyClient 

func NewReadOnlyClient(ctx context.Context, region, bucket, distributionID string,
	log *slog.Logger,
) (*Client, CloseFunc, error)

NewReadOnlyClient creates a new read-only client. This client can be used to fetch objects but cannot write updates.

func ValidateRef 

func ValidateRef(ref string) error

ValidateRef checks if the given ref is a valid ref. Canonicalize the ref before checking if it is valid.

func ValidateStream 

func ValidateStream(ref, stream string) error

ValidateStream checks if the given stream is a valid stream for the given ref.

Types

type CLIInfo 

type CLIInfo struct {
	// Ref is the reference name of the CLI.
	Ref string `json:"ref,omitempty"`
	// Stream is the stream name of the CLI.
	Stream string `json:"stream,omitempty"`
	// Version is the version of the CLI.
	Version string `json:"version,omitempty"`
	// Kubernetes contains all compatible Kubernetes versions.
	Kubernetes []string `json:"kubernetes,omitempty"`
}

CLIInfo contains information about a specific CLI version (i.e. it's compatibility with Kubernetes versions).

func (CLIInfo) JSONPath 

func (c CLIInfo) JSONPath() string

JSONPath returns the S3 JSON path for this object.

func (CLIInfo) URL 

func (c CLIInfo) URL() (string, error)

URL returns the URL to the JSON file for this object.

func (CLIInfo) Validate 

func (c CLIInfo) Validate() error

Validate checks if the CLI info is valid.

func (CLIInfo) ValidateRequest 

func (c CLIInfo) ValidateRequest() error

ValidateRequest validates the request parameters of the list. The Kubernetes slice must be empty.

type Client 

type Client struct {
	*apiclient.Client
	// contains filtered or unexported fields
}

Client is a client for the versions API.

func (*Client) Close 

func (c *Client) Close(ctx context.Context) error

Close closes the client.

func (*Client) DeleteRef 

func (c *Client) DeleteRef(ctx context.Context, ref string) error

DeleteRef deletes the given ref from the versions API.

func (*Client) DeleteVersion 

func (c *Client) DeleteVersion(ctx context.Context, ver Version) error

DeleteVersion deletes the given version from the versions API. The version will be removed from version lists and latest versions, and the versioned objects are deleted. Notice that the versions API can get into an inconsistent state if the version is the latest version but there is no older version of the same minor version available. Manual update of latest versions is required in this case.

func (*Client) FetchCLIInfo 

func (c *Client) FetchCLIInfo(ctx context.Context, cliInfo CLIInfo) (CLIInfo, error)

FetchCLIInfo fetches the given CLI info from the versions API.

func (*Client) FetchImageInfo 

func (c *Client) FetchImageInfo(ctx context.Context, imageInfo ImageInfo) (ImageInfo, error)

FetchImageInfo fetches the given image info from the versions API.

func (*Client) FetchVersionLatest 

func (c *Client) FetchVersionLatest(ctx context.Context, latest Latest) (Latest, error)

FetchVersionLatest fetches the latest version from the versions API.

func (*Client) FetchVersionList 

func (c *Client) FetchVersionList(ctx context.Context, list List) (List, error)

FetchVersionList fetches the given version list from the versions API.

func (*Client) UpdateCLIInfo 

func (c *Client) UpdateCLIInfo(ctx context.Context, cliInfo CLIInfo) error

UpdateCLIInfo updates the given CLI info in the versions API.

func (*Client) UpdateImageInfo 

func (c *Client) UpdateImageInfo(ctx context.Context, imageInfo ImageInfo) error

UpdateImageInfo updates the given image info in the versions API.

func (*Client) UpdateVersionLatest 

func (c *Client) UpdateVersionLatest(ctx context.Context, latest Latest) error

UpdateVersionLatest updates the latest version in the versions API.

func (*Client) UpdateVersionList 

func (c *Client) UpdateVersionList(ctx context.Context, list List) error

UpdateVersionList updates the given version list in the versions API.

type CloseFunc 

type CloseFunc func(ctx context.Context) error

CloseFunc is a function that closes the client.

type Fetcher 

type Fetcher struct {
	fetcher.HTTPClient
	// contains filtered or unexported fields
}

Fetcher fetches version API resources without authentication.

func NewFetcher 

func NewFetcher() *Fetcher

NewFetcher returns a new Fetcher.

func (*Fetcher) FetchCLIInfo 

func (f *Fetcher) FetchCLIInfo(ctx context.Context, cliInfo CLIInfo) (CLIInfo, error)

FetchCLIInfo fetches the given cli info from the versions API.

func (*Fetcher) FetchImageInfo 

func (f *Fetcher) FetchImageInfo(ctx context.Context, imageInfo ImageInfo) (ImageInfo, error)

FetchImageInfo fetches the given image info from the versions API.

func (*Fetcher) FetchVersionLatest 

func (f *Fetcher) FetchVersionLatest(ctx context.Context, latest Latest) (Latest, error)

FetchVersionLatest fetches the latest version from the versions API.

func (*Fetcher) FetchVersionList 

func (f *Fetcher) FetchVersionList(ctx context.Context, list List) (List, error)

FetchVersionList fetches the given version list from the versions API.

type Granularity 

type Granularity int

Granularity represents the granularity of a semantic version. 

const (
	// GranularityUnknown is the default granularity.
	GranularityUnknown Granularity = iota
	// GranularityMajor is the granularity of a major version, e.g. "v1".
	// Lists with granularity "major" map from a major version to a list of minor versions.
	GranularityMajor
	// GranularityMinor is the granularity of a minor version, e.g. "v1.0".
	// Lists with granularity "minor" map from a minor version to a list of patch versions.
	GranularityMinor
	// GranularityPatch is the granularity of a patch version, e.g. "v1.0.0".
	// There are no lists with granularity "patch".
	GranularityPatch
)

func GranularityFromString 

func GranularityFromString(s string) Granularity

GranularityFromString returns the granularity for the given string.

func (Granularity) MarshalJSON 

func (g Granularity) MarshalJSON() ([]byte, error)

MarshalJSON marshals the granularity to JSON.

func (Granularity) String 

func (g Granularity) String() string

String returns the string representation of the granularity.

func (*Granularity) UnmarshalJSON 

func (g *Granularity) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals the granularity from JSON.

type ImageInfo 

type ImageInfo struct {
	// Ref is the reference name of the image.
	Ref string `json:"ref,omitempty"`
	// Stream is the stream name of the image.
	Stream string `json:"stream,omitempty"`
	// Version is the version of the image.
	Version string `json:"version,omitempty"`
	// List contains the image variants for this version.
	List []ImageInfoEntry `json:"list,omitempty"`
}

ImageInfo contains information about the OS images for a specific version.

func MergeImageInfos 

func MergeImageInfos(infos ...ImageInfo) (ImageInfo, error)

MergeImageInfos combines the image info entries from multiple sources into a single image info object.

func (ImageInfo) JSONPath 

func (i ImageInfo) JSONPath() string

JSONPath returns the S3 JSON path for this object.

func (ImageInfo) URL 

func (i ImageInfo) URL() (string, error)

URL returns the URL to the JSON file for this object.

func (ImageInfo) Validate 

func (i ImageInfo) Validate() error

Validate checks if the image info is valid.

func (ImageInfo) ValidateRequest 

func (i ImageInfo) ValidateRequest() error

ValidateRequest validates the request parameters of the list. The provider specific maps must be empty.

type ImageInfoEntry 

type ImageInfoEntry struct {
	CSP                string `json:"csp"`
	AttestationVariant string `json:"attestationVariant"`
	Reference          string `json:"reference"`
	Region             string `json:"region,omitempty"`
}

ImageInfoEntry contains information about a single image variant.

type Latest 

type Latest struct {
	// Ref is the branch name this latest version belongs to.
	Ref string `json:"ref,omitempty"`
	// Stream is stream name this latest version belongs to.
	Stream string `json:"stream,omitempty"`
	// Kind is the kind of resource this latest version is for.
	Kind VersionKind `json:"kind,omitempty"`
	// Version is the latest version for this ref, stream and kind.
	Version string `json:"version,omitempty"`
}

Latest is the latest version of a kind of resource.

func (Latest) JSONPath 

func (l Latest) JSONPath() string

JSONPath returns the S3 JSON path for this object.

func (Latest) ShortPath 

func (l Latest) ShortPath() string

ShortPath returns the short path of the latest version.

func (Latest) URL 

func (l Latest) URL() (string, error)

URL returns the URL for this object.

func (Latest) Validate 

func (l Latest) Validate() error

Validate checks if this latest version is valid.

func (Latest) ValidateRequest 

func (l Latest) ValidateRequest() error

ValidateRequest checks if this latest version beside values that are fetched.

type List 

type List struct {
	// Ref is the branch name the list belongs to.
	Ref string `json:"ref,omitempty"`
	// Stream is the update stream of the list.
	Stream string `json:"stream,omitempty"`
	// Granularity is the granularity of the base version of this list.
	// It can be either "major" or "minor".
	Granularity Granularity `json:"granularity,omitempty"`
	// Base is the base version of the list.
	// Every version in the list is a finer-grained version of this base version.
	Base string `json:"base,omitempty"`
	// Kind is the kind of resource this list is for.
	Kind VersionKind `json:"kind,omitempty"`
	// Versions is a list of all versions in this list.
	Versions []string `json:"versions,omitempty"`
}

List represents a list of versions for a kind of resource. It has a granularity of either "major" or "minor".

For example, a List with granularity "major" could contain the base version "v1" and a list of minor versions "v1.0", "v1.1", "v1.2" etc. A List with granularity "minor" could contain the base version "v1.0" and a list of patch versions "v1.0.0", "v1.0.1", "v1.0.2" etc.

func (List) Contains 

func (l List) Contains(version string) bool

Contains returns true if the list contains the given version.

func (List) JSONPath 

func (l List) JSONPath() string

JSONPath returns the S3 JSON path for this object.

func (List) StructuredVersions 

func (l List) StructuredVersions() []Version

StructuredVersions returns the versions of the list as slice of Version structs.

func (List) URL 

func (l List) URL() (string, error)

URL returns the URL for this object.

func (List) Validate 

func (l List) Validate() error

Validate checks if the list is valid. This performs the following checks: - The ref is set. - The stream is supported. - The granularity is "major" or "minor". - The kind is supported. - The base version is a valid semantic version that matches the granularity. - All versions in the list are valid semantic versions that are finer-grained than the base version.

func (List) ValidateRequest 

func (l List) ValidateRequest() error

ValidateRequest validates the request parameters of the list. The versions field must be empty.

type Version 

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

Version represents a version. A version has a ref, stream, version string and kind.

Notice that version is a meta object to the versions API and there isn't an actual corresponding object in the S3 bucket. Therefore, the version object doesn't have a URL or JSON path.

Versions fields are private so the type can be used in other packages by defining private interfaces.

func NewVersion added in v2.10.0 

func NewVersion(ref, stream, version string, kind VersionKind) (Version, error)

NewVersion creates a new Version object and validates it.

func NewVersionFromShortPath 

func NewVersionFromShortPath(shortPath string, kind VersionKind) (Version, error)

NewVersionFromShortPath creates a new Version from a version short path.

func (Version) ArtifactPath 

func (v Version) ArtifactPath(apiVer apiVersion) string

ArtifactPath returns the path to the artifacts stored for this version. The path points to a directory.

func (Version) ArtifactsURL 

func (v Version) ArtifactsURL(apiVer apiVersion) string

ArtifactsURL returns the URL to the artifacts stored for this version. The URL points to a directory.

func (Version) Equal 

func (v Version) Equal(other Version) bool

Equal returns true if the versions are equal.

func (Version) Kind 

func (v Version) Kind() VersionKind

Kind returns the kind of the version.

func (Version) ListPath 

func (v Version) ListPath(gran Granularity) string

ListPath returns the path of the list with the given granularity, this version is listed in. For example, assing GranularityMajor returns the path of the versions list that maps the major version of this version to its minor version. In case of an unknown granularity, an empty string is returned.

func (Version) ListURL 

func (v Version) ListURL(gran Granularity) string

ListURL returns the URL of the list with the given granularity, this version is listed in. For example, assing GranularityMajor returns the URL of the versions list that maps the major version of this version to its minor version. In case of an unknown granularity, an empty string is returned.

func (Version) Major 

func (v Version) Major() string

Major returns the major version corresponding to the version. For example, if the version is "v1.2.3", the major version is "v1".

func (Version) MajorMinor 

func (v Version) MajorMinor() string

MajorMinor returns the major and minor version corresponding to the version. For example, if the version is "v1.2.3", the major and minor version is "v1.2".

func (Version) Ref 

func (v Version) Ref() string

Ref returns the ref of the version.

func (Version) ShortPath 

func (v Version) ShortPath() string

ShortPath returns the short path of the version.

func (Version) Stream 

func (v Version) Stream() string

Stream returns the stream of the version.

func (Version) Validate 

func (v Version) Validate() error

Validate validates the version.

func (Version) Version 

func (v Version) Version() string

Version returns the version string of the version.

func (Version) WithGranularity 

func (v Version) WithGranularity(gran Granularity) string

WithGranularity returns the version with the given granularity.

For example, if the version is "v1.2.3" and the granularity is GranularityMajor, the returned version is "v1". This is a helper function for Major() and MajorMinor() and v.version. In case of an unknown granularity, an empty string is returned.

type VersionKind 

type VersionKind int

VersionKind represents the kind of resource the version versions. 

const (
	// VersionKindUnknown is the default value for VersionKind.
	VersionKindUnknown VersionKind = iota
	// VersionKindImage is the kind for image versions.
	VersionKindImage
	// VersionKindCLI is the kind for CLI versions.
	VersionKindCLI
)

func VersionKindFromString 

func VersionKindFromString(s string) VersionKind

VersionKindFromString returns the VersionKind for the given string.

func (VersionKind) MarshalJSON 

func (k VersionKind) MarshalJSON() ([]byte, error)

MarshalJSON marshals the VersionKind to JSON.

func (VersionKind) String 

func (k VersionKind) String() string

String returns the string representation of the VersionKind.

func (*VersionKind) UnmarshalJSON 

func (k *VersionKind) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals the VersionKind from JSON.

Source Files

View all Source files

Directories

Path Synopsis
This package provides a CLI tool to interact with the Constellation versions API.
 This package provides a CLI tool to interact with the Constellation versions API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.