app

Documentation

Index

• Constants
• func CloneRepo(client git.Git, url string, branch string, dryRun bool) (func(), string, error)
• func CommitAndPush(client git.Git, commitMsg string, dryRun bool, logger logger.Logger, ...) error
• func IsClusterReady(l logger.Logger, k kube.Kube) error
• func IsExternalConfigUrl(url string) bool
• type AddParams
• type App
  • func (a *App) Add(params AddParams) error
  • func (a *App) Get(name types.NamespacedName) (*wego.Application, error)
  • func (a *App) GetCommits(params CommitParams, application *wego.Application) ([]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 AppManifest
• type AppResourceInfo
• type AppService
  • func New(ctx context.Context, logger logger.Logger, appGit, configGit git.Git, ...) AppService
• type Automation
• type CommitParams
• type ConfigMode
• type ConfigType
• type GeneratedSecretName
  • func CreateRepoSecretName(targetName string, repoURL string) GeneratedSecretName
  • func (s GeneratedSecretName) String() string
• type PauseParams
• type RemoveParams
• type ResourceKind
  • func (rk ResourceKind) ToGVR() (schema.GroupVersionResource, error)
• type ResourceRef
• type Source
• 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"
	AddCommitMessage      = "Add App manifests"
)

const (
	RemoveCommitMessage = "Remove App manifests"
)

Functions

func CloneRepo

func CloneRepo(client git.Git, url string, branch string, dryRun bool) (func(), string, error)

CloneRepo uses the git client to clone the reop from the URL and branch. It clones into a temp directory and returns a function to use by the caller for cleanup. The temp directory is also returned.

func CommitAndPush

func CommitAndPush(client git.Git, commitMsg string, dryRun bool, logger logger.Logger, filters ...func(string) bool) error

func IsClusterReady

func IsClusterReady(l logger.Logger, k kube.Kube) error

func IsExternalConfigUrl

func IsExternalConfigUrl(url string) bool

Types

type AddParams

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

type App

type App struct {
	Context     context.Context
	Osys        osys.Osys
	AppGit      git.Git
	ConfigGit   git.Git
	Flux        flux.Flux
	Kube        kube.Kube
	Logger      logger.Logger
	GitProvider gitproviders.GitProvider
}

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, application *wego.Application) ([]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 AppManifest

type AppManifest interface {
	ToAppYAML() []byte
}

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)
	// GetCommits returns a list of commits for an application
	GetCommits(params CommitParams, application *wego.Application) ([]gitprovider.Commit, 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

func New

func New(ctx context.Context, logger logger.Logger, appGit, configGit git.Git, gitProvider gitproviders.GitProvider, flux flux.Flux, kube kube.Kube, osys osys.Osys) AppService

type Automation

type Automation interface {
	ToAutomationYAML() []byte
}

type CommitParams

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

type ConfigMode

type ConfigMode string

type ConfigType

type ConfigType string

type GeneratedSecretName

type GeneratedSecretName string

func CreateRepoSecretName

func CreateRepoSecretName(targetName string, repoURL string) GeneratedSecretName

func (GeneratedSecretName) String

func (s GeneratedSecretName) String() string

type PauseParams

type PauseParams struct {
	Name      string
	Namespace string
}

type RemoveParams

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

type ResourceKind

type ResourceKind string

func (ResourceKind) ToGVR

func (rk ResourceKind) ToGVR() (schema.GroupVersionResource, error)

type ResourceRef

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

type Source

type Source interface {
	ToSourceYAML() []byte
}

type StatusParams

type StatusParams struct {
	Namespace string
	Name      string
}

type UnpauseParams

type UnpauseParams struct {
	Name      string
	Namespace string
}