Skip to content

docs: argocd healthcheck - don't report resources without status as Healthy #1166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kaessert wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: argocd healthcheck - don't report resources without status as Healthy #1166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 18 additions & 19 deletions content/master/guides/crossplane-with-argo-cd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ from `pkg.crossplane.io` already exists which means there no further configurati
Argo CD also enable customising these checks per instance, and that's the mechanism used to provide support
of Provider's CRDs.

Argo CD v3.1 and later also include built-in health checks for the `*.crossplane.io`
and `*.upbound.io` API groups. An entry in `resource.customizations`, including a
wildcard entry like the ones in the following example, takes precedence over the
built-in health checks for the resources it matches.

To configure it, edit the `argocd-cm` `ConfigMap` in the `argocd` `Namespace`.
{{<hint "note">}}
{{<hover label="argocfg" line="22">}} ProviderConfig{{</hover>}} may have no status or a `status.users` field.
Expand Down Expand Up @@ -76,17 +81,13 @@ data:
"ProviderConfigUsage"
}

if obj.status == nil or next(obj.status) == nil and contains(has_no_status, obj.kind) then
health_status.status = "Healthy"
health_status.message = "Resource is up-to-date."
return health_status
end

if obj.status == nil or next(obj.status) == nil or obj.status.conditions == nil then
if (obj.kind == "ProviderConfig" or obj.kind == "ClusterProviderConfig") and obj.status.users ~= nil then
if obj.status == nil or obj.status.conditions == nil or next(obj.status.conditions) == nil then
if contains(has_no_status, obj.kind) then
health_status.status = "Healthy"
health_status.message = "Resource is in use."
return health_status
health_status.message = "Resource is up-to-date."
if obj.status ~= nil and obj.status.users ~= nil then
health_status.message = "Resource is in use."
end
end
return health_status
end
Expand Down Expand Up @@ -138,21 +139,19 @@ data:
"Composition",
"CompositionRevision",
"DeploymentRuntimeConfig",
"EnvironmentConfig",
"ImageConfig",
"ClusterProviderConfig",
"ProviderConfig",
"ProviderConfigUsage"
}
if obj.status == nil or next(obj.status) == nil and contains(has_no_status, obj.kind) then
if obj.status == nil or obj.status.conditions == nil or next(obj.status.conditions) == nil then
if contains(has_no_status, obj.kind) then
health_status.status = "Healthy"
health_status.message = "Resource is up-to-date."
return health_status
end

if obj.status == nil or next(obj.status) == nil or obj.status.conditions == nil then
if (obj.kind == "ProviderConfig" or obj.kind == "ClusterProviderConfig") and obj.status.users ~= nil then
health_status.status = "Healthy"
health_status.message = "Resource is in use."
return health_status
if obj.status ~= nil and obj.status.users ~= nil then
health_status.message = "Resource is in use."
end
end
return health_status
end
Expand Down
37 changes: 18 additions & 19 deletions content/v1.20/guides/crossplane-with-argo-cd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ from `pkg.crossplane.io` has already been declared which means there no further
Argo CD also enable customising these checks per instance, and that's the mechanism used to provide support
of Provider's CRDs.

Argo CD v3.1 and later also include built-in health checks for the `*.crossplane.io`
and `*.upbound.io` API groups. An entry in `resource.customizations`, including a
wildcard entry like the ones in the following example, takes precedence over the
built-in health checks for the resources it matches.

To configure it, edit the `argocd-cm` `ConfigMap` in the `argocd` `Namespace`.
{{<hint "note">}}
{{<hover label="argocfg" line="22">}} ProviderConfig{{</hover>}} may have no status or a `status.users` field.
Expand Down Expand Up @@ -70,17 +75,13 @@ data:
"ProviderConfigUsage"
}

if obj.status == nil or next(obj.status) == nil and contains(has_no_status, obj.kind) then
health_status.status = "Healthy"
health_status.message = "Resource is up-to-date."
return health_status
end

if obj.status == nil or next(obj.status) == nil or obj.status.conditions == nil then
if obj.kind == "ProviderConfig" and obj.status.users ~= nil then
if obj.status == nil or obj.status.conditions == nil or next(obj.status.conditions) == nil then
if contains(has_no_status, obj.kind) then
health_status.status = "Healthy"
health_status.message = "Resource is in use."
return health_status
health_status.message = "Resource is up-to-date."
if obj.status ~= nil and obj.status.users ~= nil then
health_status.message = "Resource is in use."
end
end
return health_status
end
Expand Down Expand Up @@ -132,21 +133,19 @@ data:
"Composition",
"CompositionRevision",
"DeploymentRuntimeConfig",
"EnvironmentConfig",
"ImageConfig",
"ControllerConfig",
"ProviderConfig",
"ProviderConfigUsage"
}
if obj.status == nil or next(obj.status) == nil and contains(has_no_status, obj.kind) then
if obj.status == nil or obj.status.conditions == nil or next(obj.status.conditions) == nil then
if contains(has_no_status, obj.kind) then
health_status.status = "Healthy"
health_status.message = "Resource is up-to-date."
return health_status
end

