apprclient

README

apprclient

Package apprclient implements Application Registry related primitives to work against some CNR implementation.

Projects using apprclient

Test libraries

• https://github.com/giantswarm/e2e-harness
• https://github.com/giantswarm/e2etests

Libraries

Services & operators

• https://github.com/giantswarm/aws-operator
• https://github.com/giantswarm/azure-operator
• https://github.com/giantswarm/chart-operator
• https://github.com/giantswarm/cluster-operator
• https://github.com/giantswarm/kvm-operator

Documentation

Overview

Package apprclient holds the client code required to interact with a CNR backend.

Index

• func IsInvalidConfig(err error) bool
• func IsInvalidStatusCode(err error) bool
• func IsUnknownStatus(err error) bool
• type Client
  • func New(config Config) (*Client, error)
  • func (c *Client) DeleteRelease(ctx context.Context, name, release string) error
  • func (c *Client) GetReleaseVersion(ctx context.Context, name, channel string) (string, error)
  • func (c *Client) PromoteChart(ctx context.Context, name, release, channel string) error
  • func (c *Client) PullChartTarball(ctx context.Context, name, channel string) (string, error)
  • func (c *Client) PullChartTarballFromRelease(ctx context.Context, name, release string) (string, error)
  • func (c *Client) PushChartTarball(ctx context.Context, name, release, tarballPath string) error
• type Config
• type Interface
• type Payload
• type Response

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

func IsInvalidStatusCode

func IsInvalidStatusCode(err error) bool

IsInvalidStatusCode asserts invalidStatusCodeError.

func IsUnknownStatus

func IsUnknownStatus(err error) bool

IsUnknownStatus asserts unknownStatusError.

Types

type Client

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

Client knows how to talk with a CNR server.

func New

func New(config Config) (*Client, error)

New creates a new configured appr client.

func (*Client) DeleteRelease

func (c *Client) DeleteRelease(ctx context.Context, name, release string) error

DeleteRelease removes a release from the server.

func (*Client) GetReleaseVersion

func (c *Client) GetReleaseVersion(ctx context.Context, name, channel string) (string, error)

GetReleaseVersion queries CNR for the release version of the chart represented by the given name and channel.

func (*Client) PromoteChart

func (c *Client) PromoteChart(ctx context.Context, name, release, channel string) error

PromoteChart puts a release of the given chart in a channel.

func (*Client) PullChartTarball

func (c *Client) PullChartTarball(ctx context.Context, name, channel string) (string, error)

PullChartTarball downloads a tarball with the chart described by the given chart name and channel, returning the file path.

func (*Client) PullChartTarballFromRelease

func (c *Client) PullChartTarballFromRelease(ctx context.Context, name, release string) (string, error)

PullChartTarballFromRelease downloads a tarball with the chart described by the given chart name and release, returning the file path.

func (*Client) PushChartTarball

func (c *Client) PushChartTarball(ctx context.Context, name, release, tarballPath string) error

PushChartTarball sends a tarball to the server to be installed for the given name and release.

type Config

type Config struct {
	Fs     afero.Fs
	Logger micrologger.Logger

	Address      string
	Organization string
}

Config represents the configuration used to create a appr client.

type Interface

type Interface interface {
	// DeleteRelease removes a release from the server.
	DeleteRelease(ctx context.Context, name, release string) error
	// GetReleaseVersion queries CNR for the release version of the chart
	// represented by the given name and channel.
	GetReleaseVersion(ctx context.Context, name, channel string) (string, error)
	// PromoteChart puts a release of the given chart in a channel.
	PromoteChart(ctx context.Context, name, release, channel string) error
	// PullChartTarball downloads a tarball with the chart described by
	// the given chart name and channel, returning the file path.
	PullChartTarball(ctx context.Context, name, channel string) (string, error)
	// PullChartTarballFromRelease downloads a tarball with the chart described
	// by the given chart name and release, returning the file path.
	PullChartTarballFromRelease(ctx context.Context, name, release string) (string, error)
	// PushChartTarball sends a tarball to the server to be installed for the given
	// name and release.
	PushChartTarball(ctx context.Context, name, release, tarballPath string) error
}

Interface describes the methods provided by the appr client.

type Payload

type Payload struct {
	Release   string `json:"release"`
	MediaType string `json:"media_type"`
	Blob      string `json:"blob"`
}

type Response

type Response struct {
	Status string `json:"status"`
}