app

Documentation

Index

• Constants
• type AddParams
  • func (a AddParams) IsHelmRepository() bool
• type AppService
  • func New(ctx context.Context, logger logger.Logger, flux flux.Flux, kube kube.Kube, ...) AppService
• type AppSvc
  • func (a *AppSvc) Add(configGit git.Git, gitProvider gitproviders.GitProvider, params AddParams) error
  • func (a *AppSvc) Get(name types.NamespacedName) (*wego.Application, error)
  • func (a *AppSvc) GetCommits(gitProvider gitproviders.GitProvider, params CommitParams, ...) ([]gitprovider.Commit, error)
  • func (a *AppSvc) Pause(params PauseParams) error
  • func (a *AppSvc) Remove(configGit git.Git, gitProvider gitproviders.GitProvider, params RemoveParams) error
  • func (a *AppSvc) Status(params StatusParams) (string, string, error)
  • func (a *AppSvc) Sync(params SyncParams) error
  • func (a *AppSvc) Unpause(params UnpauseParams) error
• type CommitParams
• type PauseParams
• type RemoveParams
• type StatusParams
• type SyncParams
• type UnpauseParams

Constants

const (
	DefaultPath           = "./"
	DefaultBranch         = "main"
	DefaultDeploymentType = "kustomize"
)

const (
	WeGOAppIdentifierLabelKey = "wego.weave.works/app-identifier"
)

Types

type AddParams

type AddParams struct {
	Dir                        string
	Name                       string
	Url                        string
	Path                       string
	Branch                     string
	DeploymentType             string
	Chart                      string
	SourceType                 wego.SourceType
	ConfigRepo                 string
	Namespace                  string
	DryRun                     bool
	AutoMerge                  bool
	GitProviderToken           string
	HelmReleaseTargetNamespace string
	MigrateToNewDirStructure   func(string) string
}

func (AddParams) IsHelmRepository

func (a AddParams) IsHelmRepository() bool

type AppService

type AppService interface {
	// Add adds a new application to the cluster
	Add(configGit git.Git, gitProvider gitproviders.GitProvider, params AddParams) error
	// Get returns a given applicaiton
	Get(name types.NamespacedName) (*wego.Application, error)
	// GetCommits returns a list of commits for an application
	GetCommits(gitProvider gitproviders.GitProvider, params CommitParams, application *wego.Application) ([]gitprovider.Commit, error)
	// Remove removes an application from the cluster
	Remove(configGit git.Git, gitProvider gitproviders.GitProvider, params RemoveParams) error
	// Status returns flux resources status and the last successful reconciliation time
	Status(params StatusParams) (string, string, error)
	// Pause pauses the gitops automation for an app
	Pause(params PauseParams) error
	// Unpause resumes the gitops automation for an app
	Unpause(params UnpauseParams) error
	// Sync trigger reconciliation loop for an application
	Sync(params SyncParams) error
}

AppService entity that manages applications

func New

func New(ctx context.Context, logger logger.Logger, flux flux.Flux, kube kube.Kube, osys osys.Osys) AppService

type AppSvc

type AppSvc struct {
	Context context.Context
	Osys    osys.Osys
	Flux    flux.Flux
	Kube    kube.Kube
	Logger  logger.Logger
	Clock   clock.Clock
}

func (*AppSvc) Add

func (a *AppSvc) Add(configGit git.Git, gitProvider gitproviders.GitProvider, params AddParams) error

func (*AppSvc) Get

func (a *AppSvc) Get(name types.NamespacedName) (*wego.Application, error)

func (*AppSvc) GetCommits

func (a *AppSvc) GetCommits(gitProvider gitproviders.GitProvider, params CommitParams, application *wego.Application) ([]gitprovider.Commit, error)

GetCommits gets a list of commits from the repo/branch saved in the app manifest

func (*AppSvc) Pause

func (a *AppSvc) Pause(params PauseParams) error

func (*AppSvc) Remove

func (a *AppSvc) Remove(configGit git.Git, gitProvider gitproviders.GitProvider, params RemoveParams) error

Remove removes the Weave GitOps automation for an application

func (*AppSvc) Status

func (a *AppSvc) Status(params StatusParams) (string, string, error)

func (*AppSvc) Sync

func (a *AppSvc) Sync(params SyncParams) error

Sync triggers the reconcile loop for an application

func (*AppSvc) Unpause

func (a *AppSvc) Unpause(params UnpauseParams) error

type CommitParams

type CommitParams struct {
	Name             string
	Namespace        string
	GitProviderToken string
	PageSize         int
	PageToken        int
}

type PauseParams

type PauseParams struct {
	Name      string
	Namespace string
}

type RemoveParams

type RemoveParams struct {
	Name             string
	Namespace        string
	DryRun           bool
	AutoMerge        bool
	GitProviderToken string
}

type StatusParams

type StatusParams struct {
	Namespace string
	Name      string
}

type SyncParams

type SyncParams struct {
	Name      string
	Namespace string
}

type UnpauseParams

type UnpauseParams struct {
	Name      string
	Namespace string
}