types

Documentation

Index

• type FetchOptions
• type Update
• type UpdateCheckResult
• type Upstream
  • func (u *Upstream) GetBaseDir(options WriteOptions) string
  • func (u *Upstream) GetHelmDir(options WriteOptions) string
  • func (u *Upstream) GetKotsKindsDir(options WriteOptions) string
  • func (u *Upstream) GetOverlaysDir(options WriteOptions) string
  • func (u *Upstream) GetRenderedDir(options WriteOptions) string
  • func (u *Upstream) GetSkippedDir(options WriteOptions) string
  • func (u *Upstream) GetUpstreamDir(options WriteOptions) string
• type UpstreamFile
• type WriteOptions

Types

type FetchOptions

type FetchOptions struct {
	RootDir                         string
	UseAppDir                       bool
	HelmRepoURI                     string
	LocalPath                       string
	License                         *kotsv1beta1.License
	ConfigValues                    *kotsv1beta1.ConfigValues
	IdentityConfig                  *kotsv1beta1.IdentityConfig
	Airgap                          *kotsv1beta1.Airgap
	EncryptionKey                   string
	LastUpdateCheckAt               *time.Time
	CurrentCursor                   string
	CurrentChannelID                string
	CurrentChannelName              string
	CurrentVersionLabel             string
	CurrentVersionIsRequired        bool
	CurrentReplicatedRegistryDomain string
	CurrentReplicatedProxyDomain    string
	ChannelChanged                  bool
	AppSlug                         string
	AppSequence                     int64
	AppVersionLabel                 string
	LocalRegistry                   registrytypes.RegistrySettings
	ReportingInfo                   *reportingtypes.ReportingInfo
	SkipCompatibilityCheck          bool
}

type Update

type Update struct {
	ChannelID    string     `json:"channelID"`
	ChannelName  string     `json:"channelName"`
	Cursor       string     `json:"cursor"`
	VersionLabel string     `json:"versionLabel"`
	IsRequired   bool       `json:"isRequired"`
	ReleaseNotes string     `json:"releaseNotes"`
	ReleasedAt   *time.Time `json:"releasedAt"`
	AppSequence  *int64     `json:"appSequence"` // can have a sequence if update is available as a pending download app version
}

type UpdateCheckResult

type UpdateCheckResult struct {
	UpdateCheckTime time.Time `json:"updateCheckTime"`
	Updates         []Update  `json:"updates"`
}

type Upstream

type Upstream struct {
	URI                      string
	Name                     string
	Type                     string
	Files                    []UpstreamFile
	UpdateCursor             string
	ChannelID                string
	ChannelName              string
	VersionLabel             string
	IsRequired               bool
	ReleaseNotes             string
	ReleasedAt               *time.Time
	ReplicatedRegistryDomain string
	ReplicatedProxyDomain    string
	EncryptionKey            string
}

func (*Upstream) GetBaseDir

func (u *Upstream) GetBaseDir(options WriteOptions) string

func (*Upstream) GetHelmDir

func (u *Upstream) GetHelmDir(options WriteOptions) string

func (*Upstream) GetKotsKindsDir

func (u *Upstream) GetKotsKindsDir(options WriteOptions) string

func (*Upstream) GetOverlaysDir

func (u *Upstream) GetOverlaysDir(options WriteOptions) string

func (*Upstream) GetRenderedDir

func (u *Upstream) GetRenderedDir(options WriteOptions) string

func (*Upstream) GetSkippedDir

func (u *Upstream) GetSkippedDir(options WriteOptions) string

func (*Upstream) GetUpstreamDir

func (u *Upstream) GetUpstreamDir(options WriteOptions) string

type UpstreamFile

type UpstreamFile struct {
	Path    string
	Content []byte
}

type WriteOptions

type WriteOptions struct {
	RootDir              string
	Namespace            string
	CreateAppDir         bool
	IncludeAdminConsole  bool
	IncludeMinio         bool
	MigrateToMinioXl     bool
	CurrentMinioImage    string
	HTTPProxyEnvValue    string
	HTTPSProxyEnvValue   string
	NoProxyEnvValue      string
	IsMinimalRBAC        bool
	AdditionalNamespaces []string
	// This should be set to true when updating due to license sync, config update, registry settings update.
	// and should be false when it's an upstream update.
	// When true, the channel name in Installation yaml will not be changed.
	PreserveInstallation bool
	// Set to true on initial installation when an unencrypted config file is provided
	EncryptConfig  bool
	SharedPassword string
	IsOpenShift    bool
	IsGKEAutopilot bool

	RegistryConfig kotsadmtypes.RegistryConfig
}