cincinnati

Documentation

Index

• Constants
• type Client
  • func NewClient(id uuid.UUID, proxyURL *url.URL, tlsConfig *tls.Config) Client
  • func (c Client) GetUpdates(uri *url.URL, arch string, channel string, version semver.Version) ([]Update, error)
• type Error
  • func (err *Error) Error() string
• type Update

Constants

const (
	// GraphMediaType is the media-type specified in the HTTP Accept header
	// of requests sent to the Cincinnati-v1 Graph API.
	GraphMediaType = "application/json"
)

Types

type Client

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

Client is a Cincinnati client which can be used to fetch update graphs from an upstream Cincinnati stack.

func NewClient

func NewClient(id uuid.UUID, proxyURL *url.URL, tlsConfig *tls.Config) Client

NewClient creates a new Cincinnati client with the given client identifier.

func (Client) GetUpdates

func (c Client) GetUpdates(uri *url.URL, arch string, channel string, version semver.Version) ([]Update, error)

GetUpdates fetches the next-applicable update payloads from the specified upstream Cincinnati stack given the current version and channel. The next- applicable updates are determined by downloading the update graph, finding the current version within that graph (typically the root node), and then finding all of the children. These children are the available updates for the current version and their payloads indicate from where the actual update image can be downloaded.

type Error

type Error struct {
	// Reason is the reason suggested for the ClusterOperator status condition.
	Reason string

	// Message is the message suggested for the ClusterOperator status condition.
	Message string
	// contains filtered or unexported fields
}

Error is returned when are unable to get updates.

func (*Error) Error

func (err *Error) Error() string

Error serializes the error as a string, to satisfy the error interface.

type Update

type Update node

Update is a single node from the update graph.