pull

Documentation

Index

• Variables
• func CleanBaseArchive(path string) error
• func GetAppMetadataFromAirgap(airgapArchive string) (*replicatedapp.ApplicationMetadata, error)
• func GetUpdates(upstreamURI string, getUpdatesOptions GetUpdatesOptions) (*upstreamtypes.UpdateCheckResult, error)
• func ParseConfigValuesFromFile(filename string) (*kotsv1beta1.ConfigValues, error)
• func ParseIdentityConfigFromFile(filename string) (*kotsv1beta1.IdentityConfig, error)
• func Pull(upstreamURI string, pullOptions PullOptions) (string, error)
• func PullApplicationMetadata(upstreamURI string, versionLabel string) (*replicatedapp.ApplicationMetadata, error)
• func RewriteUpstream(upstreamURI string) string
• type GetUpdatesOptions
• type PullOptions

Variables

var (
	ErrConfigNeeded = errors.New("version needs config")
)

Functions

func CleanBaseArchive

func CleanBaseArchive(path string) error

func GetAppMetadataFromAirgap

func GetAppMetadataFromAirgap(airgapArchive string) (*replicatedapp.ApplicationMetadata, error)

func GetUpdates

func GetUpdates(upstreamURI string, getUpdatesOptions GetUpdatesOptions) (*upstreamtypes.UpdateCheckResult, 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 ParseConfigValuesFromFile

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

func ParseIdentityConfigFromFile

func ParseIdentityConfigFromFile(filename string) (*kotsv1beta1.IdentityConfig, 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, versionLabel string) (*replicatedapp.ApplicationMetadata, error)

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

func RewriteUpstream

func RewriteUpstream(upstreamURI string) string

Types

type GetUpdatesOptions

type GetUpdatesOptions struct {
	HelmRepoURI        string
	Namespace          string
	License            *kotsv1beta1.License
	LastUpdateCheckAt  *time.Time
	CurrentCursor      string
	CurrentChannelID   string
	CurrentChannelName string
	ChannelChanged     bool
	ReportingInfo      *reportingtypes.ReportingInfo
	Silent             bool
}

type PullOptions

type PullOptions struct {
	RootDir                 string
	Namespace               string
	Downstreams             []string
	LocalPath               string
	LicenseObj              *kotsv1beta1.License
	LicenseFile             string
	LicenseEndpointOverride string // only used for testing
	InstallationFile        string
	IsAirgap                bool
	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     registrytypes.RegistrySettings
	SkipHelmChartCheck      bool
	ReportWriter            io.Writer
	AppID                   string
	AppSlug                 string
	AppSequence             int64
	AppVersionLabel         string
	AppSelectedChannelID    string
	IsGitOps                bool
	StorageClassName        string
	HTTPProxyEnvValue       string
	HTTPSProxyEnvValue      string
	NoProxyEnvValue         string
	ReportingInfo           *reportingtypes.ReportingInfo
	SkipCompatibilityCheck  bool
	KotsKinds               *kotsutil.KotsKinds
}