Add hyperNode controller framework and provider

Signed-off-by: Monokaix <changxuzheng@huawei.com>

Author: Monokaix

pkg/controllers/hypernode/hypernode_controller.go

@@ -0,0 +1,73 @@
+/*
+Copyright 2025 The Volcano Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package hypernode
+
+import (
+	"k8s.io/klog/v2"
+	vcclientset "volcano.sh/apis/pkg/client/clientset/versioned"
+	vcinformer "volcano.sh/apis/pkg/client/informers/externalversions"
+	topologyinformerv1alpha1 "volcano.sh/apis/pkg/client/informers/externalversions/topology/v1alpha1"
+	topologylisterv1alpha1 "volcano.sh/apis/pkg/client/listers/topology/v1alpha1"
+
+	"volcano.sh/volcano/pkg/controllers/framework"
+	"volcano.sh/volcano/pkg/controllers/hypernode/provider"
+)
+
+func init() {
+	framework.RegisterController(&hyperNodeController{})
+}
+
+const (
+	name = "hyperNode-controller"
+)
+
+type hyperNodeController struct {
+	vcClient          vcclientset.Interface
+	vcInformerFactory vcinformer.SharedInformerFactory
+	hyperNodeInformer topologyinformerv1alpha1.HyperNodeInformer
+	hyperNodeLister   topologylisterv1alpha1.HyperNodeLister
+	provider          provider.Provider
+}
+
+// Run starts the hyperNode controller.
+func (hn *hyperNodeController) Run(stopCh <-chan struct{}) {
+	hn.vcInformerFactory.Start(stopCh)
+	for informerType, ok := range hn.vcInformerFactory.WaitForCacheSync(stopCh) {
+		if !ok {
+			klog.ErrorS(nil, "Failed to sync cache", "type", informerType)
+			return
+		}
+	}
+
+	go hn.provider.Provision(stopCh)
+}
+
+// Name returns the name of the hyperNode controller.
+func (hn *hyperNodeController) Name() string {
+	return name
+}
+
+// Initialize initializes the hyperNode controller.
+func (hn *hyperNodeController) Initialize(opt *framework.ControllerOption) error {
+	hn.vcClient = opt.VolcanoClient
+	factory := opt.VCSharedInformerFactory
+	hn.vcInformerFactory = factory
+	hn.hyperNodeInformer = factory.Topology().V1alpha1().HyperNodes()
+	hn.hyperNodeLister = hn.hyperNodeInformer.Lister()
+	hn.provider = provider.NewProvider(hn.vcClient, factory)
+	return nil
+}

pkg/controllers/hypernode/provider/example_provider.go

@@ -0,0 +1,87 @@
+/*
+Copyright 2025 The Volcano Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package provider
+
+import (
+	"fmt"
+	"time"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"volcano.sh/apis/pkg/apis/topology/v1alpha1"
+	topologyinformerv1alpha1 "volcano.sh/apis/pkg/client/informers/externalversions/topology/v1alpha1"
+)
+
+// ExampleProvider is an example provider of hyperNodes.
+type ExampleProvider struct {
+	hyperNodeInformer topologyinformerv1alpha1.HyperNodeInformer
+}
+
+// Name returns the name of the vendor.
+func (e *ExampleProvider) Name() string {
+	return "ExampleProvider"
+}
+
+// Start starts the vendor provider.
+func (e *ExampleProvider) Start(eventCh chan<- Event, controlCh <-chan Reply, informer topologyinformerv1alpha1.HyperNodeInformer) error {
+	e.hyperNodeInformer = informer
+	go func() {
+		for {
+			select {
+			default:
+				event := Event{
+					Type: EventAdd,
+					HyperNode: v1alpha1.HyperNode{
+						Spec: v1alpha1.HyperNodeSpec{
+							Tier: 1,
+							Members: []v1alpha1.MemberSpec{
+								{
+									Type: v1alpha1.MemberTypeNode,
+									Selector: v1alpha1.MemberSelector{
+										ExactMatch: &v1alpha1.ExactMatch{
+											Name: "node-1",
+										},
+									},
+								},
+							},
+						},
+						Status: v1alpha1.HyperNodeStatus{
+							NodeCount: 1,
+							Conditions: []metav1.Condition{
+								{
+									Type:    "Ready",
+									Status:  metav1.ConditionTrue,
+									Reason:  "NodeAdded",
+									Message: "Node added successfully",
+								},
+							},
+						},
+					},
+				}
+				eventCh <- event
+				time.Sleep(5 * time.Second)
+			}
+		}
+	}()
+
+	return nil
+}
+
+// Stop stops the provider.
+func (e *ExampleProvider) Stop() error {
+	fmt.Println("ExampleProvider stopped")
+	return nil
+}

pkg/controllers/hypernode/provider/interface.go

@@ -0,0 +1,67 @@
+/*
+Copyright 2025 The Volcano Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package provider
+
+import (
+	topologyv1alpha1 "volcano.sh/apis/pkg/apis/topology/v1alpha1"
+	topologyapplyv1alpha1 "volcano.sh/apis/pkg/client/applyconfiguration/topology/v1alpha1"
+	topologyinformerv1alpha1 "volcano.sh/apis/pkg/client/informers/externalversions/topology/v1alpha1"
+)
+
+// EventType defines the event type.
+type EventType string
+
+const (
+	// EventAdd is the event type for adding hyperNode.
+	EventAdd EventType = "Add"
+	// EventUpdate is the event type for updating hyperNode.
+	EventUpdate EventType = "Update"
+	// EventDelete is the event type for deleting hyperNode.
+	EventDelete EventType = "Delete"
+)
+
+// Event defines the event from hyperNode provider.
+type Event struct {
+	// Type is the event type.
+	Type EventType
+	// HyperNodeName is the name of the hyperNode event.
+	HyperNodeName string
+	// HyperNode is the hyperNode object to add.
+	HyperNode topologyv1alpha1.HyperNode
+	// Patch is the hyperNode apply configuration, only used for update event.
+	Patch topologyapplyv1alpha1.HyperNodeApplyConfiguration
+}
+
+// Reply is the reply message to hyperNode provider when processed hyperNode event failed,
+// and vendor should be aware of that and retry or som.
+type Reply struct {
+	// HyperNodeName is the name of the hyperNode.
+	HyperNodeName string
+	// Error is the error message of hyperNode event processing.
+	Error error
+}
+
+// Plugin is the interface for the hyperNode provider, vendors should implement this
+// and hyperNode controller call the plugin to populate hyperNodes.
+type Plugin interface {
+	// Name is the name of the plugin.
+	Name() string
+	// Start starts the plugin.
+	Start(eventCh chan<- Event, controlCh <-chan Reply, informer topologyinformerv1alpha1.HyperNodeInformer) error
+	// Stop stops the plugin.
+	Stop() error
+}