Documentation
¶
Overview ¶
Package app coordinates Application discovery, planning, rendering, and desired-state diff operations.
Index ¶
- Constants
- func ApplyDestinationNamespace(application argoappv1.Application, obj *unstructured.Unstructured)
- func IsBuiltInClusterScoped(gvk schema.GroupVersionKind) bool
- func SelectApplicationByName(apps []argoappv1.Application, target string) (argoappv1.Application, error)
- func SelectChangedApplicationInputs(inputs []ApplicationSelectionInput, changedPaths []string) ([]argoappv1.Application, []string)
- func SelectChangedApplications(apps []argoappv1.Application, changedPaths []string) ([]argoappv1.Application, []string)
- func SelectOptionalApplicationByName(apps []argoappv1.Application, target string) (argoappv1.Application, bool, error)
- type AcquisitionOptions
- type ApplicationManifest
- type ApplicationRenderOptions
- type ApplicationSelectionInput
- type ApplicationSelector
- type ApplicationSetOptions
- type ApplicationStatus
- type ApplicationStatusCallback
- type ApplicationStatusEvent
- type BuildAppRequest
- type BuildRequest
- type BuildResult
- type DiagRequest
- type DiagResult
- type DiffAppRequest
- type DiffRequest
- type DiffResult
- type DiscoveryOptions
- type ExecutionOptions
- type FilterOptions
- type ImageDiffResult
- type Orchestrator
- func (o Orchestrator) Build(ctx context.Context, request BuildRequest) (BuildResult, error)
- func (o Orchestrator) BuildApp(ctx context.Context, request BuildAppRequest) (BuildResult, error)
- func (o Orchestrator) BuildSelection(ctx context.Context, request BuildRequest, selectApps ApplicationSelector) (BuildResult, error)
- func (o Orchestrator) Diag(ctx context.Context, request DiagRequest) (DiagResult, error)
- func (o Orchestrator) DiffApp(ctx context.Context, request DiffAppRequest) (DiffResult, error)
- func (o Orchestrator) DiffApps(ctx context.Context, request DiffRequest) (DiffResult, error)
- func (o Orchestrator) DiffImages(ctx context.Context, request DiffRequest) (ImageDiffResult, error)
- func (o Orchestrator) ListApplications(ctx context.Context, request BuildRequest) (BuildResult, error)
- type PlanResult
- type PluginExecution
- type PluginOptions
- type RenderResult
- type SourcePlan
- type StaticRenderers
- type TrackingOptions
Constants ¶
View Source
const ( DiscoveryModeFleet = "fleet" DiscoveryModeStatic = "static" DefaultMaxDiscoveryDepth = 4 )
View Source
const ( ApplicationStatusPass = "PASS" ApplicationStatusFail = "FAIL" ApplicationStatusSkipped = "SKIPPED" )
Variables ¶
This section is empty.
Functions ¶
func ApplyDestinationNamespace ¶
func ApplyDestinationNamespace(application argoappv1.Application, obj *unstructured.Unstructured)
func IsBuiltInClusterScoped ¶
func IsBuiltInClusterScoped(gvk schema.GroupVersionKind) bool
func SelectApplicationByName ¶
func SelectApplicationByName(apps []argoappv1.Application, target string) (argoappv1.Application, error)
func SelectChangedApplicationInputs ¶
func SelectChangedApplicationInputs(inputs []ApplicationSelectionInput, changedPaths []string) ([]argoappv1.Application, []string)
SelectChangedApplicationInputs returns Applications whose explicit inputs or declared local source paths intersect at least one changed path.
func SelectChangedApplications ¶
func SelectChangedApplications(apps []argoappv1.Application, changedPaths []string) ([]argoappv1.Application, []string)
SelectChangedApplications returns Applications whose declared local source paths intersect at least one changed path, plus normalized unowned changes.
func SelectOptionalApplicationByName ¶
func SelectOptionalApplicationByName(apps []argoappv1.Application, target string) (argoappv1.Application, bool, error)
Types ¶
type AcquisitionOptions ¶ added in v0.1.5
type AcquisitionOptions struct {
Offline bool
RefreshCharts bool
ChartCacheDir string
ChartCredentials chart.ChartCredentials
RepoMaps []sourcepkg.RepoMap
GitCacheDir string
RefreshGit bool
GitCredentials sourcepkg.GitCredentials
RefreshRemoteResources bool
RemoteResourceCacheDir string
RemoteResourceForbiddenRoots []string
RemoteResourceCredentials remote.Credentials
RemoteResourceGitCredentials remote.GitCredentials
RecordCacheEvents bool
}
type ApplicationManifest ¶
type ApplicationManifest struct {
Application argoappv1.Application
Manifest render.Manifest
}
type ApplicationRenderOptions ¶ added in v0.1.7
type ApplicationRenderOptions struct {
PluginOptions PluginOptions
TrackingOptions TrackingOptions
}
type ApplicationSelectionInput ¶
type ApplicationSelectionInput struct {
Application argoappv1.Application
Paths []string
}
type ApplicationSelector ¶ added in v0.1.21
type ApplicationSelector func([]argoappv1.Application) []argoappv1.Application
type ApplicationSetOptions ¶ added in v0.1.5
type ApplicationSetOptions struct {
ApplicationSetProviderFixtures []string
ApplicationSetProviderData appset.ProviderData
}
type ApplicationStatus ¶
type ApplicationStatusCallback ¶
type ApplicationStatusCallback func(ApplicationStatusEvent) error
type ApplicationStatusEvent ¶
type ApplicationStatusEvent struct {
Status ApplicationStatus
Completed int
Total int
}
type BuildAppRequest ¶
type BuildAppRequest struct {
BuildRequest
Name string
}
type BuildRequest ¶
type BuildRequest struct {
Path string
Strict bool
ProjectDiagnosticsMode diagnostic.ProjectDiagnosticsMode
// StatusOnly renders Applications for validation without retaining manifests.
StatusOnly bool
DiscoveryOptions
ValidateLuaHealth bool
AcquisitionOptions
PluginOptions
ExecutionOptions
FilterOptions
PluginRenderer render.PluginRenderer
Applications []argoappv1.Application
ApplicationSetOptions
StatusCallback ApplicationStatusCallback
// contains filtered or unexported fields
}
type BuildResult ¶
type BuildResult struct {
Applications []argoappv1.Application
ApplicationInputs []ApplicationSelectionInput
Projects []argoappv1.AppProject
Manifests []render.Manifest
ApplicationManifests []ApplicationManifest
Diagnostics []diagnostic.Diagnostic
Settings config.ArgoSettings
Statuses []ApplicationStatus
CacheEvents []cacheevent.Event
PluginExecutions []PluginExecution
// contains filtered or unexported fields
}
type DiagRequest ¶
type DiagRequest = BuildRequest
type DiagResult ¶
type DiagResult struct {
Applications []argoappv1.Application
Diagnostics []diagnostic.Diagnostic
Settings config.ArgoSettings
CacheEvents []cacheevent.Event
PluginExecutions []PluginExecution
}
type DiffAppRequest ¶
type DiffAppRequest struct {
DiffRequest
Name string
}
type DiffRequest ¶
type DiffRequest struct {
LeftPath string
RightPath string
Repo string
Ref string
RefOrig string
DiscoveryOptions
ChangedOnly bool
StrictChangedOnly bool
ChangedOnlyIncludeGlobs []string
ChangedOnlyIgnoreGlobs []string
Strict bool
ProjectDiagnosticsMode diagnostic.ProjectDiagnosticsMode
Unified int
StripAttrs []string
ShowIgnoredFields bool
AcquisitionOptions
PluginOptions
ExecutionOptions
FilterOptions
ApplicationSetOptions
// contains filtered or unexported fields
}
type DiffResult ¶
type DiffResult struct {
Results []diff.Result
Diagnostics []diagnostic.Diagnostic
CacheEvents []cacheevent.Event
}
type DiscoveryOptions ¶ added in v0.1.5
type ExecutionOptions ¶ added in v0.1.5
type ExecutionOptions struct {
Parallelism int
}
type FilterOptions ¶ added in v0.1.5
type ImageDiffResult ¶
type ImageDiffResult struct {
Added []string
Removed []string
Unchanged []string
Diagnostics []diagnostic.Diagnostic
CacheEvents []cacheevent.Event
}
type Orchestrator ¶
type Orchestrator struct {
ChartAcquirer chart.Acquirer
GitAcquirer sourcepkg.GitAcquirer
RemoteResourceAcquirer remote.Acquirer
PluginRenderer render.PluginRenderer
PluginExecRunner pluginexec.Runner
PluginContainerRunner plugincontainer.Runner
}
func (Orchestrator) Build ¶
func (o Orchestrator) Build(ctx context.Context, request BuildRequest) (BuildResult, error)
func (Orchestrator) BuildApp ¶
func (o Orchestrator) BuildApp(ctx context.Context, request BuildAppRequest) (BuildResult, error)
func (Orchestrator) BuildSelection ¶ added in v0.1.21
func (o Orchestrator) BuildSelection(ctx context.Context, request BuildRequest, selectApps ApplicationSelector) (BuildResult, error)
BuildSelection lists Applications, narrows them with selectApps, and builds the selection while reusing the list phase's discovery and render caches.
func (Orchestrator) Diag ¶
func (o Orchestrator) Diag(ctx context.Context, request DiagRequest) (DiagResult, error)
func (Orchestrator) DiffApp ¶
func (o Orchestrator) DiffApp(ctx context.Context, request DiffAppRequest) (DiffResult, error)
func (Orchestrator) DiffApps ¶
func (o Orchestrator) DiffApps(ctx context.Context, request DiffRequest) (DiffResult, error)
func (Orchestrator) DiffImages ¶
func (o Orchestrator) DiffImages(ctx context.Context, request DiffRequest) (ImageDiffResult, error)
func (Orchestrator) ListApplications ¶
func (o Orchestrator) ListApplications(ctx context.Context, request BuildRequest) (BuildResult, error)
type PlanResult ¶
type PlanResult struct {
Application argoappv1.Application
Sources []SourcePlan
Refs map[string]SourcePlan
}
func Plan ¶
func Plan(application argoappv1.Application) (PlanResult, error)
type PluginExecution ¶ added in v0.1.6
type PluginExecution struct {
AppNamespace string `json:"appNamespace" yaml:"appNamespace"`
AppName string `json:"appName" yaml:"appName"`
SourceIndex int `json:"sourceIndex" yaml:"sourceIndex"`
SourceName string `json:"sourceName,omitempty" yaml:"sourceName,omitempty"`
SourcePath string `json:"sourcePath,omitempty" yaml:"sourcePath,omitempty"`
PluginName string `json:"pluginName" yaml:"pluginName"`
Engine string `json:"engine" yaml:"engine"`
Runtime string `json:"runtime,omitempty" yaml:"runtime,omitempty"`
Image string `json:"image,omitempty" yaml:"image,omitempty"`
Phase string `json:"phase" yaml:"phase"`
Command string `json:"command" yaml:"command"`
Duration string `json:"duration" yaml:"duration"`
}
type PluginOptions ¶ added in v0.1.5
type RenderResult ¶
type RenderResult struct {
Manifests []render.Manifest
Diagnostics []diagnostic.Diagnostic
PluginExecutions []PluginExecution
}
func RenderApplication ¶
func RenderApplication(ctx context.Context, application argoappv1.Application, provider render.Provider, pluginOptions ...PluginOptions) (RenderResult, error)
func RenderApplicationWithOptions ¶ added in v0.1.7
func RenderApplicationWithOptions(ctx context.Context, application argoappv1.Application, provider render.Provider, options ApplicationRenderOptions) (RenderResult, error)
type SourcePlan ¶
type SourcePlan struct {
Index int
Name string
RefKey string
Source argoappv1.ApplicationSource
SourceRoot string
RefOnly bool
ExplicitType argoappv1.ApplicationSourceType
}
type StaticRenderers ¶
func (StaticRenderers) RenderSource ¶
func (s StaticRenderers) RenderSource(_ context.Context, source render.ResolvedSource, _ render.RenderOptions) ([]render.Manifest, []diagnostic.Diagnostic, error)
Source Files
¶
- build_session.go
- build_session_validation.go
- build_side.go
- cmp_auto_discovery.go
- diff.go
- diff_concurrent.go
- diff_normalization.go
- diff_side.go
- discovery.go
- discovery_appset.go
- discovery_bootstrap.go
- discovery_frontier.go
- discovery_keys.go
- discovery_memo.go
- discovery_merge.go
- discovery_paths.go
- discovery_signature.go
- doc.go
- local_provider.go
- local_provider_builder.go
- local_provider_chart.go
- local_provider_helpers.go
- local_provider_paths.go
- local_provider_plugin.go
- local_provider_sources.go
- named.go
- native_kustomize_cmp.go
- normalize.go
- oci_repositories.go
- orchestrator.go
- ordered_parallel.go
- plan.go
- plugin_parameters.go
- plugin_policy.go
- plugin_policy_match.go
- plugin_render_container.go
- plugin_render_exec.go
- plugin_render_native.go
- plugin_render_plan.go
- project_diagnostics.go
- ref_roots.go
- render.go
- render_cache.go
- request_options.go
- select.go
- settings_load.go
- source_overrides.go
- tracking.go
Click to show internal directories.
Click to hide internal directories.