Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**
* Copyright 2019 Pramati Prism, 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.hyscale.deployer.services.handler;
import java.util.Iterator;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import io.hyscale.commons.exception.HyscaleException;
import io.hyscale.commons.logger.ActivityContext;
import io.hyscale.commons.logger.WorkflowLogger;
import io.hyscale.commons.models.Status;
import io.hyscale.commons.utils.ThreadPoolUtil;
import io.hyscale.deployer.core.model.ResourceOperation;
import io.hyscale.deployer.services.constants.DeployerConstants;
import io.hyscale.deployer.services.exception.DeployerErrorCodes;
import io.hyscale.deployer.services.model.ResourceStatus;
import io.hyscale.deployer.services.model.ResourceUpdatePolicy;
import io.kubernetes.client.openapi.ApiClient;
import io.kubernetes.client.openapi.models.V1DeleteOptions;
/**
* Defines operation for K8s resources
* Each K8s resource has its own implementation
*
* @param
*/
public interface ResourceLifeCycleHandler {
/**
* Create resource on cluster
*
* @param apiClient
* @param resource
* @param namespace
* @return resource
* @throws HyscaleException
*/
public T create(ApiClient apiClient, T resource, String namespace) throws HyscaleException;
/**
* Fetch resource from cluster, if not found create resource
* On fetched resource populate required fields like resource version and call update
*
* @param apiClient
* @param resource
* @param namespace
* @return true if resource updated, else false
* @throws HyscaleException
*/
public boolean update(ApiClient apiClient, T resource, String namespace) throws HyscaleException;
/**
* Get Cluster resource
*
* @param apiClient
* @param name
* @param namespace
* @return resource
* @throws HyscaleException
*/
public T get(ApiClient apiClient, String name, String namespace) throws HyscaleException;
/**
* @param apiClient
* @param selector could be field or label selector
* @param label - true if selector is label selector, else field selector
* @param namespace
* @return List of resource
* @throws HyscaleException
*/
public List getBySelector(ApiClient apiClient, String selector, boolean label, String namespace)
throws HyscaleException;
/**
* Get all resources irrespective of namespace
* @param apiClient
* @param selector
* @param label
* @return List of resource
* @throws HyscaleException
*/
default List listForAllNamespaces(ApiClient apiClient, String selector, boolean label)
throws HyscaleException {
throw new HyscaleException(DeployerErrorCodes.OPERATION_NOT_SUPPORTED,
ResourceOperation.GET_ALL.getOperation(), getKind());
}
/**
* Patch resource
* 1. Fetch resource from cluster, if not found create
* 2. Resource source formed through deserializing last applied configuration annotation in cluster resource
* 3. Creates JSON patch from target and source resource
* 4. Call patch api with the JSON patch
*
* @param apiClient
* @param name
* @param namespace
* @param body
* @return true if patched else false
* @throws HyscaleException
*/
public boolean patch(ApiClient apiClient, String name, String namespace, T body) throws HyscaleException;
/**
* Delete resource and wait if enabled
*
* @param apiClient
* @param name
* @param namespace
* @param wait
* @return true if resource deleted else false
* @throws HyscaleException
*/
public boolean delete(ApiClient apiClient, String name, String namespace, boolean wait) throws HyscaleException;
/**
* Get resources based on selector than delete individual resource
*
* @param apiClient
* @param selector - label selector if label is true else field selector
* @param label - whether selector is label or field
* @param namespace
* @param wait
* @return true if all are deleted else false
* @throws HyscaleException
*/
public boolean deleteBySelector(ApiClient apiClient, String selector, boolean label, String namespace, boolean wait)
throws HyscaleException;
public String getKind();
/**
* @return weight of resource
*/
public int getWeight();
/**
* @return true if resource needs to be removed, else false
*/
public boolean cleanUp();
/**
* Required while deleting resource
*
* @return K8s delete option
*/
default V1DeleteOptions getDeleteOptions() {
V1DeleteOptions deleteOptions = new V1DeleteOptions();
deleteOptions.setKind("DeleteOptions");
deleteOptions.setApiVersion("v1");
deleteOptions.setPropagationPolicy("Foreground");
return deleteOptions;
}
/**
* Wait until resource is no longer available
* or timeout, in which case throws exception
*
* @param apiClient
* @param pendingResources
* @param namespace
* @param activityContext for displaying continuation
* @throws HyscaleException
*/
default void waitForResourceDeletion(ApiClient apiClient, List pendingResources, String namespace,
ActivityContext activityContext) throws HyscaleException {
// TODO add events for every resource
// TODO Changes to support name, field and label selectors
if (pendingResources == null) {
return;
}
long startTime = System.currentTimeMillis();
while (!pendingResources.isEmpty()
&& (System.currentTimeMillis() - startTime < DeployerConstants.MAX_WAIT_TIME_IN_MILLISECONDS)) {
Iterator deletePendingResourceIterator = pendingResources.iterator();
WorkflowLogger.continueActivity(activityContext);
while (deletePendingResourceIterator.hasNext()) {
String pendingResource = deletePendingResourceIterator.next();
try {
get(apiClient, pendingResource, namespace);
getLogger().debug("Resource {} found to be existing, waiting for resource deletion", pendingResource);
} catch (HyscaleException e) {
if (e.getHyscaleError() == DeployerErrorCodes.RESOURCE_NOT_FOUND) {
deletePendingResourceIterator.remove();
}
}
}
ThreadPoolUtil.sleepSilently(DeployerConstants.DELETE_SLEEP_INTERVAL_IN_MILLIS);
}
// Fail case
if (!pendingResources.isEmpty()) {
if (activityContext != null) {
WorkflowLogger.endActivity(activityContext, Status.FAILED);
}
getLogger().error("Resource deletion failed for: {}", pendingResources);
throw new HyscaleException(DeployerErrorCodes.FAILED_TO_DELETE_RESOURCE, pendingResources.toString());
}
}
/**
* Get Status from resource
*
* @param liveObject
* @return {@link ResourceStatus}
*/
default ResourceStatus status(T liveObject) {
return ResourceStatus.STABLE;
}
default Logger getLogger() {
return LoggerFactory.getLogger(ResourceLifeCycleHandler.class);
}
/**
* Get Update policy from resource
*
* @return {@link ResourceUpdatePolicy}
*/
default ResourceUpdatePolicy getUpdatePolicy() {
return ResourceUpdatePolicy.PATCH;
}
default boolean isWorkLoad() {
return false;
}
}
