argo

package
v3.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 17, 2025 License: Apache-2.0 Imports: 35 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	EventReasonStatusRefreshed    = "StatusRefreshed"
	EventReasonResourceCreated    = "ResourceCreated"
	EventReasonResourceUpdated    = "ResourceUpdated"
	EventReasonResourceDeleted    = "ResourceDeleted"
	EventReasonResourceActionRan  = "ResourceActionRan"
	EventReasonOperationStarted   = "OperationStarted"
	EventReasonOperationCompleted = "OperationCompleted"
)
View Source 
const (
	TrackingMethodAnnotation         v1alpha1.TrackingMethod = "annotation"
	TrackingMethodLabel              v1alpha1.TrackingMethod = "label"
	TrackingMethodAnnotationAndLabel v1alpha1.TrackingMethod = "annotation+label"
)
View Source 
const (
	ErrDestinationMissing = "Destination server missing from app spec"
)

Variables

View Source 
var (
	WrongResourceTrackingFormat = errors.New("wrong resource tracking format, should be <application-name>:<group>/<kind>:<namespace>/<name>")
	LabelMaxLength              = 63
	OkEndPattern                = regexp.MustCompile("[a-zA-Z0-9]$")
)
View Source 
var ErrAnotherOperationInProgress = status.Errorf(codes.FailedPrecondition, "another operation is already in progress")

Functions

func APIResourcesToStrings 

func APIResourcesToStrings(resources []kube.APIResourceInfo, includeKinds bool) []string

APIResourcesToStrings converts list of API Resources list into string list

func AppInstanceName 

func AppInstanceName(appName, appNs, defaultNs string) string

AppInstanceName returns the value to be used for app instance labels from the combination of appName, appNs and defaultNs.

func AugmentSyncMsg 

func AugmentSyncMsg(res common.ResourceSyncResult, apiResourceInfoGetter func() ([]kube.APIResourceInfo, error)) (string, error)

AugmentSyncMsg enrich the K8s message with user-relevant information

func ContainsSyncResource 

func ContainsSyncResource(name string, namespace string, gvk schema.GroupVersionKind, rr []argoappv1.SyncOperationResource) bool

ContainsSyncResource determines if the given resource exists in the provided slice of sync operation resources.

func DefaultEnableEventList 

func DefaultEnableEventList() []string

func ErrProjectNotPermitted 

func ErrProjectNotPermitted(appName, appNamespace, projName string) error

ErrProjectNotPermitted returns an error to indicate that an application identified by appName and appNamespace is not allowed to use the project identified by projName.

func FilterAppSetsByProjects 

func FilterAppSetsByProjects(appsets []argoappv1.ApplicationSet, projects []string) []argoappv1.ApplicationSet

FilterAppSetsByProjects returns applications which belongs to the specified project

func FilterByCluster 

func FilterByCluster(apps []argoappv1.Application, cluster string) []argoappv1.Application

FilterByCluster returns an application

func FilterByName 

func FilterByName(apps []argoappv1.Application, name string) ([]argoappv1.Application, error)

FilterByName returns an application

func FilterByNameP 

func FilterByNameP(apps []*argoappv1.Application, name string) []*argoappv1.Application

FilterByNameP returns pointer applications This function is for the changes in #12985.

func FilterByProjects 

func FilterByProjects(apps []argoappv1.Application, projects []string) []argoappv1.Application

FilterByProjects returns applications which belongs to the specified project

func FilterByProjectsP 

func FilterByProjectsP(apps []*argoappv1.Application, projects []string) []*argoappv1.Application

FilterByProjectsP returns application pointers which belongs to the specified project

func FilterByRepo 

func FilterByRepo(apps []argoappv1.Application, repo string) []argoappv1.Application

FilterByRepo returns an application

func FilterByRepoP 

func FilterByRepoP(apps []*argoappv1.Application, repo string) []*argoappv1.Application

FilterByRepoP returns application pointers

func FormatAppConditions 

func FormatAppConditions(conditions []argoappv1.ApplicationCondition) string

FormatAppConditions returns string representation of give app condition list

func GenerateSpecIsDifferentErrorMessage 

func GenerateSpecIsDifferentErrorMessage(entity string, a, b any) string

func GetAppEventLabels 

func GetAppEventLabels(ctx context.Context, app *argoappv1.Application, projLister applicationsv1.AppProjectLister, ns string, settingsManager *settings.SettingsManager, db db.ArgoDB) map[string]string

GetAppEventLabels returns a map of labels to add to a K8s event. The Application and its AppProject labels are compared against the `resource.includeEventLabelKeys` key in argocd-cm. If matched, the corresponding labels are returned to be added to the generated event. In case of a conflict between labels on the Application and AppProject, the Application label values are prioritized and added to the event. Furthermore, labels specified in `resource.excludeEventLabelKeys` in argocd-cm are removed from the event labels, if they were included.

func GetAppProject 

