trainer/pkg/runtime/framework/interface.go

68 lines
1.8 KiB
Go

/*
Copyright 2024 The Kubeflow 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 framework
import (
"context"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/validation/field"
"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
trainer "github.com/kubeflow/trainer/pkg/apis/trainer/v1alpha1"
"github.com/kubeflow/trainer/pkg/runtime"
)
type Plugin interface {
Name() string
}
type CustomValidationPlugin interface {
Plugin
Validate(info *runtime.Info, oldObj, newObj *trainer.TrainJob) (admission.Warnings, field.ErrorList)
}
type WatchExtensionPlugin interface {
Plugin
ReconcilerBuilders() []runtime.ReconcilerBuilder
}
type EnforcePodGroupPolicyPlugin interface {
Plugin
EnforcePodGroupPolicy(info *runtime.Info, trainJob *trainer.TrainJob) error
}
type EnforceMLPolicyPlugin interface {
Plugin
EnforceMLPolicy(info *runtime.Info, trainJob *trainer.TrainJob) error
}
type PodNetworkPlugin interface {
Plugin
IdentifyPodNetwork(info *runtime.Info, trainJob *trainer.TrainJob) error
}
type ComponentBuilderPlugin interface {
Plugin
Build(ctx context.Context, info *runtime.Info, trainJob *trainer.TrainJob) ([]any, error)
}
type TerminalConditionPlugin interface {
Plugin
TerminalCondition(ctx context.Context, trainJob *trainer.TrainJob) (*metav1.Condition, error)
}