io.mantisrx.server.master.resourcecluster.ResourceCluster Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2022 Netflix, Inc.
 *
 * 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 io.mantisrx.server.master.resourcecluster;

import io.mantisrx.common.Ack;
import io.mantisrx.server.core.domain.WorkerId;
import io.mantisrx.server.worker.TaskExecutorGateway;
import java.time.Instant;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import javax.annotation.Nullable;
import lombok.Value;

/**
 * Abstraction to deal with all interactions with the resource cluster such as
 * 1). listing the set of task executors registered
 * 2). listing the set of task executors available
 * 3). listing the set of task executors busy
 * 4). get the current state of a task executor
 * 5). get the current state of the system
 * 6). assign a task executor for a given worker
 */
public interface ResourceCluster extends ResourceClusterGateway {
    /**
     * Get the name of the resource cluster
     *
     * @return name of the resource cluster
     */
    String getName();

    /**
     * API that gets invoked when the resource cluster migrates from one machine to another and needs to be initialized.
     *
     * @param taskExecutorID taskExecutorID that was originally running the worker
     * @param workerId       workerID of the task that being run on the task executor
     * @return Ack when the initialization is done
     */
    CompletableFuture initializeTaskExecutor(TaskExecutorID taskExecutorID, WorkerId workerId);

    CompletableFuture> getRegisteredTaskExecutors();

    CompletableFuture> getAvailableTaskExecutors();

    CompletableFuture> getBusyTaskExecutors();

    CompletableFuture> getUnregisteredTaskExecutors();

    CompletableFuture resourceOverview();

    /**
     * Can throw {@link NoResourceAvailableException} wrapped within the CompletableFuture in case there
     * are no task executors.
     *
     * @param machineDefinition machine definition that's requested for the worker
     * @param workerId          worker id of the task that's going to run on the node.
     * @return task executor assigned for the particular task.
     */
    CompletableFuture getTaskExecutorFor(TaskExecutorAllocationRequest allocationRequest);

    CompletableFuture getTaskExecutorGateway(TaskExecutorID taskExecutorID);

    CompletableFuture getTaskExecutorInfo(String hostName);

    /**
     * Gets the task executor's ID that's currently either running or is assigned for the given workerId
     * @param workerId workerId whose current task executor is needed
     * @return TaskExecutorID
     */
    CompletableFuture getTaskExecutorAssignedFor(WorkerId workerId);

    CompletableFuture getTaskExecutorInfo(TaskExecutorID taskExecutorID);

    CompletableFuture getTaskExecutorState(TaskExecutorID taskExecutorID);

    /**
     * Trigger a request to this resource cluster's ResourceClusterScalerActor to refresh the local scale rule set.
     */
    CompletableFuture refreshClusterScalerRuleSet();

    /**
     * Disables task executors that match the passed set of attributes
     *
     * @param attributes attributes that need to be present in the task executor's set of attributes.
     * @param expiry     instant at which the request can be marked as complete. this is important because we cannot be constantly checking if new task executors match the disabled criteria or not.
     * @return a future that completes when the underlying operation is registered by the system
     */
    CompletableFuture disableTaskExecutorsFor(Map attributes, Instant expiry);

    /**
     * Enables/Disables scaler for a given skuID of a given clusterID
     *
     * @param skuID skuID whom scaler will be enabled/disabled.
     * @param enabled whether the scaler will be enabled/disabled.
     * @return a future that completes when the underlying operation is registered by the system
     */
    CompletableFuture setScalerStatus(ClusterID clusterID, ContainerSkuID skuID, Boolean enabled, Long expirationDurationInSeconds);

    /**
     * Get a paged result of all active jobs associated with this resource cluster.
     * @param startingIndex Starting index for the paged list of all the active jobs.
     * @param pageSize Max size of returned paged list.
     * @return PagedActiveJobOverview instance.
     */
    CompletableFuture getActiveJobOverview(
        Optional startingIndex,
        Optional pageSize);

    /**
     * Gets the task executors to worker mapping for the given resource cluster
     *
     * @return a future mapping task executor IDs to the work they are doing
     */
    CompletableFuture> getTaskExecutorWorkerMapping();

    /**
     * Gets the task executors to worker mapping for all task executors in the resource cluster that match the
     * filtering criteria as represented by the attributes.
     *
     * @param attributes filtering criteria
     * @return a future mapping task executor IDs to the work they are doing
     */
    CompletableFuture> getTaskExecutorWorkerMapping(Map attributes);

    class NoResourceAvailableException extends Exception {

        public NoResourceAvailableException(String message) {
            super(message);
        }
    }

    @Value
    class ResourceOverview {
        long numRegisteredTaskExecutors;
        long numAvailableTaskExecutors;
        long numOccupiedTaskExecutors;
        long numAssignedTaskExecutors;
        long numDisabledTaskExecutors;
    }

    @Value
    class TaskExecutorStatus {
        TaskExecutorRegistration registration;
        boolean registered;
        boolean runningTask;
        boolean assignedTask;
        boolean disabled;
        @Nullable
        WorkerId workerId;
        long lastHeartbeatInMs;
    }
}