Skip to content

🐛 fix the hosted addon is unavailable using Customized HealthCheck #315

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

Merged
openshift-merge-bot merged 1 commit into from
May 19, 2025
Merged

🐛 fix the hosted addon is unavailable using Customized HealthCheck #315

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
5 changes: 3 additions & 2 deletions pkg/addonmanager/controllers/agentdeploy/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,8 +289,9 @@ func (c *addonDeployController) sync(ctx context.Context, syncCtx factory.SyncCo
getWorkByAddon: c.getWorksByAddonFn(index.ManifestWorkHookByHostedAddon),
agentAddon: agentAddon},
&healthCheckSyncer{
getWorkByAddon: c.getWorksByAddonFn(index.ManifestWorkByAddon),
agentAddon: agentAddon,
getWorkByAddon: c.getWorksByAddonFn(index.ManifestWorkByAddon),
getWorkByHostedAddon: c.getWorksByAddonFn(index.ManifestWorkByHostedAddon),
agentAddon: agentAddon,
},
}

Expand Down
19 changes: 14 additions & 5 deletions pkg/addonmanager/controllers/agentdeploy/healthcheck_sync.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ import (
)

type healthCheckSyncer struct {
getWorkByAddon func(addonName, addonNamespace string) ([]*workapiv1.ManifestWork, error)
agentAddon agent.AgentAddon
getWorkByAddon func(addonName, addonNamespace string) ([]*workapiv1.ManifestWork, error)
getWorkByHostedAddon func(addonName, addonNamespace string) ([]*workapiv1.ManifestWork, error)
agentAddon agent.AgentAddon
}

func (s *healthCheckSyncer) sync(ctx context.Context,
Expand Down Expand Up @@ -128,8 +129,16 @@ func (s *healthCheckSyncer) probeAddonStatusByWorks(
}
}

