Skip to content

Commit

Permalink
feat: report ArgoCD errors via .status.conditions field (#1608)
Browse files Browse the repository at this point in the history 
Signed-off-by: Jayendra Parsai <[email protected]>
Co-authored-by: Jayendra Parsai <[email protected]>
  • Loading branch information
@jparsai
jparsai and Jayendra Parsai authored Dec 19, 2024
1 parent 29fb920 commit 31af195
Show file tree
Hide file tree
Showing 19 changed files with 876 additions and 99 deletions.
12 changes: 12 additions & 0 deletions api/v1alpha1/argocd_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -839,6 +839,15 @@ type ArgoCDSpec struct {
AggregatedClusterRoles bool `json:"aggregatedClusterRoles,omitempty"`
}

const (
ArgoCDConditionType = "Reconciled"
)

const (
ArgoCDConditionReasonSuccess = "Success"
ArgoCDConditionReasonErrorOccurred = "ErrorOccurred"
)

// ArgoCDStatus defines the observed state of ArgoCD
// +k8s:openapi-gen=true
type ArgoCDStatus struct {
Expand Down Expand Up @@ -922,6 +931,9 @@ type ArgoCDStatus struct {

// Host is the hostname of the Ingress.
Host string `json:"host,omitempty"`

// Conditions is an array of the ArgoCD's status conditions
Conditions []metav1.Condition `json:"conditions,omitempty"`
}

// Banner defines an additional banner message to be displayed in Argo CD UI
Expand Down
9 changes: 8 additions & 1 deletion api/v1alpha1/zz_generated.deepcopy.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions api/v1beta1/argocd_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -940,6 +940,15 @@ type ArgoCDSpec struct {
AggregatedClusterRoles bool `json:"aggregatedClusterRoles,omitempty"`
}

const (
ArgoCDConditionType = "Reconciled"
)

const (
ArgoCDConditionReasonSuccess = "Success"
ArgoCDConditionReasonErrorOccurred = "ErrorOccurred"
)

// ArgoCDStatus defines the observed state of ArgoCD
// +k8s:openapi-gen=true
type ArgoCDStatus struct {
Expand Down Expand Up @@ -1023,6 +1032,9 @@ type ArgoCDStatus struct {

// Host is the hostname of the Ingress.
Host string `json:"host,omitempty"`

// Conditions is an array of the ArgoCD's status conditions
Conditions []metav1.Condition `json:"conditions,omitempty"`
}

// Banner defines an additional banner message to be displayed in Argo CD UI
Expand Down
9 changes: 8 additions & 1 deletion api/v1beta1/zz_generated.deepcopy.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion bundle/manifests/argocd-operator.clusterserviceversion.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ metadata:
capabilities: Deep Insights
categories: Integration & Delivery
certified: "false"
createdAt: "2024-12-05T16:51:54Z"
createdAt: "2024-12-19T05:48:10Z"
description: Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes.
operators.operatorframework.io/builder: operator-sdk-v1.35.0
operators.operatorframework.io/project_layout: go.kubebuilder.io/v4
Expand Down
140 changes: 140 additions & 0 deletions bundle/manifests/argoproj.io_argocds.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7165,6 +7165,76 @@ spec:
Failed: At least one of the Argo CD applicationSet controller component Pods had a failure.
Unknown: The state of the Argo CD applicationSet controller component could not be obtained.
type: string
conditions:
description: Conditions is an array of the ArgoCD's status conditions
items:
description: "Condition contains details for one aspect of the current
state of this API Resource.\n---\nThis struct is intended for
direct use as an array at the field path .status.conditions. For
example,\n\n\n\ttype FooStatus struct{\n\t // Represents the
observations of a foo's current state.\n\t // Known .status.conditions.type
are: \"Available\", \"Progressing\", and \"Degraded\"\n\t //
+patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t
\ // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\"
patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t
\ // other fields\n\t}"
properties:
lastTransitionTime:
description: |-
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: |-
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: |-
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: |-
type of condition in CamelCase or in foo.example.com/CamelCase.
---
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
useful (see .node.status.conditions), the ability to deconflict is important.
The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
host:
description: Host is the hostname of the Ingress.
type: string
Expand Down Expand Up @@ -24674,6 +24744,76 @@ spec:
Failed: At least one of the Argo CD applicationSet controller component Pods had a failure.
Unknown: The state of the Argo CD applicationSet controller component could not be obtained.
type: string
conditions:
description: Conditions is an array of the ArgoCD's status conditions
items:
description: "Condition contains details for one aspect of the current
state of this API Resource.\n---\nThis struct is intended for
direct use as an array at the field path .status.conditions. For
example,\n\n\n\ttype FooStatus struct{\n\t // Represents the
observations of a foo's current state.\n\t // Known .status.conditions.type
are: \"Available\", \"Progressing\", and \"Degraded\"\n\t //
+patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t
\ // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\"
patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t
\ // other fields\n\t}"
properties:
lastTransitionTime:
description: |-
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: |-
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: |-
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: |-
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: |-
type of condition in CamelCase or in foo.example.com/CamelCase.
---
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be
useful (see .node.status.conditions), the ability to deconflict is important.
The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
type: array
host:
description: Host is the hostname of the Ingress.
type: string
Expand Down
Loading

0 comments on commit 31af195

Please sign in to comment.