volcano.sh/volcano@v1.9.0/pkg/controllers/framework/interface.go (about)

     1  /*
     2  Copyright 2020 The Volcano Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package framework
    18  
    19  import (
    20  	"k8s.io/client-go/informers"
    21  	"k8s.io/client-go/kubernetes"
    22  
    23  	vcclientset "volcano.sh/apis/pkg/client/clientset/versioned"
    24  )
    25  
    26  // ControllerOption is the main context object for the controllers.
    27  type ControllerOption struct {
    28  	KubeClient            kubernetes.Interface
    29  	VolcanoClient         vcclientset.Interface
    30  	SharedInformerFactory informers.SharedInformerFactory
    31  	SchedulerNames        []string
    32  	WorkerNum             uint32
    33  	MaxRequeueNum         int
    34  
    35  	InheritOwnerAnnotations bool
    36  	WorkerThreadsForPG      uint32
    37  }
    38  
    39  // Controller is the interface of all controllers.
    40  type Controller interface {
    41  	Name() string
    42  	Initialize(opt *ControllerOption) error
    43  	// Run run the controller
    44  	Run(stopCh <-chan struct{})
    45  }