Documentation
¶
Index ¶
- Constants
- type App
- type AppMeta
- type Apps
- type Change
- type ChangeImpl
- type ChangeMeta
- type LabeledApp
- func (a *LabeledApp) BeginChange(ChangeMeta) (Change, error)
- func (a *LabeledApp) Changes() ([]Change, error)
- func (a *LabeledApp) CreateOrUpdate(labels map[string]string) error
- func (a *LabeledApp) Delete() error
- func (a *LabeledApp) Exists() (bool, error)
- func (a *LabeledApp) GCChanges(max int, reviewFunc func(changesToDelete []Change) error) (int, int, error)
- func (a *LabeledApp) LabelSelector() (labels.Selector, error)
- func (a *LabeledApp) LastChange() (Change, error)
- func (a *LabeledApp) Meta() (AppMeta, error)
- func (a *LabeledApp) Name() string
- func (a *LabeledApp) Namespace() string
- func (a *LabeledApp) Rename(_ string) error
- type NoopChange
- type Preparation
- type PrepareResourcesOpts
- type RecordedApp
- func (a *RecordedApp) BeginChange(meta ChangeMeta) (Change, error)
- func (a *RecordedApp) Changes() ([]Change, error)
- func (a *RecordedApp) CreateOrUpdate(labels map[string]string) error
- func (a *RecordedApp) Delete() error
- func (a *RecordedApp) Exists() (bool, error)
- func (a *RecordedApp) GCChanges(max int, reviewFunc func(changesToDelete []Change) error) (int, int, error)
- func (a *RecordedApp) LabelSelector() (labels.Selector, error)
- func (a *RecordedApp) LastChange() (Change, error)
- func (a *RecordedApp) Meta() (AppMeta, error)
- func (a *RecordedApp) Name() string
- func (a *RecordedApp) Namespace() string
- func (a *RecordedApp) Rename(newName string) error
- type RecordedAppChanges
- type Touch
Constants ¶
View Source
const (
AppChangesMaxToKeepDefault = 200
)
View Source
const (
KappIsAppLabelKey = "kapp.k14s.io/is-app"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type App ¶
type App interface {
Name() string
Namespace() string
Meta() (AppMeta, error)
LabelSelector() (labels.Selector, error)
CreateOrUpdate(map[string]string) error
Exists() (bool, error)
Delete() error
Rename(string) error
// Sorted as first is oldest
Changes() ([]Change, error)
LastChange() (Change, error)
BeginChange(ChangeMeta) (Change, error)
GCChanges(max int, reviewFunc func(changesToDelete []Change) error) (int, int, error)
}
type AppMeta ¶
type AppMeta struct {
LabelKey string `json:"labelKey"`
LabelValue string `json:"labelValue"`
LastChangeName string `json:"lastChangeName,omitempty"`
LastChange ChangeMeta `json:"lastChange,omitempty"`
}
type Apps ¶
type Apps struct {
// contains filtered or unexported fields
}
func NewApps ¶
func NewApps(nsName string, coreClient kubernetes.Interface, identifiedResources ctlres.IdentifiedResources, logger logger.Logger) Apps
type Change ¶
type Change interface {
Name() string
Meta() ChangeMeta
Fail() error
Succeed() error
Delete() error
}
type ChangeImpl ¶
type ChangeImpl struct {
// contains filtered or unexported fields
}
func (*ChangeImpl) Delete ¶ added in v0.12.0
func (c *ChangeImpl) Delete() error
func (*ChangeImpl) Fail ¶
func (c *ChangeImpl) Fail() error
func (*ChangeImpl) Meta ¶
func (c *ChangeImpl) Meta() ChangeMeta
func (*ChangeImpl) Name ¶
func (c *ChangeImpl) Name() string
func (*ChangeImpl) Succeed ¶
func (c *ChangeImpl) Succeed() error
type ChangeMeta ¶
type ChangeMeta struct {
StartedAt time.Time `json:"startedAt"`
FinishedAt time.Time `json:"finishedAt,omitempty"`
Successful *bool `json:"successful,omitempty"`
Description string `json:"description,omitempty"`
Namespaces []string `json:"namespaces,omitempty"`
}
func NewChangeMetaFromData ¶
func NewChangeMetaFromData(data map[string]string) ChangeMeta
func NewChangeMetaFromString ¶
func NewChangeMetaFromString(data string) ChangeMeta
func (ChangeMeta) AsData ¶
func (m ChangeMeta) AsData() map[string]string
func (ChangeMeta) AsString ¶
func (m ChangeMeta) AsString() string
type LabeledApp ¶
type LabeledApp struct {
// contains filtered or unexported fields
}
func (*LabeledApp) BeginChange ¶
func (a *LabeledApp) BeginChange(ChangeMeta) (Change, error)
func (*LabeledApp) Changes ¶
func (a *LabeledApp) Changes() ([]Change, error)
func (*LabeledApp) CreateOrUpdate ¶
func (a *LabeledApp) CreateOrUpdate(labels map[string]string) error
func (*LabeledApp) Delete ¶
func (a *LabeledApp) Delete() error
func (*LabeledApp) Exists ¶
func (a *LabeledApp) Exists() (bool, error)
func (*LabeledApp) LabelSelector ¶
func (a *LabeledApp) LabelSelector() (labels.Selector, error)
func (*LabeledApp) LastChange ¶
func (a *LabeledApp) LastChange() (Change, error)
func (*LabeledApp) Meta ¶
func (a *LabeledApp) Meta() (AppMeta, error)
func (*LabeledApp) Name ¶
func (a *LabeledApp) Name() string
func (*LabeledApp) Namespace ¶ added in v0.9.0
func (a *LabeledApp) Namespace() string
func (*LabeledApp) Rename ¶ added in v0.11.0
func (a *LabeledApp) Rename(_ string) error
type NoopChange ¶
type NoopChange struct{}
func (NoopChange) Delete ¶ added in v0.12.0
func (NoopChange) Delete() error
func (NoopChange) Fail ¶
func (NoopChange) Fail() error
func (NoopChange) Meta ¶
func (NoopChange) Meta() ChangeMeta
func (NoopChange) Name ¶
func (NoopChange) Name() string
func (NoopChange) Succeed ¶
func (NoopChange) Succeed() error
type Preparation ¶
type Preparation struct {
// contains filtered or unexported fields
}
func NewPreparation ¶
func NewPreparation(resourceTypes ctlres.ResourceTypes, opts PrepareResourcesOpts) Preparation
func (Preparation) PrepareResources ¶
func (Preparation) ValidateResources ¶
func (a Preparation) ValidateResources(resources []ctlres.Resource) error
type PrepareResourcesOpts ¶
type PrepareResourcesOpts struct {
AllowCheck bool
AllowedNamespaces []string
AllowAllNamespaces bool
AllowCluster bool
IntoNamespace string // this ns is allowed automatically
MapNamespaces []string // this ns is allowed automatically
DefaultNamespace string // this ns is allowed automatically
}
func (PrepareResourcesOpts) InAllowedNamespaces ¶
func (o PrepareResourcesOpts) InAllowedNamespaces(ns string) bool
type RecordedApp ¶
type RecordedApp struct {
// contains filtered or unexported fields
}
func (*RecordedApp) BeginChange ¶
func (a *RecordedApp) BeginChange(meta ChangeMeta) (Change, error)
func (*RecordedApp) Changes ¶
func (a *RecordedApp) Changes() ([]Change, error)
func (*RecordedApp) CreateOrUpdate ¶
func (a *RecordedApp) CreateOrUpdate(labels map[string]string) error
func (*RecordedApp) Delete ¶
func (a *RecordedApp) Delete() error
func (*RecordedApp) Exists ¶
func (a *RecordedApp) Exists() (bool, error)
func (*RecordedApp) LabelSelector ¶
func (a *RecordedApp) LabelSelector() (labels.Selector, error)
func (*RecordedApp) LastChange ¶
func (a *RecordedApp) LastChange() (Change, error)
func (*RecordedApp) Meta ¶
func (a *RecordedApp) Meta() (AppMeta, error)
func (*RecordedApp) Name ¶
func (a *RecordedApp) Name() string
func (*RecordedApp) Namespace ¶ added in v0.9.0
func (a *RecordedApp) Namespace() string
func (*RecordedApp) Rename ¶ added in v0.11.0
func (a *RecordedApp) Rename(newName string) error
type RecordedAppChanges ¶
type RecordedAppChanges struct {
// contains filtered or unexported fields
}
func NewRecordedAppChanges ¶
func NewRecordedAppChanges(nsName, appName string, coreClient kubernetes.Interface) RecordedAppChanges
func (RecordedAppChanges) Begin ¶
func (a RecordedAppChanges) Begin(meta ChangeMeta) (*ChangeImpl, error)
func (RecordedAppChanges) DeleteAll ¶
func (a RecordedAppChanges) DeleteAll() error
func (RecordedAppChanges) List ¶
func (a RecordedAppChanges) List() ([]Change, error)
Click to show internal directories.
Click to hide internal directories.