types

package
v0.41.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 14, 2022 License: MIT Imports: 3 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type App

type App struct {
	ID        string
	Name      string
	Scheduler string
	Slug      string
}

type AppAndChannels

type AppAndChannels struct {
	App      *App
	Channels []Channel
}

type Channel

type Channel struct {
	ID          string
	Name        string
	Description string
	Slug        string

	ReleaseSequence int64
	ReleaseLabel    string

	IsArchived bool `json:"isArchived"`

	InstallCommands *InstallCommands
}

func (*Channel) Copy added in v0.31.0

func (c *Channel) Copy() *Channel

type ChannelRelease added in v0.37.0

type ChannelRelease struct {
	AirgapBuildError  string    `json:"airgapBuildError,omitempty"`
	AirgapBuildStatus string    `json:"airgapBuildStatus,omitempty"`
	ChannelIcon       string    `json:"channelIcon,omitempty"`
	ChannelId         string    `json:"channelId,omitempty"`
	ChannelName       string    `json:"channelName,omitempty"`
	ChannelSequence   int32     `json:"channelSequence,omitempty"`
	Created           time.Time `json:"created,omitempty"`
	RegistrySecret    string    `json:"registrySecret,omitempty"`
	ReleaseNotes      string    `json:"releaseNotes,omitempty"`
	ReleasedAt        time.Time `json:"releasedAt,omitempty"`
	Semver            string    `json:"semver,omitempty"`
	Sequence          int32     `json:"sequence,omitempty"`
	Updated           time.Time `json:"updated,omitempty"`
}

type CollectorInfo added in v0.12.0

type CollectorInfo struct {
	ActiveChannels []Channel
	AppID          string
	CreatedAt      time.Time
	EditedAt       time.Time
	Name           string
	SpecID         string
	Config         string
}

type CreateChannelRequest added in v0.37.0

type CreateChannelRequest struct {
	// Description of the channel that is to be created.
	Description string `json:"description,omitempty"`
	// Enterprise Partner Channel Id to be added to channel.
	EnterprisePartnerChannelID string `json:"enterprisePartnerChannelID,omitempty"`
	Name                       string `json:"name"`
}

type CreateInstallerRequest added in v0.37.0

type CreateInstallerRequest struct {
	Yaml string `json:"yaml"`
}

type Customer added in v0.18.0

type Customer struct {
	ID       string     `json:"id"`
	Name     string     `json:"name"`
	Channels []Channel  `json:"channels"`
	Type     string     `json:"type"`
	Expires  *util.Time `json:"expiresAt"`
}

func (Customer) WithExpiryTime added in v0.18.0

func (c Customer) WithExpiryTime(expiryTime string) (Customer, error)

type CustomerAdoption added in v0.37.0

type CustomerAdoption struct {
	ChannelId       string  `json:"channelId,omitempty"`
	Count           int32   `json:"count,omitempty"`
	Percent         float32 `json:"percent,omitempty"`
	ReleaseSequence int32   `json:"releaseSequence,omitempty"`
	Semver          string  `json:"semver,omitempty"`
	TotalOnChannel  int64   `json:"totalOnChannel,omitempty"`
}

type EntitlementSpec added in v0.11.0

type EntitlementSpec struct {
	ID        string `json:"id,omitempty"`
	Spec      string `json:"spec,omitempty"`
	Name      string `json:"name,omitempty"`
	CreatedAt string `json:"createdAt,omitempty"`
}

type EntitlementValue added in v0.11.0

type EntitlementValue struct {
	Name  string `json:"name,omitempty"`
	Value string `json:"value,omitempty"`
}

type EntitlementValueResponse added in v0.37.0

type EntitlementValueResponse struct {
	ID         string `json:"id,omitempty"`
	SpecID     string `json:"specId,omitempty"`
	CustomerID string `json:"customerId,omitempty"`
	Key        string `json:"key,omitempty"`
	Value      string `json:"value,omitempty"`
}

type InstallCommands added in v0.31.0

type InstallCommands struct {
	Existing string
	Embedded string
	Airgap   string
}

type InstallerSpec added in v0.21.0

type InstallerSpec struct {
	AppID           string    `json:"appId"`
	KurlInstallerID string    `json:"kurlInstallerID"`
	Sequence        int64     `json:"sequence"`
	YAML            string    `json:"yaml"`
	ActiveChannels  []Channel `json:"channels"`
	CreatedAt       util.Time `json:"created"`
	CreatedAtString string    `json:"createdAt"`
	Immutable       bool      `json:"isInstallerNotEditable"`
}

type InstallerSpecResponse added in v0.37.0

type InstallerSpecResponse struct {
	Body InstallerSpec `json:"installer"`
}

type KotsAppChannel added in v0.37.0

type KotsAppChannel struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

type KotsAppRelease added in v0.33.2

type KotsAppRelease struct {
	AppID                string     `json:"appId"`
	Sequence             int64      `json:"sequence"`
	CreatedAt            time.Time  `json:"created"`
	IsArchived           bool       `json:"isArchived"`
	Spec                 string     `json:"spec"`
	ReleaseNotes         string     `json:"releaseNotes"`
	IsReleaseNotEditable bool       `json:"isReleaseNotEditable"`
	Channels             []*Channel `json:"channels"`
}

type KotsAppWithChannels added in v0.37.0

