app

Documentation

Index

• Constants
• func DoAppRepoCLIAuth(url string, w io.Writer) (string, error)
• type AddParams
• type App
  • func New(logger logger.Logger, git git.Git, flux flux.Flux, kube kube.Kube, ...) *App
  • func (a *App) Add(params AddParams) error
  • func (a *App) Get(name types.NamespacedName) (*wego.Application, error)
  • func (a *App) GetCommits(params CommitParams) ([]gitprovider.Commit, error)
  • func (a *App) Pause(params PauseParams) error
  • func (a *App) Remove(params RemoveParams) error
  • func (a *App) Status(params StatusParams) (string, string, error)
  • func (a *App) Unpause(params UnpauseParams) error
• type AppResourceInfo
• type AppService
• type CommitParams
• type ConfigMode
• type ConfigType
• type PauseParams
• type RemoveParams
• type ResourceKind
• type ResourceRef
• type StatusParams
• type UnpauseParams

Constants

const (
	ConfigTypeUserRepo ConfigType = ""
	ConfigTypeNone     ConfigType = "NONE"

	ConfigModeClusterOnly  ConfigMode = "clusterOnly"
	ConfigModeUserRepo     ConfigMode = "userRepo"
	ConfigModeExternalRepo ConfigMode = "externalRepo"

	ResourceKindApplication    ResourceKind = "Application"
	ResourceKindSecret         ResourceKind = "Secret"
	ResourceKindGitRepository  ResourceKind = "GitRepository"
	ResourceKindHelmRepository ResourceKind = "HelmRepository"
	ResourceKindKustomization  ResourceKind = "Kustomization"
	ResourceKindHelmRelease    ResourceKind = "HelmRelease"

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

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

Functions

func DoAppRepoCLIAuth

func DoAppRepoCLIAuth(url string, w io.Writer) (string, error)

DoAppRepoCLIAuth is a helper function that encapsulates the CLI auth flow. This is meant to be re-used in whichever commands need to authenticate with a Git Provider.

Types

type AddParams

type AddParams struct {
	Dir                        string
	Name                       string
	Url                        string
	Path                       string
	Branch                     string
	PrivateKey                 string
	DeploymentType             string
	Chart                      string
	SourceType                 wego.SourceType
	AppConfigUrl               string
	Namespace                  string
	DryRun                     bool
	AutoMerge                  bool
	GitProviderToken           string
	HelmReleaseTargetNamespace string
}

type App

type App struct {
	// contains filtered or unexported fields
}

func New

func New(logger logger.Logger, git git.Git, flux flux.Flux, kube kube.Kube, osys osys.Osys) *App

func (*App) Add

func (a *App) Add(params AddParams) error

func (*App) Get

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

func (*App) GetCommits

func (a *App) GetCommits(params CommitParams) ([]gitprovider.Commit, error)

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

func (*App) Pause

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

func (*App) Remove

func (a *App) Remove(params RemoveParams) error

Remove removes the Weave GitOps automation for an application

func (*App) Status

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

func (*App) Unpause

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

type AppResourceInfo

type AppResourceInfo struct {
	wego.Application
	// contains filtered or unexported fields
}

type AppService

type AppService interface {
	// Add adds a new application to the cluster
	Add(params AddParams) error
	// Get returns a given applicaiton
	Get(name types.NamespacedName) (*wego.Application, error)
	// Remove removes an application from the cluster
	Remove(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
}

AppService entity that manages applications

type CommitParams

type CommitParams struct {
	Name             string
	Namespace        string
	GitProviderToken string
}

type ConfigMode

type ConfigMode string

type ConfigType

type ConfigType string

type PauseParams

type PauseParams struct {
	Name      string
	Namespace string
}

type RemoveParams

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

type ResourceKind

type ResourceKind string

type ResourceRef

type ResourceRef struct {
	// contains filtered or unexported fields
}

type StatusParams

type StatusParams struct {
	Namespace string
	Name      string
}

type UnpauseParams

type UnpauseParams struct {
	Name      string
	Namespace string
}