if obj.status == nil or next(obj.status) == nil or obj.status.conditions == nil then
if obj.kind == "ProviderConfig" and obj.status.users ~= nil then
health_status.status = "Healthy"
health_status.message = "Resource is in use."
return health_status
if obj.status ~= nil and obj.status.users ~= nil then
health_status.message = "Resource is in use."
end
end
return health_status
end
Expand Down
37 changes: 18 additions & 19 deletions content/v2.2/guides/crossplane-with-argo-cd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ from `pkg.crossplane.io` already exists which means there no further configurati
Argo CD also enable customising these checks per instance, and that's the mechanism used to provide support
of Provider's CRDs.

Argo CD v3.1 and later also include built-in health checks for the `*.crossplane.io`
and `*.upbound.io` API groups. An entry in `resource.customizations`, including a
wildcard entry like the ones in the following example, takes precedence over the
built-in health checks for the resources it matches.

To configure it, edit the `argocd-cm` `ConfigMap` in the `argocd` `Namespace`.
{{<hint "note">}}
{{<hover label="argocfg" line="22">}} ProviderConfig{{</hover>}} may have no status or a `status.users` field.
Expand Down Expand Up @@ -76,17 +81,13 @@ data:
"ProviderConfigUsage"
}

if obj.status == nil or next(obj.status) == nil and contains(has_no_status, obj.kind) then
health_status.status = "Healthy"
health_status.message = "Resource is up-to-date."
return health_status
end

if obj.status == nil or next(obj.status) == nil or obj.status.conditions == nil then
if (obj.kind == "ProviderConfig" or obj.kind == "ClusterProviderConfig") and obj.status.users ~= nil then
if obj.status == nil or obj.status.conditions == nil or next(obj.status.conditions) == nil then
if contains(has_no_status, obj.kind) then
health_status.status = "Healthy"
health_status.message = "Resource is in use."
return health_status
health_status.message = "Resource is up-to-date."
if obj.status ~= nil and obj.status.users ~= nil then
health_status.message = "Resource is in use."
end
end
return health_status
end
Expand Down Expand Up @@ -138,21 +139,19 @@ data:
"Composition",
"CompositionRevision",
"DeploymentRuntimeConfig",
"EnvironmentConfig",
"ImageConfig",
"ClusterProviderConfig",
"ProviderConfig",
"ProviderConfigUsage"
}
if obj.status == nil or next(obj.status) == nil and contains(has_no_status, obj.kind) then
if obj.status == nil or obj.status.conditions == nil or next(obj.status.conditions) == nil then
if contains(has_no_status, obj.kind) then
health_status.status = "Healthy"
health_status.message = "Resource is up-to-date."
return health_status
end

if obj.status == nil or next(obj.status) == nil or obj.status.conditions == nil then
if (obj.kind == "ProviderConfig" or obj.kind == "ClusterProviderConfig") and obj.status.users ~= nil then
health_status.status = "Healthy"
health_status.message = "Resource is in use."
return health_status
if obj.status ~= nil and obj.status.users ~= nil then
health_status.message = "Resource is in use."
end
end
return health_status
end
Expand Down
37 changes: 18 additions & 19 deletions content/v2.3/guides/crossplane-with-argo-cd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ from `pkg.crossplane.io` already exists which means there no further configurati
Argo CD also enable customising these checks per instance, and that's the mechanism used to provide support
of Provider's CRDs.

Argo CD v3.1 and later also include built-in health checks for the `*.crossplane.io`
and `*.upbound.io` API groups. An entry in `resource.customizations`, including a
wildcard entry like the ones in the following example, takes precedence over the
built-in health checks for the resources it matches.

To configure it, edit the `argocd-cm` `ConfigMap` in the `argocd` `Namespace`.
{{<hint "note">}}
{{<hover label="argocfg" line="22">}} ProviderConfig{{</hover>}} may have no status or a `status.users` field.
Expand Down Expand Up @@ -76,17 +81,13 @@ data:
"ProviderConfigUsage"
}