func GetAppProject(ctx context.Context, app *argoappv1.Application, projLister applicationsv1.AppProjectLister, ns string, settingsManager *settings.SettingsManager, db db.ArgoDB) (*argoappv1.AppProject, error)

GetAppProject returns a project from an application. It will also ensure that the application is allowed to use the project.

func GetAppProjectByName 

func GetAppProjectByName(ctx context.Context, name string, projLister applicationsv1.AppProjectLister, ns string, settingsManager *settings.SettingsManager, db db.ArgoDB) (*argoappv1.AppProject, error)

GetAppProjectByName returns a project from an application based on name

func GetAppProjectWithScopedResources 

func GetAppProjectWithScopedResources(ctx context.Context, name string, projLister applicationsv1.AppProjectLister, ns string, settingsManager *settings.SettingsManager, db db.ArgoDB) (*argoappv1.AppProject, argoappv1.Repositories, []*argoappv1.Cluster, error)

GetAppProjectWithScopedResources returns a project from an application with scoped resources

func GetAppVirtualProject 

func GetAppVirtualProject(proj *argoappv1.AppProject, projLister applicationsv1.AppProjectLister, settingsManager *settings.SettingsManager) (*argoappv1.AppProject, error)

func GetDestinationCluster 

func GetDestinationCluster(ctx context.Context, destination argoappv1.ApplicationDestination, db ClusterGetter) (*argoappv1.Cluster, error)

GetDestinationCluster returns the cluster object based on the destination server or name. If both are provided or both are empty, an error is returned. If the destination server is provided, the cluster is fetched by the server URL. If the destination name is provided, the cluster is fetched by the name. If multiple clusters have the specified name, an error is returned.

func GetDifferentPathsBetweenStructs 

func GetDifferentPathsBetweenStructs(a, b any) ([]string, error)

func GetGlobalProjects 

func GetGlobalProjects(proj *argoappv1.AppProject, projLister applicationsv1.AppProjectLister, settingsManager *settings.SettingsManager) []*argoappv1.AppProject

func GetPermittedRepos 

func GetPermittedRepos(proj *argoappv1.AppProject, repos []*argoappv1.Repository) ([]*argoappv1.Repository, error)

func GetPermittedReposCredentials 

func GetPermittedReposCredentials(proj *argoappv1.AppProject, repoCreds []*argoappv1.RepoCreds) ([]*argoappv1.RepoCreds, error)

func GetRefSources 

func GetRefSources(ctx context.Context, sources argoappv1.ApplicationSources, project string, getRepository func(ctx context.Context, url string, project string) (*argoappv1.Repository, error), revisions []string, isRollback bool) (argoappv1.RefTargetRevisionMapping, error)

