upstream

Documentation

Index

• Constants
• Variables
• func FetchUpstream(upstreamURI string, fetchOptions *types.FetchOptions) (*types.Upstream, error)
• func GenerateAdminConsoleFiles(renderDir string, options types.WriteOptions) ([]types.UpstreamFile, error)
• func GetApplicationMetadata(upstream *url.URL, versionLabel string) ([]byte, error)
• func GetUpdatesUpstream(upstreamURI string, fetchOptions *types.FetchOptions) (*types.UpdateCheckResult, error)
• func LoadIdentity(upstreamDir string) (*kotsv1beta1.Identity, error)
• func LoadIdentityConfig(upstreamDir string) (*kotsv1beta1.IdentityConfig, error)
• func MustMarshalLicense(license *kotsv1beta1.License) []byte
• func SaveIdentityConfig(identityConfig *kotsv1beta1.IdentityConfig, upstreamDir string) error
• func SaveInstallation(installation *kotsv1beta1.Installation, upstreamDir string) error
• func WriteUpstream(u *types.Upstream, options types.WriteOptions) error
• type App
• type ChannelRelease
• type IncompatibleAppError
  • func (e IncompatibleAppError) Error() string
• type ProcessUpstreamImageResult
  • func ProcessUpstreamImages(u *types.Upstream, options ProcessUpstreamImagesOptions) (*ProcessUpstreamImageResult, error)
• type ProcessUpstreamImagesOptions
• type ProgressImage
• type ProgressReport
• type Release
• type ReplicatedCursor
  • func (this ReplicatedCursor) Equal(other ReplicatedCursor) bool
• type ReplicatedUpstream
• type UpgradeOptions
• type UpgradeRelease
• type UpgradeResponse
  • func Upgrade(appSlug string, options UpgradeOptions) (*UpgradeResponse, error)
• type UpstreamSettings

Constants

const DefaultMetadata = `` /* 232-byte string literal not displayed */

Variables

var KnownRepos = map[string]string{
	"stable":  "https://kubernetes-charts.storage.googleapis.com",
	"local":   "http://127.0.0.1:8879",
	"elastic": "https://helm.elastic.co",
	"gomods":  "https://athens.blob.core.windows.net/charts",
	"harbor":  "https://helm.goharbor.io",
}

Functions

func FetchUpstream

func FetchUpstream(upstreamURI string, fetchOptions *types.FetchOptions) (*types.Upstream, error)

func GenerateAdminConsoleFiles

func GenerateAdminConsoleFiles(renderDir string, options types.WriteOptions) ([]types.UpstreamFile, error)

func GetApplicationMetadata

func GetApplicationMetadata(upstream *url.URL, versionLabel string) ([]byte, error)

GetApplicationMetadata will return any available application yaml from the upstream. If there is no application.yaml, it will return a placeholder one

func GetUpdatesUpstream

func GetUpdatesUpstream(upstreamURI string, fetchOptions *types.FetchOptions) (*types.UpdateCheckResult, error)

func LoadIdentity

func LoadIdentity(upstreamDir string) (*kotsv1beta1.Identity, error)

func LoadIdentityConfig

func LoadIdentityConfig(upstreamDir string) (*kotsv1beta1.IdentityConfig, error)

func MustMarshalLicense

func MustMarshalLicense(license *kotsv1beta1.License) []byte

func SaveIdentityConfig

func SaveIdentityConfig(identityConfig *kotsv1beta1.IdentityConfig, upstreamDir string) error

func SaveInstallation

func SaveInstallation(installation *kotsv1beta1.Installation, upstreamDir string) error

func WriteUpstream

func WriteUpstream(u *types.Upstream, options types.WriteOptions) error

Types

type App

type App struct {
	Name string
}

type ChannelRelease

type ChannelRelease struct {
	ChannelSequence int    `json:"channelSequence"`
	ReleaseSequence int    `json:"releaseSequence"`
	VersionLabel    string `json:"versionLabel"`
	IsRequired      bool   `json:"isRequired"`
	CreatedAt       string `json:"createdAt"`
	ReleaseNotes    string `json:"releaseNotes"`
}

type IncompatibleAppError

type IncompatibleAppError struct {
	KotsApplication *kotsv1beta1.Application
	License         *kotsv1beta1.License
	Message         string
}