if obj.status == nil or next(obj.status) == nil and contains(has_no_status, obj.kind) then
health_status.status = "Healthy"
health_status.message = "Resource is up-to-date."
return health_status
end

if obj.status == nil or next(obj.status) == nil or obj.status.conditions == nil then
if (obj.kind == "ProviderConfig" or obj.kind == "ClusterProviderConfig") and obj.status.users ~= nil then
if obj.status == nil or obj.status.conditions == nil or next(obj.status.conditions) == nil then
if contains(has_no_status, obj.kind) then
health_status.status = "Healthy"
health_status.message = "Resource is in use."
return health_status
health_status.message = "Resource is up-to-date."
if obj.status ~= nil and obj.status.users ~= nil then
health_status.message = "Resource is in use."
end
end
return health_status
end
Expand Down Expand Up @@ -138,21 +139,19 @@ data:
"Composition",
"CompositionRevision",
"DeploymentRuntimeConfig",
"EnvironmentConfig",
"ImageConfig",
"ClusterProviderConfig",
"ProviderConfig",
"ProviderConfigUsage"
}
if obj.status == nil or next(obj.status) == nil and contains(has_no_status, obj.kind) then
if obj.status == nil or obj.status.conditions == nil or next(obj.status.conditions) == nil then
if contains(has_no_status, obj.kind) then
health_status.status = "Healthy"
health_status.message = "Resource is up-to-date."
return health_status
end

if obj.status == nil or next(obj.status) == nil or obj.status.conditions == nil then
if (obj.kind == "ProviderConfig" or obj.kind == "ClusterProviderConfig") and obj.status.users ~= nil then
health_status.status = "Healthy"
health_status.message = "Resource is in use."
return health_status
if obj.status ~= nil and obj.status.users ~= nil then
health_status.message = "Resource is in use."
end
end
return health_status
end
Expand Down
37 changes: 18 additions & 19 deletions content/v2.4/guides/crossplane-with-argo-cd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ from `pkg.crossplane.io` already exists which means there no further configurati
Argo CD also enable customising these checks per instance, and that's the mechanism used to provide support
of Provider's CRDs.

Argo CD v3.1 and later also include built-in health checks for the `*.crossplane.io`
and `*.upbound.io` API groups. An entry in `resource.customizations`, including a
wildcard entry like the ones in the following example, takes precedence over the
built-in health checks for the resources it matches.

To configure it, edit the `argocd-cm` `ConfigMap` in the `argocd` `Namespace`.
{{<hint "note">}}
{{<hover label="argocfg" line="22">}} ProviderConfig{{</hover>}} may have no status or a `status.users` field.
Expand Down Expand Up @@ -76,17 +81,13 @@ data:
"ProviderConfigUsage"
}

if obj.status == nil or next(obj.status) == nil and contains(has_no_status, obj.kind) then
health_status.status = "Healthy"
health_status.message = "Resource is up-to-date."
return health_status
end

if obj.status == nil or next(obj.status) == nil or obj.status.conditions == nil then
if (obj.kind == "ProviderConfig" or obj.kind == "ClusterProviderConfig") and obj.status.users ~= nil then
if obj.status == nil or obj.status.conditions == nil or next(obj.status.conditions) == nil then
if contains(has_no_status, obj.kind) then
health_status.status = "Healthy"
health_status.message = "Resource is in use."
return health_status
health_status.message = "Resource is up-to-date."
if obj.status ~= nil and obj.status.users ~= nil then
health_status.message = "Resource is in use."
end
end
return health_status
end
Expand Down Expand Up @@ -138,21 +139,19 @@ data:
"Composition",
"CompositionRevision",
"DeploymentRuntimeConfig",
"EnvironmentConfig",
"ImageConfig",
"ClusterProviderConfig",
"ProviderConfig",
"ProviderConfigUsage"
}
if obj.status == nil or next(obj.status) == nil and contains(has_no_status, obj.kind) then
if obj.status == nil or obj.status.conditions == nil or next(obj.status.conditions) == nil then
if contains(has_no_status, obj.kind) then
health_status.status = "Healthy"
health_status.message = "Resource is up-to-date."
return health_status
end

if obj.status == nil or next(obj.status) == nil or obj.status.conditions == nil then
if (obj.kind == "ProviderConfig" or obj.kind == "ClusterProviderConfig") and obj.status.users ~= nil then
health_status.status = "Healthy"
health_status.message = "Resource is in use."
return health_status
if obj.status ~= nil and obj.status.users ~= nil then
health_status.message = "Resource is in use."
end
end
return health_status
end
Expand Down
Loading