import {models} from 'argo-ui'; interface ItemsList { /** * APIVersion defines the versioned schema of this representation of an object. * Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. */ apiVersion?: string; items: T[]; /** * Kind is a string value representing the REST resource this object represents. * Servers may infer this from the endpoint the client submits requests to. */ kind?: string; metadata: models.ListMeta; } export interface AbstractApplicationList extends ItemsList {} export interface ApplicationList extends ItemsList {} export interface ApplicationSetList extends ItemsList {} export interface SyncOperationResource { group: string; kind: string; name: string; } export interface SyncStrategy { apply?: {force?: boolean}; hook?: {force?: boolean}; } export interface SyncOperation { revision: string; prune: boolean; dryRun: boolean; resources?: SyncOperationResource[]; } export interface RetryBackoff { duration: string; maxDuration: string; factor: number; } export interface RetryStrategy { limit: number; backoff: RetryBackoff; refresh: boolean; } export interface RollbackOperation { id: number; prune: boolean; dryRun: boolean; } export interface OperationInitiator { username: string; automated: boolean; } export interface Operation { sync: SyncOperation; initiatedBy: OperationInitiator; } export type OperationPhase = 'Running' | 'Error' | 'Failed' | 'Succeeded' | 'Terminating' | 'Progressing' | 'Pending' | 'Waiting'; export const OperationPhases = { Running: 'Running' as OperationPhase, Failed: 'Failed' as OperationPhase, Error: 'Error' as OperationPhase, Succeeded: 'Succeeded' as OperationPhase, Terminating: 'Terminating' as OperationPhase, Progressing: 'Progressing' as OperationPhase, Pending: 'Pending' as OperationPhase, Waiting: 'Waiting' as OperationPhase }; /** * OperationState contains information about state of currently performing operation on application. */ export interface OperationState { operation: Operation; phase: OperationPhase; message: string; syncResult: SyncOperationResult; startedAt: models.Time; finishedAt: models.Time; } export type OperationStateTitle = 'Deleting' | 'Syncing' | 'Sync error' | 'Sync failed' | 'Sync OK' | 'Terminated' | 'Unknown'; export const OperationStateTitles = { Deleting: 'Deleting', Syncing: 'Syncing', SyncError: 'Sync error', SyncFailed: 'Sync failed', SyncOK: 'Sync OK', Terminated: 'Terminated', Unknown: 'Unknown' } satisfies Record; export type HookType = 'PreSync' | 'Sync' | 'PostSync' | 'SyncFail' | 'Skip'; export interface RevisionMetadata { author?: string; date: models.Time; tags?: string[]; message?: string; signatureInfo?: string; } export interface OCIMetadata { createdAt: string; authors: string; docsUrl: string; sourceUrl: string; version: string; description: string; } export interface ChartDetails { description?: string; maintainers?: string[]; home?: string; } export interface SyncOperationResult { resources: ResourceResult[]; revision: string; revisions: string[]; } export type ResultCode = 'Synced' | 'SyncFailed' | 'Pruned' | 'PruneSkipped'; export const ResultCodes = { Synced: 'Synced', SyncFailed: 'SyncFailed', Pruned: 'Pruned', PruneSkipped: 'PruneSkipped' }; export interface ResourceResult { name: string; group: string; kind: string; version: string; namespace: string; status: ResultCode; message: string; hookType: HookType; hookPhase: OperationPhase; images?: string[]; } export type SyncResourceResult = ResourceResult & { health?: HealthStatus; syncWave?: number; }; export const AnnotationRefreshKey = 'argocd.argoproj.io/refresh'; export const AnnotationHookKey = 'argocd.argoproj.io/hook'; export const AnnotationSyncWaveKey = 'argocd.argoproj.io/sync-wave'; export const AnnotationDefaultView = 'pref.argocd.argoproj.io/default-view'; export const AnnotationDefaultPodSort = 'pref.argocd.argoproj.io/default-pod-sort'; export interface AbstractApplication { apiVersion?: string; kind?: string; metadata: models.ObjectMeta; spec: any; status?: any; } export interface Application extends AbstractApplication { spec: ApplicationSpec; status: ApplicationStatus; operation?: Operation; isAppOfAppsPattern?: boolean; } export type WatchType = 'ADDED' | 'MODIFIED' | 'DELETED' | 'ERROR'; export interface ApplicationWatchEvent { type: WatchType; application: Application; } export interface ApplicationSetWatchEvent { type: WatchType; applicationSet: ApplicationSet; } export interface ComponentParameter { component: string; name: string; value: string; } export interface ApplicationDestination { /** * Server address of the destination cluster */ server: string; /** * Namespace of the destination cluster */ namespace: string; /** * Name of the destination cluster which can be used instead of server (url) field */ name: string; } export interface ApplicationDestinationServiceAccount { server: string; namespace: string; defaultServiceAccount: string; } export interface OrphanedResource { group: string; kind: string; name: string; } export interface ApplicationSource { targetRevision: string; /** * RepoURL is repository URL which contains application project. */ repoURL: string; /** * Path is a directory path within repository which */ path?: string; chart?: string; helm?: ApplicationSourceHelm; kustomize?: ApplicationSourceKustomize; plugin?: ApplicationSourcePlugin; directory?: ApplicationSourceDirectory; ref?: string; name?: string; tagPrefix?: string; } export interface SourceHydrator { drySource: DrySource; syncSource: SyncSource; hydrateTo?: HydrateTo; } export interface DrySource { repoURL: string; targetRevision: string; path?: string; helm?: ApplicationSourceHelm; kustomize?: ApplicationSourceKustomize; plugin?: ApplicationSourcePlugin; directory?: ApplicationSourceDirectory; } export interface SyncSource { targetBranch: string; path: string; repoURL?: string; } export interface HydrateTo { targetBranch: string; } export interface ApplicationSourceHelm { valueFiles: string[]; values?: string; valuesObject?: any; parameters: HelmParameter[]; fileParameters: HelmFileParameter[]; } export interface ApplicationSourceKustomize { namePrefix: string; nameSuffix: string; images: string[]; version: string; namespace: string; } export interface EnvEntry { name: string; value: string; } export interface ApplicationSourcePlugin { name: string; env: EnvEntry[]; parameters?: Parameter[]; } export interface Parameter { name: string; string?: string; array?: string[]; map?: Map; } export interface JsonnetVar { name: string; value: string; code: boolean; } interface ApplicationSourceJsonnet { extVars: JsonnetVar[]; tlas: JsonnetVar[]; } export interface ApplicationSourceDirectory { recurse: boolean; jsonnet?: ApplicationSourceJsonnet; include?: string; exclude?: string; } export interface Automated { prune: boolean; selfHeal: boolean; enabled: boolean; } export interface SyncPolicy { automated?: Automated; syncOptions?: string[]; retry?: RetryStrategy; } export interface Info { name: string; value: string; } export interface ApplicationSpec { project: string; source?: ApplicationSource; sources: ApplicationSource[]; sourceHydrator?: SourceHydrator; destination: ApplicationDestination; syncPolicy?: SyncPolicy; ignoreDifferences?: ResourceIgnoreDifferences[]; info?: Info[]; revisionHistoryLimit?: number; } export interface ResourceIgnoreDifferences { group: string; kind: string; name: string; namespace: string; jsonPointers: string[]; jqPathExpressions: string[]; } /** * RevisionHistory contains information relevant to an application deployment */ export interface RevisionHistory { id: number; revision: string; source: ApplicationSource; revisions: string[]; sources: ApplicationSource[]; deployStartedAt: models.Time; deployedAt: models.Time; initiatedBy: OperationInitiator; } export type SyncStatusCode = 'Unknown' | 'Synced' | 'OutOfSync'; export const SyncStatuses: {[key: string]: SyncStatusCode} = { Unknown: 'Unknown', Synced: 'Synced', OutOfSync: 'OutOfSync' }; export const SyncPriority: Record = { Unknown: 0, OutOfSync: 1, Synced: 2 }; export type HealthStatusCode = 'Unknown' | 'Progressing' | 'Healthy' | 'Suspended' | 'Degraded' | 'Missing'; export const HealthStatuses: {[key: string]: HealthStatusCode} = { Progressing: 'Progressing', Suspended: 'Suspended', Healthy: 'Healthy', Degraded: 'Degraded', Missing: 'Missing', Unknown: 'Unknown' }; export const HealthPriority: Record = { Missing: 0, Degraded: 1, Unknown: 2, Progressing: 3, Suspended: 4, Healthy: 5 }; export interface HealthStatus { status: HealthStatusCode; message: string; } export type State = models.TypeMeta & {metadata: models.ObjectMeta} & {status: any; spec: any}; export type ReadinessGate = { conditionType: string; }; export interface ResourceStatus { group: string; version: string; kind: string; namespace: string; name: string; status: SyncStatusCode; health: HealthStatus; createdAt?: models.Time; hook?: boolean; requiresPruning?: boolean; requiresDeletionConfirmation?: boolean; syncWave?: number; orphaned?: boolean; } export interface ResourceRef { uid: string; kind: string; namespace: string; name: string; version: string; group: string; } export interface ResourceNetworkingInfo { targetLabels: {[name: string]: string}; targetRefs: ResourceRef[]; labels: {[name: string]: string}; ingress: LoadBalancerIngress[]; externalURLs: string[]; } export interface LoadBalancerIngress { hostname: string; ip: string; } export interface InfoItem { name: string; value: string; } export interface ResourceNode extends ResourceRef { parentRefs: ResourceRef[]; info: InfoItem[]; networkingInfo?: ResourceNetworkingInfo; images?: string[]; resourceVersion: string; createdAt?: models.Time; } export interface AbstractApplicationTree { nodes: ResourceNode[]; } export interface ApplicationTree extends AbstractApplicationTree { orphanedNodes: ResourceNode[]; hosts: Node[]; } export interface ApplicationSetTree extends AbstractApplicationTree { // FFU dummyToPlacateLinter: any; } export interface ResourceID { group: string; kind: string; namespace: string; name: string; } export interface ResourceDiff extends ResourceID { targetState: State; liveState: State; predictedLiveState: State; normalizedLiveState: State; hook: boolean; } export interface SyncStatus { comparedTo: ApplicationSource; status: SyncStatusCode; revision: string; revisions: string[]; } export interface ApplicationCondition { type: string; message: string; lastTransitionTime: string; } export interface ApplicationSummary { externalURLs?: string[]; images?: string[]; isAppOfApps?: boolean; } export interface ApplicationStatus { observedAt: models.Time; resources: ResourceStatus[]; sync: SyncStatus; conditions?: ApplicationCondition[]; history: RevisionHistory[]; health: HealthStatus; operationState?: OperationState; summary?: ApplicationSummary; sourceHydrator?: SourceHydratorStatus; } export interface SourceHydratorStatus { lastSuccessfulOperation?: SuccessfulHydrateOperation; currentOperation?: HydrateOperation; } export interface HydrateOperation { startedAt: models.Time; finishedAt?: models.Time; phase: HydrateOperationPhase; message: string; // drySHA is the sha of the DRY commit being hydrated. This will be empty if the operation is not successful. drySHA: string; // hydratedSHA is the sha of the hydrated commit. This will be empty if the operation is not successful. hydratedSHA: string; sourceHydrator: SourceHydrator; } export interface SuccessfulHydrateOperation { drySHA: string; hydratedSHA: string; sourceHydrator: SourceHydrator; } export type HydrateOperationPhase = 'Hydrating' | 'Failed' | 'Hydrated'; export const HydrateOperationPhases = { Hydrating: 'Hydrating' as OperationPhase, Failed: 'Failed' as OperationPhase, Hydrated: 'Hydrated' as OperationPhase }; export interface JwtTokens { items: JwtToken[]; } export interface AppProjectStatus { jwtTokensByRole: {[name: string]: JwtTokens}; } export interface LogEntry { content: string; timeStamp: models.Time; // first field is inferred on the fly and indicats first log line received from backend first?: boolean; last: boolean; timeStampStr: string; podName: string; } // describes plugin settings export interface Plugin { name: string; } export interface AuthSettings { url: string; statusBadgeEnabled: boolean; statusBadgeRootUrl: string; googleAnalytics: { trackingID: string; anonymizeUsers: boolean; }; dexConfig: { connectors: { name: string; type: string; }[]; }; oidcConfig: { name: string; }; help: { chatUrl: string; chatText: string; binaryUrls: Record; }; userLoginsDisabled: boolean; kustomizeVersions: string[]; uiCssURL: string; uiBannerContent: string; uiBannerURL: string; uiBannerPermanent: boolean; uiBannerPosition: string; uiLoginButtonText: string; execEnabled: boolean; appsInAnyNamespaceEnabled: boolean; hydratorEnabled: boolean; syncWithReplaceAllowed: boolean; appLabelKey: string; trackingMethod: string; additionalUrls: string[]; impersonationEnabled: boolean; controllerNamespace: string; installationID: string; } export interface UserInfo { loggedIn: boolean; username: string; iss: string; groups: string[]; } export type ConnectionStatus = 'Unknown' | 'Successful' | 'Failed'; export const ConnectionStatuses = { Unknown: 'Unknown', Failed: 'Failed', Successful: 'Successful' }; export interface ConnectionState { status: ConnectionStatus; message: string; attemptedAt: models.Time; } export interface RepoCert { serverName: string; certType: string; certSubType: string; certData: string; certInfo: string; } export interface RepoCertList extends ItemsList {} export interface Repository { repo: string; type?: string; name?: string; connectionState: ConnectionState; project?: string; username?: string; password?: string; bearerToken?: string; tlsClientCertData?: string; tlsClientCertKey?: string; proxy?: string; noProxy?: string; insecure?: boolean; enableLfs?: boolean; githubAppID?: string; forceHttpBasicAuth?: boolean; insecureOCIForceHttp?: boolean; enableOCI: boolean; useAzureWorkloadIdentity: boolean; depth?: number; azureServicePrincipalClientId?: string; azureServicePrincipalClientSecret?: string; azureServicePrincipalTenantId?: string; azureActiveDirectoryEndpoint?: string; } export interface RepositoryList extends ItemsList {} export interface RepoCreds { url: string; username?: string; bearerToken?: string; type?: string; enableOCI?: boolean; } export interface RepoCredsList extends ItemsList {} export interface Cluster { name: string; server: string; namespaces?: []; refreshRequestedAt?: models.Time; config?: { awsAuthConfig?: { clusterName: string; }; execProviderConfig?: { command: string; }; }; info?: { applicationsCount: number; serverVersion: string; connectionState: ConnectionState; cacheInfo: ClusterCacheInfo; }; annotations?: {[name: string]: string}; labels?: {[name: string]: string}; } export interface ClusterCacheInfo { resourcesCount: number; apisCount: number; lastCacheSyncTime: models.Time; } export interface ClusterList extends ItemsList {} export interface HelmChart { name: string; versions: string[]; } export type AppSourceType = 'Helm' | 'Kustomize' | 'Directory' | 'Plugin'; export interface RepoAppDetails { type: AppSourceType; path: string; helm?: HelmAppSpec; kustomize?: KustomizeAppSpec; plugin?: PluginAppSpec; directory?: {}; } export interface RefsInfo { branches: string[]; tags: string[]; } export interface AppInfo { type: string; path: string; } export interface HelmParameter { name: string; value: string; } export interface HelmFileParameter { name: string; path: string; } export interface HelmAppSpec { name: string; path: string; valueFiles: string[]; values?: string; parameters: HelmParameter[]; fileParameters: HelmFileParameter[]; } export interface KustomizeAppSpec { path: string; images?: string[]; namespace?: string; } export interface PluginAppSpec { name: string; env: EnvEntry[]; parametersAnnouncement?: ParameterAnnouncement[]; } export interface ParameterAnnouncement { name?: string; title?: string; tooltip?: string; required?: boolean; itemType?: string; collectionType?: string; string?: string; array?: string[]; map?: Map; } export interface ObjectReference { kind: string; namespace: string; name: string; uid: string; apiVersion: string; resourceVersion: string; fieldPath: string; } export interface EventSource { component: string; host: string; } export interface EventSeries { count: number; lastObservedTime: models.Time; state: string; } export interface Event { apiVersion?: string; kind?: string; metadata: models.ObjectMeta; involvedObject: ObjectReference; reason: string; message: string; source: EventSource; firstTimestamp: models.Time; lastTimestamp: models.Time; count: number; type: string; eventTime: models.Time; series: EventSeries; action: string; related: ObjectReference; reportingController: string; reportingInstance: string; } export interface EventList extends ItemsList {} export interface ProjectRole { description: string; policies: string[]; name: string; groups: string[]; } export interface JwtToken { iat: number; exp: number; id: string; } export interface GroupKind { group: string; kind: string; } export interface ClusterResourceRestrictionItem { group: string; kind: string; name?: string; } export interface ProjectSignatureKey { keyID: string; } export interface ProjectSpec { sourceRepos: string[]; sourceNamespaces: string[]; destinations: ApplicationDestination[]; destinationServiceAccounts: ApplicationDestinationServiceAccount[]; description: string; roles: ProjectRole[]; clusterResourceWhitelist: ClusterResourceRestrictionItem[]; clusterResourceBlacklist: ClusterResourceRestrictionItem[]; namespaceResourceBlacklist: GroupKind[]; namespaceResourceWhitelist: GroupKind[]; signatureKeys: ProjectSignatureKey[]; orphanedResources?: {warn?: boolean; ignore: OrphanedResource[]}; syncWindows?: SyncWindows; } export type SyncWindows = SyncWindow[]; export interface SyncWindow { kind: string; schedule: string; duration: string; applications: string[]; namespaces: string[]; clusters: string[]; manualSync: boolean; timeZone: string; andOperator: boolean; description: string; syncOverrun: boolean; } export interface Project { apiVersion?: string; kind?: string; metadata: models.ObjectMeta; spec: ProjectSpec; status: AppProjectStatus; } export interface DetailedProjectsResponse { project: Project; globalProjects: Project[]; repositories: Repository[]; clusters: Cluster[]; } export type ProjectList = ItemsList; export const DEFAULT_PROJECT_NAME = 'default'; export interface ManifestResponse { manifests: string[]; namespace: string; server: string; revision: string; } export interface ResourceActionParam { name: string; value: string; type: string; default: string; } export interface ResourceAction { name: string; params: ResourceActionParam[]; disabled: boolean; iconClass: string; displayName: string; } export interface SyncWindowsState { windows: SyncWindow[]; } export interface ApplicationSyncWindowState { activeWindows: SyncWindow[]; assignedWindows: SyncWindow[]; canSync: boolean; } export interface VersionMessage { Version: string; BuildDate: string; GoVersion: string; Compiler: string; Platform: string; KustomizeVersion: string; HelmVersion: string; KubectlVersion: string; JsonnetVersion: string; } export interface Token { id: string; issuedAt: number; expiresAt: number; } export interface Account { name: string; enabled: boolean; capabilities: string[]; tokens: Token[]; } export interface GnuPGPublicKey { keyID?: string; fingerprint?: string; subType?: string; owner?: string; keyData?: string; } export interface GnuPGPublicKeyList extends ItemsList {} // https://kubernetes.io/docs/reference/kubectl/overview/#resource-types export const ResourceKinds = [ '*', 'Binding', 'ComponentStatus', 'ConfigMap', 'Endpoints', 'LimitRange', 'Namespace', 'Node', 'PersistentVolumeClaim', 'PersistentVolume', 'Pod', 'PodTemplate', 'ReplicationController', 'ResourceQuota', 'Secret', 'ServiceAccount', 'Service', 'MutatingWebhookConfiguration', 'ValidatingWebhookConfiguration', 'CustomResourceDefinition', 'APIService', 'ControllerRevision', 'DaemonSet', 'Deployment', 'ReplicaSet', 'StatefulSet', 'TokenReview', 'LocalSubjectAccessReview', 'SelfSubjectAccessReview', 'SelfSubjectRulesReview', 'SubjectAccessReview', 'HorizontalPodAutoscaler', 'CronJob', 'Job', 'CertificateSigningRequest', 'Lease', 'Event', 'Ingress', 'NetworkPolicy', 'PodDisruptionBudget', 'ClusterRoleBinding', 'ClusterRole', 'RoleBinding', 'Role', 'PriorityClass', 'CSIDriver', 'CSINode', 'StorageClass', 'Volume' ]; export const Groups = [ 'admissionregistration.k8s.io', 'apiextensions.k8s.io', 'apiregistration.k8s.io', 'apps', 'authentication.k8s.io', 'authorization.k8s.io', 'autoscaling', 'batch', 'certificates.k8s.io', 'coordination.k8s.io', 'events.k8s.io', 'extensions', 'networking.k8s.io', 'node.k8s.io', 'policy', 'rbac.authorization.k8s.io', 'scheduling.k8s.io', 'stable.example.com', 'storage.k8s.io' ]; export interface HostResourceInfo { resourceName: ResourceName; requestedByApp: number; requestedByNeighbors: number; capacity: number; } export interface Node { name: string; systemInfo: NodeSystemInfo; resourcesInfo: HostResourceInfo[]; labels: {[name: string]: string}; } export interface NodeSystemInfo { architecture: string; operatingSystem: string; kernelVersion: string; } export enum ResourceName { ResourceCPU = 'cpu', ResourceMemory = 'memory', ResourceStorage = 'storage' } export interface Pod extends ResourceNode { fullName: string; metadata: models.ObjectMeta; spec: PodSpec; health: HealthStatusCode; } export interface PodSpec { nodeName: string; } export enum PodPhase { PodPending = 'Pending', PodRunning = 'Running', PodSucceeded = 'Succeeded', PodFailed = 'Failed', PodUnknown = 'Unknown' } export interface NotificationChunk { name: string; } export interface LinkInfo { title: string; url: string; description?: string; iconClass?: string; } export interface LinksResponse { items: LinkInfo[]; } export interface UserMessages { appName: string; msgKey: string; display: boolean; condition?: HealthStatusCode; duration?: number; animation?: string; } export const AppDeletionConfirmedAnnotation = 'argocd.argoproj.io/deletion-approved'; export interface ApplicationSetSpec { strategy?: { type: 'AllAtOnce' | 'RollingSync'; rollingSync?: { steps: Array<{ matchExpressions: Array<{ key: string; operator: string; values: string[]; }>; maxUpdate: number; }>; }; }; } export interface ApplicationSetCondition { type: string; status: string; message: string; lastTransitionTime: string; reason: string; } export interface ApplicationSetResource { group: string; version: string; kind: string; name: string; namespace: string; status: string; health?: { status: string; lastTransitionTime: models.Time; }; labels?: {[key: string]: string}; } export interface ApplicationSet extends AbstractApplication { spec: ApplicationSetSpec; status?: { conditions?: ApplicationSetCondition[]; applicationStatus?: Array<{ application: string; status: 'Waiting' | 'Pending' | 'Progressing' | 'Healthy'; message?: string; lastTransitionTime?: string; step?: string; targetRevisions?: string[]; }>; resources?: ApplicationSetResource[]; resourcesCount?: number; }; }