addonWorks, err := s.getWorkByAddon(addon.Name, addon.Namespace)
if err != nil || len(addonWorks) == 0 {
var addonManifestWorks []*workapiv1.ManifestWork
var err error
installMode, _ := s.agentAddon.GetAgentAddonOptions().HostedModeInfoFunc(addon, cluster)
if installMode == constants.InstallModeHosted {
addonManifestWorks, err = s.getWorkByHostedAddon(addon.Name, addon.Namespace)
} else {
addonManifestWorks, err = s.getWorkByAddon(addon.Name, addon.Namespace)
}

if err != nil || len(addonManifestWorks) == 0 {
meta.SetStatusCondition(&addon.Status.Conditions, metav1.Condition{
Type: addonapiv1alpha1.ManagedClusterAddOnConditionAvailable,
Status: metav1.ConditionUnknown,
Expand All @@ -140,7 +149,7 @@ func (s *healthCheckSyncer) probeAddonStatusByWorks(
}

manifestConditions := []workapiv1.ManifestCondition{}
for _, work := range addonWorks {
for _, work := range addonManifestWorks {
if !strings.HasPrefix(work.Name, constants.DeployWorkNamePrefix(addon.Name)) {
continue
}
Expand Down
133 changes: 129 additions & 4 deletions pkg/addonmanager/controllers/agentdeploy/healthcheck_sync_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import (
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/tools/cache"
"open-cluster-management.io/addon-framework/pkg/addonmanager/addontesting"
"open-cluster-management.io/addon-framework/pkg/addonmanager/constants"
"open-cluster-management.io/addon-framework/pkg/agent"
"open-cluster-management.io/addon-framework/pkg/index"
"open-cluster-management.io/addon-framework/pkg/utils"
Expand Down Expand Up @@ -53,8 +54,9 @@ func (t *healthCheckTestAgent) Manifests(cluster *clusterv1.ManagedCluster,

func (t *healthCheckTestAgent) GetAgentAddonOptions() agent.AgentAddonOptions {
return agent.AgentAddonOptions{
AddonName: t.name,
HealthProber: t.health,
AddonName: t.name,
HealthProber: t.health,
HostedModeInfoFunc: constants.GetHostedModeInfo,
}
}

Expand Down Expand Up @@ -1106,6 +1108,128 @@ func TestHealthCheckReconcile(t *testing.T) {
Message: "test add-on is available.",
},
},
{
name: "Health check mode is workload availability and WorkProber check pass for hosted addon",
testAddon: &healthCheckTestAgent{name: "test",
health: &agent.HealthProber{Type: agent.HealthProberTypeWorkloadAvailability},
},
addon: addontesting.NewHostedModeAddon("test", "cluster1",
"hostingcluster", manifestAppliedCondition),
existingWork: []runtime.Object{
&v1.ManifestWork{
ObjectMeta: metav1.ObjectMeta{
Name: "addon-test-deploy-01",
Namespace: "hostingcluster",
Labels: map[string]string{
"open-cluster-management.io/addon-name": "test",
"open-cluster-management.io/addon-namespace": "cluster1",
},
},
Spec: v1.ManifestWorkSpec{},
Status: v1.ManifestWorkStatus{
ResourceStatus: v1.ManifestResourceStatus{
Manifests: []v1.ManifestCondition{
{
ResourceMeta: v1.ManifestResourceMeta{
Ordinal: 0,
Group: "apps",
Version: "",
Kind: "",
Resource: "deployments",
Name: "test-deployment",
Namespace: "default",
},
StatusFeedbacks: v1.StatusFeedbackResult{
Values: []v1.FeedbackValue{
{
Name: "Replicas",
Value: v1.FieldValue{
Integer: boolPtr(2),
},
},
{
Name: "ReadyReplicas",
Value: v1.FieldValue{
Integer: boolPtr(2),
},
},
},
},
},
{
ResourceMeta: v1.ManifestResourceMeta{
Ordinal: 0,
Group: "apps",
Version: "",
Kind: "",
Resource: "deployments",
Name: "test-deployment-replicas-not-set",
Namespace: "default",
},
StatusFeedbacks: v1.StatusFeedbackResult{
Values: []v1.FeedbackValue{
{
Name: "Replicas",
Value: v1.FieldValue{
Integer: boolPtr(1),
},
},
{
Name: "ReadyReplicas",
Value: v1.FieldValue{
Integer: boolPtr(1),
},
},
},
},
},
{
ResourceMeta: v1.ManifestResourceMeta{
Ordinal: 0,
Group: "apps",
Version: "",
Kind: "",
Resource: "daemonsets",
Name: "test-daemonset",
Namespace: "default",
},
StatusFeedbacks: v1.StatusFeedbackResult{
Values: []v1.FeedbackValue{
{
Name: "DesiredNumberScheduled",
Value: v1.FieldValue{
Integer: boolPtr(2),
},
},
{
Name: "NumberReady",
Value: v1.FieldValue{
Integer: boolPtr(2),
},
},
},
},
},
},
},
Conditions: []metav1.Condition{
{
Type: v1.WorkAvailable,
Status: metav1.ConditionTrue,
},
},
},
},
},
expectedErr: nil,
expectedHealthCheckMode: addonapiv1alpha1.HealthCheckModeCustomized,
expectAvailableCondition: metav1.Condition{
Type: addonapiv1alpha1.ManagedClusterAddOnConditionAvailable,
Status: metav1.ConditionTrue,
Reason: addonapiv1alpha1.AddonAvailableReasonProbeAvailable,
Message: "test add-on is available.",
},
},
}

for _, c := range cases {
Expand Down Expand Up @@ -1134,8 +1258,9 @@ func TestHealthCheckReconcile(t *testing.T) {
}

healthCheckSyncer := healthCheckSyncer{
getWorkByAddon: addonDeploymentController.getWorksByAddonFn(index.ManifestWorkByAddon),
agentAddon: addonDeploymentController.agentAddons[c.testAddon.name],
getWorkByAddon: addonDeploymentController.getWorksByAddonFn(index.ManifestWorkByAddon),
getWorkByHostedAddon: addonDeploymentController.getWorksByAddonFn(index.ManifestWorkByHostedAddon),
agentAddon: addonDeploymentController.agentAddons[c.testAddon.name],
}

addon, err := healthCheckSyncer.sync(context.TODO(), addontesting.NewFakeSyncContext(t), c.cluster, c.addon)
Expand Down
3 changes: 3 additions & 0 deletions test/integration/cloudevents/suite_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ var _ = ginkgo.BeforeSuite(func(done ginkgo.Done) {
name: "test",
manifests: map[string][]runtime.Object{},
registrations: map[string][]addonapiv1alpha1.RegistrationConfig{},
hostInfoFn: constants.GetHostedModeInfo,
}

testHostedAddonImpl = &testAddon{
Expand All @@ -152,12 +153,14 @@ var _ = ginkgo.BeforeSuite(func(done ginkgo.Done) {
name: "test-install-all",
manifests: map[string][]runtime.Object{},
registrations: map[string][]addonapiv1alpha1.RegistrationConfig{},
hostInfoFn: constants.GetHostedModeInfo,
}

testMultiWorksAddonImpl = &testAddon{
name: "test-multi-works",
manifests: map[string][]runtime.Object{},
registrations: map[string][]addonapiv1alpha1.RegistrationConfig{},
hostInfoFn: constants.GetHostedModeInfo,
}

mgrCtx, mgrCtxCancel = context.WithCancel(context.TODO())
Expand Down
3 changes: 3 additions & 0 deletions test/integration/kube/suite_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ var _ = ginkgo.BeforeSuite(func(done ginkgo.Done) {
name: "test",
manifests: map[string][]runtime.Object{},
registrations: map[string][]addonapiv1alpha1.RegistrationConfig{},
hostInfoFn: constants.GetHostedModeInfo,
}

testHostedAddonImpl = &testAddon{
Expand All @@ -99,12 +100,14 @@ var _ = ginkgo.BeforeSuite(func(done ginkgo.Done) {
name: "test-install-all",
manifests: map[string][]runtime.Object{},
registrations: map[string][]addonapiv1alpha1.RegistrationConfig{},
hostInfoFn: constants.GetHostedModeInfo,
}

testMultiWorksAddonImpl = &testAddon{
name: "test-multi-works",
manifests: map[string][]runtime.Object{},
registrations: map[string][]addonapiv1alpha1.RegistrationConfig{},
hostInfoFn: constants.GetHostedModeInfo,
}

mgrContext, cancel = context.WithCancel(context.TODO())
Expand Down