GetRefSources creates a map of ref keys (from the sources' 'ref' fields) to information about the referenced source. This function also validates the references use allowed characters and does not define the same ref key more than once (which would lead to ambiguous references).

func GetTrackingMethod 

func GetTrackingMethod(settingsMgr *settings.SettingsManager) v1alpha1.TrackingMethod

GetTrackingMethod retrieve tracking method from settings

func IncludeResource 

func IncludeResource(resourceName string, resourceNamespace string, gvk schema.GroupVersionKind,
	syncOperationResources []*argoappv1.SyncOperationResource,
) bool

IncludeResource The app resource is checked against the include or exclude filters. If exclude filters are present, they are evaluated only after all include filters have been assessed.

func InstanceNameFromQualified 

func InstanceNameFromQualified(name string, defaultNs string) string

InstanceNameFromQualified returns the value to be used for app

func IsOldTrackingMethod 

func IsOldTrackingMethod(trackingMethod string) bool

func IsValidAppName 

func IsValidAppName(name string) bool

IsValidAppName checks if the name can be used as application name

func IsValidContainerName 

func IsValidContainerName(name string) bool

IsValidContainerName checks that a containerName is valid

func IsValidNamespaceName 

func IsValidNamespaceName(name string) bool

IsValidNamespaceName checks that a namespace name is valid

func IsValidPodName 

func IsValidPodName(name string) bool

IsValidPodName checks that a podName is valid

func IsValidProjectName 

func IsValidProjectName(name string) bool

IsValidProjectName checks if the name can be used as project name

func NormalizeApplicationSpec 

func NormalizeApplicationSpec(spec *argoappv1.ApplicationSpec) *argoappv1.ApplicationSpec

NormalizeApplicationSpec will normalize an application spec to a preferred state. This is used for migrating application objects which are using deprecated legacy fields into the new fields, and defaulting fields in the spec (e.g. spec.project)

func NormalizeSource 

func NormalizeSource(source *argoappv1.ApplicationSource) *argoappv1.ApplicationSource

func ParseFromQualifiedName 

func ParseFromQualifiedName(qualifiedAppName string, defaultNs string) (appName string, appNamespace string)

ParseAppNamespacedName parses a namespaced name in the format namespace/name and returns the components. If name wasn't namespaced, defaultNs will be returned as namespace component.

func ParseInstanceName 

func ParseInstanceName(appName string, defaultNs string) (string, string)

ParseInstanceName parses a namespaced name in the format namespace_name and returns the components. If name wasn't namespaced, defaultNs will be returned as namespace component.

func RefreshApp 

func RefreshApp(appIf v1alpha1.ApplicationInterface, name string, refreshType argoappv1.RefreshType, hydrate bool) (*argoappv1.Application, error)

RefreshApp updates the refresh annotation of an application to coerce the controller to process it

func SetAppOperation 

func SetAppOperation(appIf v1alpha1.ApplicationInterface, appName string, op *argoappv1.Operation) (*argoappv1.Application, error)

SetAppOperation updates an application with the specified operation, retrying conflict errors

func TestRepoWithKnownType 

func TestRepoWithKnownType(ctx context.Context, repoClient apiclient.RepoServerServiceClient, repo *argoappv1.Repository, isHelm bool, isHelmOci bool) error

func ValidatePermissions 

func ValidatePermissions(ctx context.Context, spec *argoappv1.ApplicationSpec, proj *argoappv1.AppProject, db db.ArgoDB) ([]argoappv1.ApplicationCondition, error)

ValidatePermissions ensures that the referenced cluster has been added to Argo CD and the app source repo and destination namespace/cluster are permitted in app project

func ValidateRepo 

func ValidateRepo(
	ctx context.Context,
	app *argoappv1.Application,
	repoClientset apiclient.Clientset,
	db db.ArgoDB,
	kubectl kube.Kubectl,
	proj *argoappv1.AppProject,
	settingsMgr *settings.SettingsManager,
) ([]argoappv1.ApplicationCondition, error)

ValidateRepo validates the repository specified in application spec. Following is checked: * the repository is accessible * the path contains valid manifests * there are parameters of only one app source type

The plugins parameter is no longer used. It is kept for compatibility with the old signature until Argo CD v3.0.

Types

type AppInstanceValue 

type AppInstanceValue struct {
	ApplicationName string
	Group           string
	Kind            string
	Namespace       string
	Name            string
}

AppInstanceValue store information about resource tracking info

func UnstructuredToAppInstanceValue 

func UnstructuredToAppInstanceValue(un *unstructured.Unstructured, appName, namespace string) AppInstanceValue

UnstructuredToAppInstanceValue will build the AppInstanceValue based on the provided unstructured. The given namespace works as a default value if the resource's namespace is not defined. It should be the Application's target destination namespace.

type AuditLogger 

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

func NewAuditLogger 

func NewAuditLogger(ns string, kIf kubernetes.Interface, component string, enableK8sEvent []string) *AuditLogger

func (*AuditLogger) LogAppEvent 

func (l *AuditLogger) LogAppEvent(app *v1alpha1.Application, info EventInfo, message, user string, eventLabels map[string]string)

func (*AuditLogger) LogAppProjEvent 

func (l *AuditLogger) LogAppProjEvent(proj *v1alpha1.AppProject, info EventInfo, message, user string)

func (*AuditLogger) LogAppSetEvent 

func (l *AuditLogger) LogAppSetEvent(app *v1alpha1.ApplicationSet, info EventInfo, message, user string)

func (*AuditLogger) LogResourceEvent 

func (l *AuditLogger) LogResourceEvent(res *v1alpha1.ResourceNode, info EventInfo, message, user string)

type ClusterGetter 

type ClusterGetter interface {
	GetCluster(ctx context.Context, name string) (*argoappv1.Cluster, error)
	GetClusterServersByName(ctx context.Context, server string) ([]string, error)
}

type EventInfo 

type EventInfo struct {
	Type   string
	Reason string
}

type ObjectRef 

type ObjectRef struct {
	Name            string
	Namespace       string
	ResourceVersion string
	UID             types.UID
}

type ResourceTracking 

type ResourceTracking interface {
	GetAppName(un *unstructured.Unstructured, key string, trackingMethod v1alpha1.TrackingMethod, installationID string) string
	GetAppInstance(un *unstructured.Unstructured, trackingMethod v1alpha1.TrackingMethod, installationID string) *AppInstanceValue
	SetAppInstance(un *unstructured.Unstructured, key, val, namespace string, trackingMethod v1alpha1.TrackingMethod, instanceID string) error
	BuildAppInstanceValue(value AppInstanceValue) string
	ParseAppInstanceValue(value string) (*AppInstanceValue, error)
	Normalize(config, live *unstructured.Unstructured, labelKey, trackingMethod string) error
}

ResourceTracking defines methods which allow setup and retrieve tracking information to resource

func NewResourceTracking 

func NewResourceTracking() ResourceTracking

Source Files

View all Source files

Directories

Path Synopsis
Code generated by github.com/argoproj/argo-cd/hack/known_types.
 Code generated by github.com/argoproj/argo-cd/hack/known_types.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.
JackTT - Gopher 🇻🇳