Files
kuberay/ray-operator/controllers/ray/rayservice_controller.go
bruceandGitHub ce84f0441c RayCluster created by RayService set death info env for ray container (#419)
* RayCluster created by RayService set death info env for ray container

* update
2022-07-26 15:29:15 -07:00

829 lines
36 KiB
Go

package ray
import (
"context"
"fmt"
"strings"
"time"
"k8s.io/apimachinery/pkg/util/json"
"k8s.io/apimachinery/pkg/util/yaml"
networkingv1 "k8s.io/api/networking/v1"
"github.com/ray-project/kuberay/ray-operator/controllers/ray/common"
cmap "github.com/orcaman/concurrent-map"
"github.com/go-logr/logr"
fmtErrors "github.com/pkg/errors"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/tools/record"
"sigs.k8s.io/controller-runtime/pkg/manager"
"github.com/ray-project/kuberay/ray-operator/controllers/ray/utils"
"k8s.io/apimachinery/pkg/runtime"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
rayv1alpha1 "github.com/ray-project/kuberay/ray-operator/apis/ray/v1alpha1"
)
// This variable is mutable for unit testing purpose.
var ServiceUnhealthySecondThreshold = 60.0 // Serve deployment related health check.
const (
ServiceDefaultRequeueDuration = 2 * time.Second
ServiceRestartRequeueDuration = 10 * time.Second
DeploymentUnhealthySecondThreshold = 60.0 // Dashboard agent related health check.
)
// RayServiceReconciler reconciles a RayService object
type RayServiceReconciler struct {
client.Client
Scheme *runtime.Scheme
Log logr.Logger
Recorder record.EventRecorder
// Now Ray dashboard does not cache serve deployment config. To avoid updating the same config repeatedly, cache the Serve Deployment config in this map.
ServeDeploymentConfigs cmap.ConcurrentMap
}
// NewRayServiceReconciler returns a new reconcile.Reconciler
func NewRayServiceReconciler(mgr manager.Manager) *RayServiceReconciler {
return &RayServiceReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
Log: ctrl.Log.WithName("controllers").WithName("RayService"),
Recorder: mgr.GetEventRecorderFor("rayservice-controller"),
ServeDeploymentConfigs: cmap.New(),
}
}
// +kubebuilder:rbac:groups=ray.io,resources=rayservices,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=ray.io,resources=rayservices/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=ray.io,resources=rayservices/finalizers,verbs=update
// +kubebuilder:rbac:groups=ray.io,resources=rayclusters,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=ray.io,resources=rayclusters/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=ray.io,resources=rayclusters/finalizer,verbs=update
// +kubebuilder:rbac:groups=core,resources=events,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=core,resources=pods,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=core,resources=pods/status,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=core,resources=services,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=core,resources=services/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=coordination.k8s.io,resources=leases,verbs=get;list;create;update
// +kubebuilder:rbac:groups=networking.k8s.io,resources=ingressclasses,verbs=get;list;watch
// +kubebuilder:rbac:groups=networking.k8s.io,resources=ingresses,verbs=get;list;watch;create;update;delete;patch
// +kubebuilder:rbac:groups=extensions,resources=ingresses,verbs=get;list;watch;create;update;delete;patch
// +kubebuilder:rbac:groups=core,resources=serviceaccounts,verbs=get;list;watch;create;delete
// +kubebuilder:rbac:groups="rbac.authorization.k8s.io",resources=roles,verbs=get;list;watch;create;delete;update
// +kubebuilder:rbac:groups="rbac.authorization.k8s.io",resources=rolebindings,verbs=get;list;watch;create;delete
// Reconcile is part of the main kubernetes reconciliation loop which aims to
// move the current state of the cluster closer to the desired state.
//
// This the top level reconciliation flow for RayService.
//
// For more details, check Reconcile and its Result here:
// - https://pkg.go.dev/sigs.k8s.io/[email protected]/pkg/reconcile
func (r *RayServiceReconciler) Reconcile(ctx context.Context, request ctrl.Request) (ctrl.Result, error) {
logger := r.Log.WithValues("ServiceName", request.NamespacedName)
var isHealthy bool = false
var rayServiceInstance *rayv1alpha1.RayService
var err error
var ctrlResult ctrl.Result
// Resolve the CR from request.
if rayServiceInstance, err = r.getRayServiceInstance(ctx, request); err != nil {
return ctrl.Result{}, client.IgnoreNotFound(err)
}
r.cleanUpServeConfigCache(rayServiceInstance)
logger.Info("Reconciling the cluster component.")
// Find active and pending ray cluster objects given current service name.
var activeRayClusterInstance *rayv1alpha1.RayCluster
var pendingRayClusterInstance *rayv1alpha1.RayCluster
if activeRayClusterInstance, pendingRayClusterInstance, err = r.reconcileRayCluster(ctx, rayServiceInstance); err != nil {
err = r.updateState(ctx, rayServiceInstance, rayv1alpha1.FailedToGetOrCreateRayCluster, err)
return ctrl.Result{RequeueAfter: ServiceDefaultRequeueDuration}, client.IgnoreNotFound(err)
}
// Check if we need to create pending RayCluster.
if rayServiceInstance.Status.PendingServiceStatus.RayClusterName != "" && pendingRayClusterInstance == nil {
// Update RayService Status since reconcileRayCluster may mark RayCluster restart.
if errStatus := r.Status().Update(ctx, rayServiceInstance); errStatus != nil {
logger.Error(errStatus, "Fail to update status of RayService after RayCluster changes", "rayServiceInstance", rayServiceInstance)
return ctrl.Result{RequeueAfter: ServiceDefaultRequeueDuration}, nil
}
logger.Info("Done reconcileRayCluster update status, enter next loop to create new ray cluster.")
return ctrl.Result{RequeueAfter: ServiceDefaultRequeueDuration}, nil
}
logger.Info("Reconciling the Serve component.")
/*
Update ray cluster for 4 possible situations.
If a ray cluster does not exist, clear its status.
If only one ray cluster exists, do serve deployment if needed and check dashboard, serve deployment health.
If both ray clusters exist, update active cluster status and do the pending cluster deployment and health check.
*/
if activeRayClusterInstance != nil && pendingRayClusterInstance == nil {
rayServiceInstance.Status.PendingServiceStatus = rayv1alpha1.RayServiceStatus{}
if ctrlResult, isHealthy, err = r.reconcileServe(ctx, rayServiceInstance, activeRayClusterInstance, true, logger); err != nil {
logger.Error(err, "Fail to reconcileServe.")
return ctrlResult, nil
}
} else if activeRayClusterInstance != nil && pendingRayClusterInstance != nil {
if err = r.updateStatusForActiveCluster(ctx, rayServiceInstance, activeRayClusterInstance, logger); err != nil {
logger.Error(err, "The updating of the status for active ray cluster while we have pending cluster failed")
}
if ctrlResult, isHealthy, err = r.reconcileServe(ctx, rayServiceInstance, pendingRayClusterInstance, false, logger); err != nil {
logger.Error(err, "Fail to reconcileServe.")
return ctrlResult, nil
}
} else if activeRayClusterInstance == nil && pendingRayClusterInstance != nil {
rayServiceInstance.Status.ActiveServiceStatus = rayv1alpha1.RayServiceStatus{}
if ctrlResult, isHealthy, err = r.reconcileServe(ctx, rayServiceInstance, pendingRayClusterInstance, false, logger); err != nil {
logger.Error(err, "Fail to reconcileServe.")
return ctrlResult, nil
}
} else {
rayServiceInstance.Status.ActiveServiceStatus = rayv1alpha1.RayServiceStatus{}
rayServiceInstance.Status.PendingServiceStatus = rayv1alpha1.RayServiceStatus{}
}
if !isHealthy {
logger.Info(fmt.Sprintf("Cluster is not healthy, checking again in %s", ServiceRestartRequeueDuration))
r.Recorder.Eventf(rayServiceInstance, "Normal", "ServiceUnhealthy", "The service is in an unhealthy state. Controller will perform a round of actions in %s.", ServiceRestartRequeueDuration)
return ctrl.Result{RequeueAfter: ServiceRestartRequeueDuration}, nil
}
logger.Info("Reconciling the ingress and service resources.")
// Get the healthy ray cluster instance for service and ingress update.
rayClusterInstance := activeRayClusterInstance
if pendingRayClusterInstance != nil {
rayClusterInstance = pendingRayClusterInstance
}
if rayClusterInstance != nil {
if err := r.reconcileIngress(ctx, rayServiceInstance, rayClusterInstance); err != nil {
err = r.updateState(ctx, rayServiceInstance, rayv1alpha1.FailedToUpdateIngress, err)
return ctrl.Result{RequeueAfter: ServiceDefaultRequeueDuration}, err
}
if err := r.reconcileServices(ctx, rayServiceInstance, rayClusterInstance, common.HeadService); err != nil {
err = r.updateState(ctx, rayServiceInstance, rayv1alpha1.FailedToUpdateService, err)
return ctrl.Result{RequeueAfter: ServiceDefaultRequeueDuration}, err
}
if err := r.labelHealthyServePods(ctx, rayClusterInstance); err != nil {
err = r.updateState(ctx, rayServiceInstance, rayv1alpha1.FailedToUpdateServingPodLabel, err)
return ctrl.Result{RequeueAfter: ServiceDefaultRequeueDuration}, err
}
if err := r.reconcileServices(ctx, rayServiceInstance, rayClusterInstance, common.ServingService); err != nil {
err = r.updateState(ctx, rayServiceInstance, rayv1alpha1.FailedToUpdateService, err)
return ctrl.Result{RequeueAfter: ServiceDefaultRequeueDuration}, err
}
}
// Final status update for any CR modification.
if errStatus := r.Status().Update(ctx, rayServiceInstance); errStatus != nil {
logger.Error(errStatus, "Fail to update status of RayService", "rayServiceInstance", rayServiceInstance)
return ctrl.Result{RequeueAfter: ServiceDefaultRequeueDuration}, err
}
return ctrl.Result{RequeueAfter: ServiceDefaultRequeueDuration}, nil
}
// SetupWithManager sets up the controller with the Manager.
func (r *RayServiceReconciler) SetupWithManager(mgr ctrl.Manager) error {
return ctrl.NewControllerManagedBy(mgr).
For(&rayv1alpha1.RayService{}).
Owns(&rayv1alpha1.RayCluster{}).
Owns(&corev1.Service{}).
Owns(&networkingv1.Ingress{}).
Complete(r)
}
func (r *RayServiceReconciler) getRayServiceInstance(ctx context.Context, request ctrl.Request) (*rayv1alpha1.RayService, error) {
rayServiceInstance := &rayv1alpha1.RayService{}
if err := r.Get(ctx, request.NamespacedName, rayServiceInstance); err != nil {
if errors.IsNotFound(err) {
r.Log.Info("Read request instance not found error!")
} else {
r.Log.Error(err, "Read request instance error!")
}
return nil, err
}
return rayServiceInstance, nil
}
func (r *RayServiceReconciler) updateState(ctx context.Context, rayServiceInstance *rayv1alpha1.RayService, status rayv1alpha1.ServiceStatus, err error) error {
rayServiceInstance.Status.ServiceStatus = status
if errStatus := r.Status().Update(ctx, rayServiceInstance); errStatus != nil {
return fmtErrors.Errorf("combined error: %v %v", err, errStatus)
}
r.Recorder.Event(rayServiceInstance, "Normal", string(status), err.Error())
return err
}
// reconcileRayCluster checks the active and pending ray cluster instances. It includes 3 parts.
// 1. It will decide whether to generate a pending cluster name.
// 2. It will delete the old pending ray cluster instance.
// 3. It will create a new pending ray cluster instance.
func (r *RayServiceReconciler) reconcileRayCluster(ctx context.Context, rayServiceInstance *rayv1alpha1.RayService) (*rayv1alpha1.RayCluster, *rayv1alpha1.RayCluster, error) {
var err error
if err = r.cleanUpRayClusterInstance(ctx, rayServiceInstance); err != nil {
return nil, nil, err
}
// Get active cluster and pending cluster instances.
activeRayCluster, err := r.getRayClusterByNamespacedName(ctx, client.ObjectKey{Name: rayServiceInstance.Status.ActiveServiceStatus.RayClusterName, Namespace: rayServiceInstance.Namespace})
if err != nil {
return nil, nil, err
}
pendingRayCluster, err := r.getRayClusterByNamespacedName(ctx, client.ObjectKey{Name: rayServiceInstance.Status.PendingServiceStatus.RayClusterName, Namespace: rayServiceInstance.Namespace})
if err != nil {
return nil, nil, err
}
if r.shouldPrepareNewRayCluster(rayServiceInstance, activeRayCluster) {
r.markRestart(rayServiceInstance)
return activeRayCluster, nil, nil
}
if pendingRayCluster, err = r.createRayClusterInstanceIfNeeded(ctx, rayServiceInstance, pendingRayCluster); err != nil {
return nil, nil, err
}
return activeRayCluster, pendingRayCluster, nil
}
// cleanUpRayClusterInstance cleans up all the dangling RayCluster instances that are owned by the RayService instance.
func (r *RayServiceReconciler) cleanUpRayClusterInstance(ctx context.Context, rayServiceInstance *rayv1alpha1.RayService) error {
rayClusterList := rayv1alpha1.RayClusterList{}
filterLabels := client.MatchingLabels{common.RayServiceLabelKey: rayServiceInstance.Name}
var err error
if err = r.List(ctx, &rayClusterList, client.InNamespace(rayServiceInstance.Namespace), filterLabels); err != nil {
r.Log.Error(err, "Fail to list RayCluster for "+rayServiceInstance.Name)
return err
}
// Clean up RayCluster instances.
for _, rayClusterInstance := range rayClusterList.Items {
if rayClusterInstance.Name != rayServiceInstance.Status.ActiveServiceStatus.RayClusterName && rayClusterInstance.Name != rayServiceInstance.Status.PendingServiceStatus.RayClusterName {
r.Log.V(1).Info("reconcileRayCluster", "delete ray cluster", rayClusterInstance.Name)
if err := r.Delete(ctx, &rayClusterInstance, client.PropagationPolicy(metav1.DeletePropagationBackground)); err != nil {
r.Log.Error(err, "Fail to delete RayCluster "+rayClusterInstance.Name)
return err
}
}
}
return nil
}
func (r *RayServiceReconciler) getRayClusterByNamespacedName(ctx context.Context, clusterKey client.ObjectKey) (*rayv1alpha1.RayCluster, error) {
rayCluster := &rayv1alpha1.RayCluster{}
if clusterKey.Name != "" {
// Ignore not found since in that case we should return RayCluster as nil.
if err := r.Get(ctx, clusterKey, rayCluster); client.IgnoreNotFound(err) != nil {
r.Log.Error(err, "Fail to get RayCluster "+clusterKey.String())
return nil, err
}
} else {
rayCluster = nil
}
return rayCluster, nil
}
// cleanUpServeConfigCache cleans up the unused serve deployments config in the cached map.
func (r *RayServiceReconciler) cleanUpServeConfigCache(rayServiceInstance *rayv1alpha1.RayService) {
activeConfigKey := r.generateConfigKey(rayServiceInstance, rayServiceInstance.Status.ActiveServiceStatus.RayClusterName)
pendingConfigKey := r.generateConfigKey(rayServiceInstance, rayServiceInstance.Status.PendingServiceStatus.RayClusterName)
configPrefix := r.generateConfigKeyPrefix(rayServiceInstance)
// Clean up RayCluster serve deployment configs.
for key := range r.ServeDeploymentConfigs.Items() {
if key == activeConfigKey || key == pendingConfigKey {
continue
}
if !strings.HasPrefix(key, configPrefix) {
// Skip configs owned by other RayService Instance.
continue
}
r.Log.V(1).Info("cleanUpServeConfigCache", "activeConfigKey", activeConfigKey, "pendingConfigKey", pendingConfigKey, "remove key", key)
r.ServeDeploymentConfigs.Remove(key)
}
}
// shouldPrepareNewRayCluster checks if we need to generate a new pending cluster.
func (r *RayServiceReconciler) shouldPrepareNewRayCluster(rayServiceInstance *rayv1alpha1.RayService, activeRayCluster *rayv1alpha1.RayCluster) bool {
shouldPrepareRayCluster := false
if rayServiceInstance.Status.PendingServiceStatus.RayClusterName == "" {
// Prepare new RayCluster if:
// 1. No active and pending cluster
// 2. No pending cluster, and the active RayCluster has changed.
if activeRayCluster == nil || !utils.CompareJsonStruct(activeRayCluster.Spec, rayServiceInstance.Spec.RayClusterSpec) {
shouldPrepareRayCluster = true
}
}
return shouldPrepareRayCluster
}
// createRayClusterInstanceIfNeeded checks if we need to create a new RayCluster instance. If so, create one.
func (r *RayServiceReconciler) createRayClusterInstanceIfNeeded(ctx context.Context, rayServiceInstance *rayv1alpha1.RayService, pendingRayCluster *rayv1alpha1.RayCluster) (*rayv1alpha1.RayCluster, error) {
if rayServiceInstance.Status.PendingServiceStatus.RayClusterName == "" {
// No exist pending RayCluster and no need to create one.
return nil, nil
}
var err error
// Create a new RayCluster if:
// 1. No RayCluster pending.
// 2. Config update for the pending cluster.
if pendingRayCluster == nil || !utils.CompareJsonStruct(pendingRayCluster.Spec, rayServiceInstance.Spec.RayClusterSpec) {
pendingRayCluster, err = r.createRayClusterInstance(ctx, rayServiceInstance, rayServiceInstance.Status.PendingServiceStatus.RayClusterName)
if err != nil {
return nil, err
}
}
return pendingRayCluster, nil
}
// createRayClusterInstance deletes the old RayCluster instance if exists. Only when no existing RayCluster, create a new RayCluster instance.
// One important part is that if this method deletes the old RayCluster, it will return instantly. It depends on the controller to call it again to generate the new RayCluster instance.
func (r *RayServiceReconciler) createRayClusterInstance(ctx context.Context, rayServiceInstance *rayv1alpha1.RayService, rayClusterInstanceName string) (*rayv1alpha1.RayCluster, error) {
r.Log.V(1).Info("createRayClusterInstance", "rayClusterInstanceName", rayClusterInstanceName)
rayClusterKey := client.ObjectKey{
Namespace: rayServiceInstance.Namespace,
Name: rayClusterInstanceName,
}
rayClusterInstance := &rayv1alpha1.RayCluster{}
var err error
// Loop until there is no pending RayCluster.
err = r.Get(ctx, rayClusterKey, rayClusterInstance)
// If RayCluster exists, it means the config is updated. Delete the previous RayCluster first.
if err == nil {
r.Log.V(1).Info("Ray cluster already exists, config changes. Need to recreate. Delete the pending one now.", "key", rayClusterKey.String(), "rayClusterInstance.Spec", rayClusterInstance.Spec, "rayServiceInstance.Spec.RayClusterSpec", rayServiceInstance.Spec.RayClusterSpec)
delErr := r.Delete(ctx, rayClusterInstance, client.PropagationPolicy(metav1.DeletePropagationBackground))
if delErr == nil {
// Go to next loop and check if the ray cluster is deleted.
return nil, nil
} else if !errors.IsNotFound(delErr) {
return nil, delErr
}
// if error is `not found`, then continue.
} else if !errors.IsNotFound(err) {
r.Log.Error(err, "Get request rayCluster instance error!")
return nil, err
// if error is `not found`, then continue.
}
r.Log.V(1).Info("No pending RayCluster, creating RayCluster.")
rayClusterInstance, err = r.constructRayClusterForRayService(rayServiceInstance, rayClusterInstanceName)
if err != nil {
r.Log.Error(err, "unable to construct rayCluster from spec")
return nil, err
}
if err = r.Create(ctx, rayClusterInstance); err != nil {
r.Log.Error(err, "unable to create rayCluster for rayService", "rayCluster", rayClusterInstance)
return nil, err
}
r.Log.V(1).Info("created rayCluster for rayService", "rayCluster", rayClusterInstance)
return rayClusterInstance, nil
}
func (r *RayServiceReconciler) constructRayClusterForRayService(rayService *rayv1alpha1.RayService, rayClusterName string) (*rayv1alpha1.RayCluster, error) {
rayClusterLabel := make(map[string]string)
for k, v := range rayService.Labels {
rayClusterLabel[k] = v
}
rayClusterLabel[common.RayServiceLabelKey] = rayService.Name
rayClusterLabel[common.KubernetesCreatedByLabelKey] = common.RayServiceCreatorLabelValue
rayClusterAnnotations := make(map[string]string)
for k, v := range rayService.Annotations {
rayClusterAnnotations[k] = v
}
rayClusterAnnotations[common.EnableAgentServiceKey] = common.EnableAgentServiceTrue
rayCluster := &rayv1alpha1.RayCluster{
ObjectMeta: metav1.ObjectMeta{
Labels: rayClusterLabel,
Annotations: rayClusterAnnotations,
Name: rayClusterName,
Namespace: rayService.Namespace,
},
Spec: rayService.Spec.RayClusterSpec,
}
// Set the ownership in order to do the garbage collection by k8s.
if err := ctrl.SetControllerReference(rayService, rayCluster, r.Scheme); err != nil {
return nil, err
}
return rayCluster, nil
}
func (r *RayServiceReconciler) checkIfNeedSubmitServeDeployment(rayServiceInstance *rayv1alpha1.RayService, rayClusterInstance *rayv1alpha1.RayCluster, serveStatus *rayv1alpha1.RayServiceStatus) bool {
existConfigObj, exist := r.ServeDeploymentConfigs.Get(r.generateConfigKey(rayServiceInstance, rayClusterInstance.Name))
if !exist {
r.Log.V(1).Info("shouldUpdate value, config does not exist")
return true
}
existConfig, ok := existConfigObj.(rayv1alpha1.RayServiceSpec)
shouldUpdate := false
if !ok || !utils.CompareJsonStruct(existConfig, rayServiceInstance.Spec) || len(serveStatus.ServeStatuses) == 0 {
shouldUpdate = true
}
r.Log.V(1).Info("shouldUpdate value", "shouldUpdate", shouldUpdate)
return shouldUpdate
}
func (r *RayServiceReconciler) updateServeDeployment(rayServiceInstance *rayv1alpha1.RayService, rayDashboardClient utils.RayDashboardClientInterface, clusterName string) error {
r.Log.V(1).Info("updateServeDeployment", "config", rayServiceInstance.Spec.ServeDeploymentGraphSpec)
runtimeEnv := make(map[string]interface{})
_ = yaml.Unmarshal([]byte(rayServiceInstance.Spec.ServeDeploymentGraphSpec.RuntimeEnv), &runtimeEnv)
servingClusterDeployments := utils.ServingClusterDeployments{
ImportPath: rayServiceInstance.Spec.ServeDeploymentGraphSpec.ImportPath,
RuntimeEnv: runtimeEnv,
Deployments: rayDashboardClient.ConvertServeConfig(rayServiceInstance.Spec.ServeDeploymentGraphSpec.ServeConfigSpecs),
}
deploymentJson, _ := json.Marshal(servingClusterDeployments)
r.Log.V(1).Info("updateServeDeployment", "json config", string(deploymentJson))
if err := rayDashboardClient.UpdateDeployments(rayServiceInstance.Spec.ServeDeploymentGraphSpec); err != nil {
r.Log.Error(err, "fail to update deployment")
return err
}
r.ServeDeploymentConfigs.Set(r.generateConfigKey(rayServiceInstance, clusterName), rayServiceInstance.Spec)
return nil
}
// getAndCheckServeStatus get app and serve deployments statuses, update the health timestamp and check if RayCluster is overall healthy.
func (r *RayServiceReconciler) getAndCheckServeStatus(dashboardClient utils.RayDashboardClientInterface, rayServiceServeStatus *rayv1alpha1.RayServiceStatus, unhealthySecondThreshold *int32) (bool, error) {
serviceUnhealthySecondThreshold := ServiceUnhealthySecondThreshold
if unhealthySecondThreshold != nil {
serviceUnhealthySecondThreshold = float64(*unhealthySecondThreshold)
}
var serveStatuses *utils.ServeDeploymentStatuses
var err error
if serveStatuses, err = dashboardClient.GetDeploymentsStatus(); err != nil {
r.Log.Error(err, "fail to get deployment status")
return false, err
}
statusMap := make(map[string]rayv1alpha1.ServeDeploymentStatus)
for _, status := range rayServiceServeStatus.ServeStatuses {
statusMap[status.Name] = status
}
isHealthy := true
timeNow := metav1.Now()
for i := 0; i < len(serveStatuses.DeploymentStatuses); i++ {
serveStatuses.DeploymentStatuses[i].LastUpdateTime = &timeNow
serveStatuses.DeploymentStatuses[i].HealthLastUpdateTime = &timeNow
if serveStatuses.DeploymentStatuses[i].Status != "HEALTHY" {
prevStatus, exist := statusMap[serveStatuses.DeploymentStatuses[i].Name]
if exist {
if prevStatus.Status != "HEALTHY" {
serveStatuses.DeploymentStatuses[i].HealthLastUpdateTime = prevStatus.HealthLastUpdateTime
if prevStatus.HealthLastUpdateTime != nil && time.Since(prevStatus.HealthLastUpdateTime.Time).Seconds() > serviceUnhealthySecondThreshold {
isHealthy = false
}
}
}
}
}
// Check app status.
serveStatuses.ApplicationStatus.LastUpdateTime = &timeNow
serveStatuses.ApplicationStatus.HealthLastUpdateTime = &timeNow
if serveStatuses.ApplicationStatus.Status != "HEALTHY" {
// Check previously app status.
if rayServiceServeStatus.ApplicationStatus.Status != "HEALTHY" {
serveStatuses.ApplicationStatus.HealthLastUpdateTime = rayServiceServeStatus.ApplicationStatus.HealthLastUpdateTime
if rayServiceServeStatus.ApplicationStatus.HealthLastUpdateTime != nil && time.Since(rayServiceServeStatus.ApplicationStatus.HealthLastUpdateTime.Time).Seconds() > serviceUnhealthySecondThreshold {
isHealthy = false
}
}
}
rayServiceServeStatus.ServeStatuses = serveStatuses.DeploymentStatuses
rayServiceServeStatus.ApplicationStatus = serveStatuses.ApplicationStatus
r.Log.V(1).Info("getAndCheckServeStatus ", "statusMap", statusMap, "serveStatuses", serveStatuses)
return isHealthy, nil
}
func (r *RayServiceReconciler) allServeDeploymentsHealthy(rayServiceInstance *rayv1alpha1.RayService, rayServiceStatus *rayv1alpha1.RayServiceStatus) bool {
// Check if the serve deployment number is correct.
r.Log.V(1).Info("allServeDeploymentsHealthy", "rayServiceInstance.Status.ServeStatuses", rayServiceStatus.ServeStatuses)
if len(rayServiceStatus.ServeStatuses) == 0 {
return false
}
// Check if all the service deployments are healthy.
for _, status := range rayServiceStatus.ServeStatuses {
if status.Status != "HEALTHY" {
return false
}
}
return true
}
func (r *RayServiceReconciler) generateConfigKey(rayServiceInstance *rayv1alpha1.RayService, clusterName string) string {
return r.generateConfigKeyPrefix(rayServiceInstance) + clusterName
}
func (r *RayServiceReconciler) generateConfigKeyPrefix(rayServiceInstance *rayv1alpha1.RayService) string {
return rayServiceInstance.Namespace + "/" + rayServiceInstance.Name + "/"
}
// Return true if healthy, otherwise false.
func (r *RayServiceReconciler) updateAndCheckDashboardStatus(rayServiceClusterStatus *rayv1alpha1.RayServiceStatus, isHealthy bool, unhealthyThreshold *int32) bool {
timeNow := metav1.Now()
rayServiceClusterStatus.DashboardStatus.LastUpdateTime = &timeNow
rayServiceClusterStatus.DashboardStatus.IsHealthy = isHealthy
if rayServiceClusterStatus.DashboardStatus.HealthLastUpdateTime.IsZero() || isHealthy {
rayServiceClusterStatus.DashboardStatus.HealthLastUpdateTime = &timeNow
}
deploymentUnhealthySecondThreshold := DeploymentUnhealthySecondThreshold
if unhealthyThreshold != nil {
deploymentUnhealthySecondThreshold = float64(*unhealthyThreshold)
}
return time.Since(rayServiceClusterStatus.DashboardStatus.HealthLastUpdateTime.Time).Seconds() <= deploymentUnhealthySecondThreshold
}
func (r *RayServiceReconciler) markRestart(rayServiceInstance *rayv1alpha1.RayService) {
// Generate RayCluster name for pending cluster.
r.Log.V(1).Info("Current cluster is unhealthy, prepare to restart.", "Status", rayServiceInstance.Status)
rayServiceInstance.Status.ServiceStatus = rayv1alpha1.Restarting
rayServiceInstance.Status.PendingServiceStatus = rayv1alpha1.RayServiceStatus{
RayClusterName: utils.GenerateRayClusterName(rayServiceInstance.Name),
}
}
func (r *RayServiceReconciler) updateRayClusterInfo(rayServiceInstance *rayv1alpha1.RayService, healthyClusterName string) {
r.Log.V(1).Info("updateRayClusterInfo", "ActiveRayClusterName", rayServiceInstance.Status.ActiveServiceStatus.RayClusterName, "healthyClusterName", healthyClusterName)
if rayServiceInstance.Status.ActiveServiceStatus.RayClusterName != healthyClusterName {
rayServiceInstance.Status.ActiveServiceStatus = rayServiceInstance.Status.PendingServiceStatus
rayServiceInstance.Status.PendingServiceStatus = rayv1alpha1.RayServiceStatus{}
}
}
// TODO: When start Ingress in RayService, we can disable the Ingress from RayCluster.
func (r *RayServiceReconciler) reconcileIngress(ctx context.Context, rayServiceInstance *rayv1alpha1.RayService, rayClusterInstance *rayv1alpha1.RayCluster) error {
if rayClusterInstance.Spec.HeadGroupSpec.EnableIngress == nil || !*rayClusterInstance.Spec.HeadGroupSpec.EnableIngress {
return nil
}
// Creat Ingress Struct.
ingress, err := common.BuildIngressForRayService(*rayServiceInstance, *rayClusterInstance)
if err != nil {
return err
}
ingress.Name = utils.CheckName(ingress.Name)
// Get Ingress instance.
headIngress := &networkingv1.Ingress{}
err = r.Get(ctx, client.ObjectKey{Name: ingress.Name, Namespace: rayServiceInstance.Namespace}, headIngress)
if err == nil {
// Update Ingress
headIngress.Spec = ingress.Spec
if updateErr := r.Update(ctx, ingress); updateErr != nil {
r.Log.Error(updateErr, "Ingress Update error!", "Ingress.Error", updateErr)
return updateErr
}
} else if errors.IsNotFound(err) {
// Create Ingress
if err := ctrl.SetControllerReference(rayServiceInstance, ingress, r.Scheme); err != nil {
return err
}
if createErr := r.Create(ctx, ingress); createErr != nil {
if errors.IsAlreadyExists(createErr) {
r.Log.Info("Ingress already exists,no need to create")
return nil
}
r.Log.Error(createErr, "Ingress create error!", "Ingress.Error", createErr)
return createErr
}
} else {
r.Log.Error(err, "Ingress get error!")
return err
}
return nil
}
func (r *RayServiceReconciler) reconcileServices(ctx context.Context, rayServiceInstance *rayv1alpha1.RayService, rayClusterInstance *rayv1alpha1.RayCluster, serviceType common.ServiceType) error {
// Creat Service Struct.
var raySvc *corev1.Service
var err error
if serviceType == common.HeadService {
raySvc, err = common.BuildHeadServiceForRayService(*rayServiceInstance, *rayClusterInstance)
} else if serviceType == common.ServingService {
raySvc, err = common.BuildServeServiceForRayService(*rayServiceInstance, *rayClusterInstance)
}
if err != nil {
return err
}
raySvc.Name = utils.CheckName(raySvc.Name)
// Get Service instance.
rayService := &corev1.Service{}
err = r.Get(ctx, client.ObjectKey{Name: raySvc.Name, Namespace: rayServiceInstance.Namespace}, rayService)
if err == nil {
// Update Service
rayService.Spec = raySvc.Spec
r.Log.V(1).Info("reconcileServices update service")
if updateErr := r.Update(ctx, rayService); updateErr != nil {
r.Log.Error(updateErr, "raySvc Update error!", "raySvc.Error", updateErr)
return updateErr
}
} else if errors.IsNotFound(err) {
// Create Service
r.Log.V(1).Info("reconcileServices create service")
if err := ctrl.SetControllerReference(rayServiceInstance, raySvc, r.Scheme); err != nil {
return err
}
if createErr := r.Create(ctx, raySvc); createErr != nil {
if errors.IsAlreadyExists(createErr) {
r.Log.Info("raySvc already exists,no need to create")
return nil
}
r.Log.Error(createErr, "raySvc create error!", "raySvc.Error", createErr)
return createErr
}
} else {
r.Log.Error(err, "raySvc get error!")
return err
}
return nil
}
func (r *RayServiceReconciler) updateStatusForActiveCluster(ctx context.Context, rayServiceInstance *rayv1alpha1.RayService, rayClusterInstance *rayv1alpha1.RayCluster, logger logr.Logger) error {
rayServiceInstance.Status.ActiveServiceStatus.RayClusterStatus = rayClusterInstance.Status
var err error
var clientURL string
rayServiceStatus := &rayServiceInstance.Status.ActiveServiceStatus
if clientURL, err = utils.FetchDashboardAgentURL(ctx, &r.Log, r.Client, rayClusterInstance); err != nil || clientURL == "" {
r.updateAndCheckDashboardStatus(rayServiceStatus, false, rayServiceInstance.Spec.DeploymentUnhealthySecondThreshold)
return err
}
rayDashboardClient := utils.GetRayDashboardClientFunc()
rayDashboardClient.InitClient(clientURL)
var isHealthy bool
if isHealthy, err = r.getAndCheckServeStatus(rayDashboardClient, rayServiceStatus, rayServiceInstance.Spec.ServiceUnhealthySecondThreshold); err != nil {
r.updateAndCheckDashboardStatus(rayServiceStatus, false, rayServiceInstance.Spec.DeploymentUnhealthySecondThreshold)
return err
}
r.updateAndCheckDashboardStatus(rayServiceStatus, true, rayServiceInstance.Spec.DeploymentUnhealthySecondThreshold)
logger.Info("Check serve health", "isHealthy", isHealthy)
return err
}
func (r *RayServiceReconciler) reconcileServe(ctx context.Context, rayServiceInstance *rayv1alpha1.RayService, rayClusterInstance *rayv1alpha1.RayCluster, isActive bool, logger logr.Logger) (ctrl.Result, bool, error) {
rayServiceInstance.Status.ActiveServiceStatus.RayClusterStatus = rayClusterInstance.Status
var err error
var clientURL string
var rayServiceStatus *rayv1alpha1.RayServiceStatus
// Pick up service status to be updated.
if isActive {
rayServiceStatus = &rayServiceInstance.Status.ActiveServiceStatus
} else {
rayServiceStatus = &rayServiceInstance.Status.PendingServiceStatus
}
if clientURL, err = utils.FetchDashboardAgentURL(ctx, &r.Log, r.Client, rayClusterInstance); err != nil || clientURL == "" {
if !r.updateAndCheckDashboardStatus(rayServiceStatus, false, rayServiceInstance.Spec.DeploymentUnhealthySecondThreshold) {
logger.Info("Dashboard is unhealthy, restart the cluster.")
r.markRestart(rayServiceInstance)
}
err = r.updateState(ctx, rayServiceInstance, rayv1alpha1.WaitForDashboard, err)
return ctrl.Result{RequeueAfter: ServiceDefaultRequeueDuration}, false, err
}
rayDashboardClient := utils.GetRayDashboardClientFunc()
rayDashboardClient.InitClient(clientURL)
shouldUpdate := r.checkIfNeedSubmitServeDeployment(rayServiceInstance, rayClusterInstance, rayServiceStatus)
if shouldUpdate {
if err = r.updateServeDeployment(rayServiceInstance, rayDashboardClient, rayClusterInstance.Name); err != nil {
if !r.updateAndCheckDashboardStatus(rayServiceStatus, false, rayServiceInstance.Spec.DeploymentUnhealthySecondThreshold) {
logger.Info("Dashboard is unhealthy, restart the cluster.")
r.markRestart(rayServiceInstance)
}
err = r.updateState(ctx, rayServiceInstance, rayv1alpha1.WaitForServeDeploymentReady, err)
return ctrl.Result{RequeueAfter: ServiceDefaultRequeueDuration}, false, err
}
r.Recorder.Eventf(rayServiceInstance, "Normal", "SubmittedServeDeployment",
"Controller sent API request to update Serve deployments on cluster %s", rayClusterInstance.Name)
}
var isHealthy bool
if isHealthy, err = r.getAndCheckServeStatus(rayDashboardClient, rayServiceStatus, nil); err != nil {
if !r.updateAndCheckDashboardStatus(rayServiceStatus, false, rayServiceInstance.Spec.DeploymentUnhealthySecondThreshold) {
logger.Info("Dashboard is unhealthy, restart the cluster.")
r.markRestart(rayServiceInstance)
}
err = r.updateState(ctx, rayServiceInstance, rayv1alpha1.FailedToGetServeDeploymentStatus, err)
return ctrl.Result{RequeueAfter: ServiceDefaultRequeueDuration}, false, err
}
r.updateAndCheckDashboardStatus(rayServiceStatus, true, rayServiceInstance.Spec.DeploymentUnhealthySecondThreshold)
logger.Info("Check serve health", "isHealthy", isHealthy, "isActive", isActive)
if isHealthy {
rayServiceInstance.Status.ServiceStatus = rayv1alpha1.Running
if r.allServeDeploymentsHealthy(rayServiceInstance, rayServiceStatus) {
// Preparing RayCluster is ready.
r.updateRayClusterInfo(rayServiceInstance, rayClusterInstance.Name)
r.Recorder.Event(rayServiceInstance, "Normal", "Running", "The Serve applicaton is now running and healthy.")
}
} else {
r.markRestart(rayServiceInstance)
rayServiceInstance.Status.ServiceStatus = rayv1alpha1.Restarting
if err := r.Status().Update(ctx, rayServiceInstance); err != nil {
return ctrl.Result{RequeueAfter: ServiceDefaultRequeueDuration}, false, err
}
logger.Info("Mark cluster as unhealthy", "rayCluster", rayClusterInstance)
r.Recorder.Eventf(rayServiceInstance, "Normal", "Restarting", "The cluster will restart after %s", ServiceRestartRequeueDuration)
// Wait a while for the cluster delete
return ctrl.Result{RequeueAfter: ServiceRestartRequeueDuration}, false, nil
}
return ctrl.Result{RequeueAfter: ServiceDefaultRequeueDuration}, true, nil
}
func (r *RayServiceReconciler) labelHealthyServePods(ctx context.Context, rayClusterInstance *rayv1alpha1.RayCluster) error {
allPods := corev1.PodList{}
filterLabels := client.MatchingLabels{common.RayClusterLabelKey: rayClusterInstance.Name}
if err := r.List(ctx, &allPods, client.InNamespace(rayClusterInstance.Namespace), filterLabels); err != nil {
return err
}
httpProxyClient := utils.GetRayHttpProxyClientFunc()
httpProxyClient.InitClient()
for _, pod := range allPods.Items {
httpProxyClient.SetHostIp(pod.Status.PodIP)
if pod.Labels == nil {
pod.Labels = make(map[string]string)
}
if httpProxyClient.CheckHealth() == nil {
pod.Labels[common.RayClusterServingServiceLabelKey] = common.EnableRayClusterServingServiceTrue
} else {
pod.Labels[common.RayClusterServingServiceLabelKey] = common.EnableRayClusterServingServiceFalse
}
if updateErr := r.Update(ctx, &pod); updateErr != nil {
r.Log.Error(updateErr, "Pod label Update error!", "Pod.Error", updateErr)
return updateErr
}
}
return nil
}