Volcano API 体系概览

package v1alpha1

import (
    metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
    "k8s.io/apimachinery/pkg/runtime"
    "k8s.io/apimachinery/pkg/runtime/schema"
)

// GroupName 是该 API Group 的名称
const GroupName = "batch.volcano.sh"

// SchemeGroupVersion 是用于注册类型的 Group Version
var SchemeGroupVersion = schema.GroupVersion{
    Group:   GroupName,
    Version: "v1alpha1",
}

var (
    // SchemeBuilder 用于将类型添加到 Scheme
    SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
    // AddToScheme 将所有存储的函数应用到 Scheme
    AddToScheme = SchemeBuilder.AddToScheme
)

// addKnownTypes 将本包定义的类型添加到 Scheme
func addKnownTypes(scheme *runtime.Scheme) error {
    scheme.AddKnownTypes(SchemeGroupVersion,
        &Job{},
        &JobList{},
        &CronJob{},
        &CronJobList{},
    )
    metav1.AddToGroupVersion(scheme, SchemeGroupVersion)
    return nil
}

// go.mod
module volcano.sh/volcano

go 1.24.0

require (
    volcano.sh/apis v0.0.0
    // ...
)

replace (
    volcano.sh/apis => ./staging/src/volcano.sh/apis
    // ...
)

// +genclient                    - 生成 typed client
// +genclient:nonNamespaced      - 生成 cluster-scoped client
// +k8s:deepcopy-gen:interfaces  - 生成 DeepCopy 接口实现
// +kubebuilder:object:root=true - 标记为根对象
// +kubebuilder:resource:path=   - 指定资源路径和 shortName
// +kubebuilder:subresource:status - 启用 status 子资源
// +kubebuilder:printcolumn:     - 定义 kubectl get 输出列
// +kubebuilder:validation:      - 字段验证规则
// +kubebuilder:default:         - 字段默认值

// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +kubebuilder:object:root=true
// +kubebuilder:resource:path=jobs,shortName=vcjob;vj
// +kubebuilder:subresource:status
// +kubebuilder:printcolumn:name="STATUS",type=string,JSONPath=`.status.state.phase`
// +kubebuilder:printcolumn:name="minAvailable",type=integer,JSONPath=`.status.minAvailable`
// +kubebuilder:printcolumn:name="RUNNINGS",type=integer,JSONPath=`.status.running`
// +kubebuilder:printcolumn:name="AGE",type=date,JSONPath=`.metadata.creationTimestamp`
// +kubebuilder:printcolumn:name="QUEUE",type=string,priority=1,JSONPath=`.spec.queue`
type Job struct {
    metav1.TypeMeta   `json:",inline"`
    metav1.ObjectMeta `json:"metadata,omitempty"`
    Spec   JobSpec    `json:"spec,omitempty"`
    Status JobStatus  `json:"status,omitempty"`
}

import (
    volcanoClient "volcano.sh/apis/pkg/client/clientset/versioned"
)

// 创建 Volcano Clientset
client, err := volcanoClient.NewForConfig(config)

// 操作 Job 资源
job, err := client.BatchV1alpha1().Jobs("default").Get(ctx, "my-job", metav1.GetOptions{})

// 操作 Queue 资源 (cluster-scoped)
queue, err := client.SchedulingV1beta1().Queues().List(ctx, metav1.ListOptions{})

// 操作 PodGroup 资源
pg, err := client.SchedulingV1beta1().PodGroups("default").Get(ctx, "my-pg", metav1.GetOptions{})

import (
    informers "volcano.sh/apis/pkg/client/informers/externalversions"
)

// 创建 SharedInformerFactory
factory := informers.NewSharedInformerFactory(client, 0)

// 获取 Job Informer
jobInformer := factory.Batch().V1alpha1().Jobs()

// 获取 Queue Lister
queueLister := factory.Scheduling().V1beta1().Queues().Lister()

// 启动 Informer
factory.Start(stopCh)
factory.WaitForCacheSync(stopCh)