type KotsAppWithChannels struct {
	Channels    []Channel `json:"channels,omitempty"`
	Created     time.Time `json:"created,omitempty"`
	Description string    `json:"description,omitempty"`
	Id          string    `json:"id,omitempty"`
	IsArchived  bool      `json:"isArchived,omitempty"`
	IsKotsApp   bool      `json:"isKotsApp,omitempty"`
	Name        string    `json:"name,omitempty"`
	RenamedAt   time.Time `json:"renamedAt,omitempty"`
	Slug        string    `json:"slug,omitempty"`
	TeamId      string    `json:"teamId,omitempty"`
}

type KotsChannel added in v0.37.0

type KotsChannel struct {
	AdoptionRate               []CustomerAdoption            `json:"adoptionRate,omitempty"`
	AppId                      string                        `json:"appId,omitempty"`
	BuildAirgapAutomatically   bool                          `json:"buildAirgapAutomatically,omitempty"`
	ChannelIcon                string                        `json:"channelIcon,omitempty"`
	ChannelSequence            int32                         `json:"channelSequence,omitempty"`
	ChannelSlug                string                        `json:"channelSlug,omitempty"`
	Created                    time.Time                     `json:"created,omitempty"`
	CurrentVersion             string                        `json:"currentVersion,omitempty"`
	Customers                  *TotalActiveInactiveCustomers `json:"customers,omitempty"`
	Description                string                        `json:"description,omitempty"`
	EnterprisePartnerChannelID string                        `json:"enterprisePartnerChannelID,omitempty"`
	Id                         string                        `json:"id,omitempty"`
	IsArchived                 bool                          `json:"isArchived,omitempty"`
	IsDefault                  bool                          `json:"isDefault,omitempty"`
	Name                       string                        `json:"name,omitempty"`
	NumReleases                int32                         `json:"numReleases,omitempty"`
	ReleaseNotes               string                        `json:"releaseNotes,omitempty"`
	// TODO: set these (see kotsChannelToSchema function)
	ReleaseSequence int32            `json:"releaseSequence,omitempty"`
	Releases        []ChannelRelease `json:"releases,omitempty"`
	Updated         time.Time        `json:"updated,omitempty"`
}

type KotsCreateReleaseRequest added in v0.36.1

type KotsCreateReleaseRequest struct {
	SpecGzip []byte `json:"spec_gzip"`
}

type KotsGetReleaseResponse added in v0.36.1

type KotsGetReleaseResponse struct {
	Release KotsAppRelease `json:"release"`
}

type KotsListReleasesResponse added in v0.36.1

type KotsListReleasesResponse struct {
	Releases []*KotsAppRelease `json:"releases"`
}

KotsListReleasesResponse contains the JSON releases list

type KotsPromoteReleaseRequest added in v0.37.0

type KotsPromoteReleaseRequest struct {
	ReleaseNotes   string   `json:"releaseNotes"`
	VersionLabel   string   `json:"versionLabel"`
	IsRequired     bool     `json:"isRequired"`
	ChannelIDs     []string `json:"channelIds"`
	IgnoreWarnings bool     `json:"ignoreWarnings"`
}

type KotsUpdateReleaseRequest added in v0.36.1

type KotsUpdateReleaseRequest struct {
	SpecGzip []byte `json:"spec_gzip"`
}

type LintLinePosition added in v0.8.0

type LintLinePosition struct {
	Position int64 `json:"position"`
	Line     int64 `json:"line"`
	Column   int64 `json:"column"`
}

type LintMessage added in v0.8.0

type LintMessage struct {
	Rule      string          `json:"rule"`
	Type      string          `json:"type"`
	Path      string          `json:"path"`
	Message   string          `json:"message"`
	Positions []*LintPosition `json:"positions"`
}

type LintPosition added in v0.8.0

type LintPosition struct {
	Path  string           `json:"path"`
	Start LintLinePosition `json:"start"`
	End   LintLinePosition `json:"end"`
}

type ListInstallersResponse added in v0.37.1

type ListInstallersResponse struct {
	Body []InstallerSpec `json:"installers"`
}

type PlatformChannel added in v0.12.0

type PlatformChannel struct {
	ID   string
	Name string
}

type PromoteInstallerRequest added in v0.37.0

type PromoteInstallerRequest struct {
	Sequence     int64  `json:"sequence"`
	VersionLabel string `json:"versionLabel"`
	ChannelID    string `json:"channelId"`
}

type Registry added in v0.40.4

type Registry struct {
	Provider   string     `json:"provider"`
	Endpoint   string     `json:"endpoint"`
	AuthType   string     `json:"authType"`
	Username   string     `json:"username"`
	LastUsedAt *time.Time `json:"lastUsedAt"`
}

type RegistryLog added in v0.40.4

type RegistryLog struct {
	CreatedAt string  `json:"createdAt"`
	Action    string  `json:"action"`
	Status    *int    `json:"statusCode"`
	Success   bool    `json:"isSuccess"`
	Image     *string `json:"image"`
}

type ReleaseInfo

type ReleaseInfo struct {
	ActiveChannels []Channel
	AppID          string
	CreatedAt      time.Time
	EditedAt       time.Time
	Editable       bool
	Sequence       int64
	Version        string
}

type TotalActiveInactiveCustomers added in v0.37.0

type TotalActiveInactiveCustomers struct {
	ActiveCustomers   int64 `json:"activeCustomers,omitempty"`
	InactiveCustomers int64 `json:"inactiveCustomers,omitempty"`
	TotalCustomers    int64 `json:"totalCustomers,omitempty"`
}

type UpdateChannelRequest added in v0.38.0

type UpdateChannelRequest struct {
	// Description of the channel that is to be created.
	Name           string `json:"name"`
	SemverRequired bool   `json:"semverRequired,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL