Documentation
¶
Index ¶
Constants ¶
View Source
const ( // AnnotationSyncOptions is a comma-separated list of options for syncing AnnotationSyncOptions = "argocd.argoproj.io/sync-options" // AnnotationSyncWave indicates which wave of the sync the resource or hook should be in AnnotationSyncWave = "argocd.argoproj.io/sync-wave" // AnnotationKeyHook contains the hook type of a resource AnnotationKeyHook = "argocd.argoproj.io/hook" // AnnotationKeyHookDeletePolicy is the policy of deleting a hook AnnotationKeyHookDeletePolicy = "argocd.argoproj.io/hook-delete-policy" AnnotationDeletionApproved = "argocd.argoproj.io/deletion-approved" // Sync option that disables dry run in resource is missing in the cluster SyncOptionSkipDryRunOnMissingResource = "SkipDryRunOnMissingResource=true" // Sync option that disables resource validation SyncOptionsDisableValidation = "Validate=false" // Sync option that enables pruneLast SyncOptionPruneLast = "PruneLast=true" // Sync option that enables use of replace or create command instead of apply SyncOptionReplace = "Replace=true" // Sync option that disables use of replace or create command instead of apply SyncOptionDisableReplace = "Replace=false" // Sync option that enables use of --force flag, delete and re-create SyncOptionForce = "Force=true" // Sync option that enables use of --server-side flag instead of client-side SyncOptionServerSideApply = "ServerSideApply=true" // Sync option that disables use of --server-side flag instead of client-side SyncOptionDisableServerSideApply = "ServerSideApply=false" // Sync option that sync only out of sync resources SyncOptionApplyOutOfSyncOnly = "ApplyOutOfSyncOnly=true" // Sync option that disables sync only out of sync resources SyncOptionDisableApplyOutOfSyncOnly = "ApplyOutOfSyncOnly=false" // Sync option that controls resource deletion SyncOptionDelete = "Delete" // Sync option that controls resource pruning SyncOptionPrune = "Prune" // Sync value to confirm a delete or prune operation SyncValueConfirm = "confirm" // Sync value to disable a delete or prune operation SyncValueFalse = "false" // Sync option that enables client-side apply migration SyncOptionClientSideApplyMigration = "ClientSideApplyMigration=true" // Sync option that disables client-side apply migration SyncOptionDisableClientSideApplyMigration = "ClientSideApplyMigration=false" // Default field manager for client-side apply migration DefaultClientSideApplyMigrationManager = "kubectl-client-side-apply" )
View Source
const ( SyncPhasePreSync = "PreSync" SyncPhaseSync = "Sync" SyncPhasePostSync = "PostSync" SyncPhaseSyncFail = "SyncFail" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type HookDeletePolicy ¶
type HookDeletePolicy string
const ( HookDeletePolicyHookSucceeded HookDeletePolicy = "HookSucceeded" HookDeletePolicyHookFailed HookDeletePolicy = "HookFailed" HookDeletePolicyBeforeHookCreation HookDeletePolicy = "BeforeHookCreation" )
func NewHookDeletePolicy ¶
func NewHookDeletePolicy(p string) (HookDeletePolicy, bool)
type OperationPhase ¶
type OperationPhase string
const ( OperationRunning OperationPhase = "Running" OperationTerminating OperationPhase = "Terminating" OperationFailed OperationPhase = "Failed" OperationError OperationPhase = "Error" OperationSucceeded OperationPhase = "Succeeded" )
func (OperationPhase) Completed ¶
func (os OperationPhase) Completed() bool
func (OperationPhase) Failed ¶
func (os OperationPhase) Failed() bool
func (OperationPhase) Running ¶
func (os OperationPhase) Running() bool
func (OperationPhase) Successful ¶
func (os OperationPhase) Successful() bool
type PermissionValidator ¶
type PermissionValidator func(un *unstructured.Unstructured, res *metav1.APIResource) error
type ResourceSyncResult ¶
type ResourceSyncResult struct {
// holds associated resource key
ResourceKey kube.ResourceKey
// Images holds the images associated with the resource. These images are collected on a best-effort basis
// from fields used by known workload resources. This does not necessarily reflect the exact list of images
// used by workloads in the application.
Images []string
// holds resource version
Version string
// holds the execution order
Order int
// result code
Status ResultCode
// message for the last sync OR operation
Message string
// the type of the hook, empty for non-hook resources
HookType HookType
// the state of any operation associated with this resource OR hook
// note: can contain values for non-hook resources
HookPhase OperationPhase
// indicates the particular phase of the sync that this is for
SyncPhase SyncPhase
}
type ResultCode ¶
type ResultCode string
const ( ResultCodeSynced ResultCode = "Synced" ResultCodeSyncFailed ResultCode = "SyncFailed" ResultCodePruned ResultCode = "Pruned" ResultCodePruneSkipped ResultCode = "PruneSkipped" )
type SyncWaveHook ¶
SyncWaveHook is a callback function which will be invoked after each sync wave is successfully applied during a sync operation. The callback indicates which phase and wave it had just executed, and whether or not that wave was the final one.
Click to show internal directories.
Click to hide internal directories.