release

Documentation

Index

• func GetServerAddr() string
• type Asset
• type Client
  • func NewClient(cfg ClientConfig) (*Client, error)
  • func (c *Client) ListReleases(ctx context.Context) ([]*types.Release, error)
• type ClientConfig
  • func (c *ClientConfig) CheckAndSetDefaults() error
• type Release

Functions

func GetServerAddr

func GetServerAddr() string

GetServerAddr returns the release server address from the environment variables or, if not set, the default value

Types

type Asset

type Asset struct {
	// Arch is the architecture of the asset
	Arch string `json:"arch"`
	// Description is the description of the asset
	Description string `json:"description"`
	// Name is the name of the asset
	Name string `json:"name"`
	// OS is which OS the asset is built for
	OS string `json:"os"`
	// SHA256 is the sha256 of the asset
	SHA256 string `json:"sha256"`
	// Size is the size of the release in bytes
	Size int64 `json:"size"`
	// ReleaseIDs is a list of releases that have the asset included
	ReleaseIDs []string `json:"releaseIds"`
	// PublicURL is the public URL used to download the asset
	PublicURL string `json:"publicUrl"`
}

Asset represents a release asset returned by the release service

type Client

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

Client is a client to make HTTPS requests to the release server using the Teleport Enterprise license as authentication

func NewClient

func NewClient(cfg ClientConfig) (*Client, error)

NewClient returns a new release client with a client to make https requests to the release server

func (*Client) ListReleases

func (c *Client) ListReleases(ctx context.Context) ([]*types.Release, error)

ListReleases calls the release server and returns a list of releases

type ClientConfig

type ClientConfig struct {
	// TLSConfig is the client TLS configuration
	TLSConfig *tls.Config
	// ReleaseServerAddr is the address of the release server
	ReleaseServerAddr string
}

ClientConfig contains configuration for the release client

func (*ClientConfig) CheckAndSetDefaults

func (c *ClientConfig) CheckAndSetDefaults() error

CheckAndSetDefaults checks and sets default config values

type Release

type Release struct {
	// NotesMD is the notes of the release in markdown
	NotesMD string `json:"notesMd"`
	// Product is the release product, teleport or teleport-ent
	Product string `json:"product"`
	// ReleaseId is the ID of the product
	ReleaseID string `json:"releaseId"`
	// Status is the status of the release
	Status string `json:"status"`
	// Version is the version of the release
	Version string `json:"version"`
	// Assets is a list of assets related to the release
	Assets []*Asset `json:"assets"`
}

Release corresponds to a Teleport Enterprise release returned by the release service