func (IncompatibleAppError) Error

func (e IncompatibleAppError) Error() string

type ProcessUpstreamImageResult

type ProcessUpstreamImageResult struct {
	KustomizeImages []kustomizetypes.Image
	KnownImages     []kotsv1beta1.InstallationImage
}

func ProcessUpstreamImages

func ProcessUpstreamImages(u *types.Upstream, options ProcessUpstreamImagesOptions) (*ProcessUpstreamImageResult, error)

type ProcessUpstreamImagesOptions

type ProcessUpstreamImagesOptions struct {
	RootDir             string
	ImagesDir           string
	AirgapBundle        string
	CreateAppDir        bool
	PushImages          bool
	UseKnownImages      bool
	KnownImages         []kustomizetypes.Image
	Log                 *logger.CLILogger
	ReplicatedRegistry  registry.RegistryOptions
	ReportWriter        io.Writer
	DestinationRegistry registry.RegistryOptions
}

type ProgressImage

type ProgressImage struct {
	// image name and tag, "nginx:latest"
	DisplayName string `json:"displayName"`
	// image upload status: queued, uploading, uploaded, failed
	Status string `json:"status"`
	// error string set when status is failed
	Error string `json:"error"`
	// amount currently uploaded (currently number of layers)
	Current int64 `json:"current"`
	// total amount that needs to be uploaded (currently number of layers)
	Total int64 `json:"total"`
	// time when image started uploading
	StartTime time.Time `json:"startTime"`
	// time when image finished uploading
	EndTime time.Time `json:"endTime"`
}

type ProgressReport

type ProgressReport struct {
	// set to "progressReport"
	Type string `json:"type"`
	// the same progress text that used to be sent in unstructured message
	CompatibilityMessage string `json:"compatibilityMessage"`
	// all images found in archive
	Images []ProgressImage `json:"images"`
}

type Release

type Release struct {
	UpdateCursor ReplicatedCursor
	VersionLabel string
	IsRequired   bool
	ReleaseNotes string
	ReleasedAt   *time.Time
	Manifests    map[string][]byte
}

type ReplicatedCursor

type ReplicatedCursor struct {
	ChannelID   string
	ChannelName string
	Cursor      string
}

func (ReplicatedCursor) Equal

func (this ReplicatedCursor) Equal(other ReplicatedCursor) bool

type ReplicatedUpstream

type ReplicatedUpstream struct {
	Channel      *string
	AppSlug      string
	VersionLabel *string
	Sequence     *int
}

type UpgradeOptions

type UpgradeOptions struct {
	AirgapBundle        string
	RegistryEndpoint    string
	RegistryNamespace   string
	RegistryUsername    string
	RegistryPassword    string
	IsKurl              bool
	DisableImagePush    bool
	UpdateCheckEndpoint string
	Namespace           string
	Debug               bool
	Deploy              bool
	DeployVersionLabel  string
	Wait                bool
	Silent              bool
}

type UpgradeRelease

type UpgradeRelease struct {
	Sequence int64  `json:"sequence"`
	Version  string `json:"version"`
}

type UpgradeResponse

type UpgradeResponse struct {
	Success           bool             `json:"success"`
	AvailableUpdates  int64            `json:"availableUpdates"`
	CurrentRelease    *UpgradeRelease  `json:"currentRelease,omitempty"`
	AvailableReleases []UpgradeRelease `json:"availableReleases,omitempty"`
	DeployingRelease  *UpgradeRelease  `json:"deployingRelease,omitempty"`
	Error             string           `json:"error,omitempty"`
}

func Upgrade

func Upgrade(appSlug string, options UpgradeOptions) (*UpgradeResponse, error)

type UpstreamSettings

type UpstreamSettings struct {
	Namespace              string
	SharedPassword         string
	SharedPasswordBcrypt   string
	S3AccessKey            string
	S3SecretKey            string
	JWT                    string
	PostgresPassword       string
	APIEncryptionKey       string
	HTTPProxyEnvValue      string
	HTTPSProxyEnvValue     string
	NoProxyEnvValue        string
	AutoCreateClusterToken string
	IsOpenShift            bool
	IncludeMinio           bool
	IsMinimalRBAC          bool
	AdditionalNamespaces   []string
}