pull

Documentation

Index

• Variables
• func GetAppMetadataFromAirgap(airgapArchive string) ([]byte, error)
• func GetAppPublicKey(license *kotsv1beta1.License) ([]byte, error)
• func GetUpdates(upstreamURI string, getUpdatesOptions GetUpdatesOptions) ([]upstream.Update, error)
• func LicenseIsExpired(license *kotsv1beta1.License) (bool, error)
• func ParseConfigValuesFromFile(filename string) (*kotsv1beta1.ConfigValues, error)
• func ParseIdentityConfigFromFile(filename string) (*kotsv1beta1.IdentityConfig, error)
• func ParseLicenseFromBytes(licenseData []byte) (*kotsv1beta1.License, error)
• func ParseLicenseFromFile(filename string) (*kotsv1beta1.License, error)
• func Pull(upstreamURI string, pullOptions PullOptions) (string, error)
• func PullApplicationMetadata(upstreamURI string) ([]byte, error)
• func RewriteUpstream(upstreamURI string) string
• func VerifyOldSignature(license *kotsv1beta1.License) (*kotsv1beta1.License, error)
• func VerifySignature(license *kotsv1beta1.License) (*kotsv1beta1.License, error)
• type GetUpdatesOptions
• type InnerSignature
• type KeySignature
• type OuterSignature
• type PullOptions
• type RewriteImageOptions

Variables

var (
	ErrSignatureInvalid = errors.New("signature is invalid")
	ErrSignatureMissing = errors.New("signature is missing")
)

Functions

func GetAppMetadataFromAirgap

func GetAppMetadataFromAirgap(airgapArchive string) ([]byte, error)

func GetAppPublicKey

func GetAppPublicKey(license *kotsv1beta1.License) ([]byte, error)

func GetUpdates

func GetUpdates(upstreamURI string, getUpdatesOptions GetUpdatesOptions) ([]upstream.Update, error)

GetUpdates will retrieve all later versions of the application specified in upstreamURI using the options specified in getUpdatesOptions. It returns a list of versions.

func LicenseIsExpired

func LicenseIsExpired(license *kotsv1beta1.License) (bool, error)

func ParseConfigValuesFromFile

func ParseConfigValuesFromFile(filename string) (*kotsv1beta1.ConfigValues, error)

func ParseIdentityConfigFromFile

func ParseIdentityConfigFromFile(filename string) (*kotsv1beta1.IdentityConfig, error)

func ParseLicenseFromBytes

func ParseLicenseFromBytes(licenseData []byte) (*kotsv1beta1.License, error)

func ParseLicenseFromFile

func ParseLicenseFromFile(filename string) (*kotsv1beta1.License, error)

func Pull

func Pull(upstreamURI string, pullOptions PullOptions) (string, error)

Pull will download the application specified in upstreamURI using the options specified in pullOptions. It returns the directory that the app was pulled to

func PullApplicationMetadata

func PullApplicationMetadata(upstreamURI string) ([]byte, error)

PullApplicationMetadata will return the application metadata yaml, if one is available for the upstream

func RewriteUpstream

func RewriteUpstream(upstreamURI string) string

func VerifyOldSignature

func VerifyOldSignature(license *kotsv1beta1.License) (*kotsv1beta1.License, error)

func VerifySignature

func VerifySignature(license *kotsv1beta1.License) (*kotsv1beta1.License, error)

Types

type GetUpdatesOptions

type GetUpdatesOptions struct {
	HelmRepoURI         string
	Namespace           string
	LocalPath           string
	License             *kotsv1beta1.License
	CurrentCursor       string
	CurrentChannelID    string
	CurrentChannelName  string
	CurrentVersionLabel string
	ReportingInfo       *reportingtypes.ReportingInfo
	Silent              bool
}

type InnerSignature

type InnerSignature struct {
	LicenseSignature []byte `json:"licenseSignature"`
	PublicKey        string `json:"publicKey"`
	KeySignature     []byte `json:"keySignature"`
}

type KeySignature

type KeySignature struct {
	Signature   []byte `json:"signature"`
	GlobalKeyId string `json:"globalKeyId"`
}

type OuterSignature

type OuterSignature struct {
	LicenseData    []byte `json:"licenseData"`
	InnerSignature []byte `json:"innerSignature"`
}

type PullOptions

type PullOptions struct {
	HelmRepoURI            string
	RootDir                string
	Namespace              string
	Downstreams            []string
	LocalPath              string
	LicenseObj             *kotsv1beta1.License
	LicenseFile            string
	InstallationFile       string
	AirgapRoot             string
	AirgapBundle           string
	ConfigFile             string
	IdentityConfigFile     string
	UpdateCursor           string
	ExcludeKotsKinds       bool
	ExcludeAdminConsole    bool
	IncludeMinio           bool
	SharedPassword         string
	CreateAppDir           bool
	Silent                 bool
	RewriteImages          bool
	RewriteImageOptions    RewriteImageOptions
	HelmVersion            string
	HelmOptions            []string
	SkipHelmChartCheck     bool
	ReportWriter           io.Writer
	AppSlug                string
	AppSequence            int64
	IsGitOps               bool
	HTTPProxyEnvValue      string
	HTTPSProxyEnvValue     string
	NoProxyEnvValue        string
	ReportingInfo          *reportingtypes.ReportingInfo
	IdentityPostgresConfig *kotsv1beta1.IdentityPostgresConfig
}

type RewriteImageOptions

type RewriteImageOptions struct {
	ImageFiles string
	Host       string
	Namespace  string
	Username   string
	Password   string
	IsReadOnly bool
}