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.
io.hyscale.deployer.services.handler.impl.V1DeploymentHandler Maven / Gradle / Ivy
/**
* 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.impl;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import io.kubernetes.client.openapi.models.*;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.common.collect.Lists;
import com.google.gson.JsonSyntaxException;
import io.hyscale.commons.constants.K8SRuntimeConstants;
import io.hyscale.commons.exception.HyscaleException;
import io.hyscale.commons.logger.ActivityContext;
import io.hyscale.commons.logger.WorkflowLogger;
import io.hyscale.commons.models.AnnotationKey;
import io.hyscale.commons.models.Status;
import io.hyscale.commons.utils.GsonProviderUtil;
import io.hyscale.commons.utils.ResourceLabelUtil;
import io.hyscale.deployer.core.model.DeploymentStatus;
import io.hyscale.deployer.core.model.ResourceKind;
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.handler.PodParentHandler;
import io.hyscale.deployer.services.handler.ResourceHandlers;
import io.hyscale.deployer.services.handler.ResourceLifeCycleHandler;
import io.hyscale.deployer.services.model.DeployerActivity;
import io.hyscale.deployer.services.model.ResourceStatus;
import io.hyscale.deployer.services.util.ExceptionHelper;
import io.hyscale.deployer.services.util.K8sResourcePatchUtil;
import io.kubernetes.client.custom.V1Patch;
import io.kubernetes.client.openapi.ApiClient;
import io.kubernetes.client.openapi.ApiException;
import io.kubernetes.client.openapi.apis.AppsV1Api;
public class V1DeploymentHandler extends PodParentHandler implements ResourceLifeCycleHandler {
private static final Logger LOGGER = LoggerFactory.getLogger(V1DeploymentHandler.class);
public V1Deployment create(ApiClient apiClient, V1Deployment resource, String namespace) throws HyscaleException {
if (resource == null) {
LOGGER.debug("Cannot create null Deployment");
return resource;
}
WorkflowLogger.startActivity(DeployerActivity.DEPLOYING_DEPLOYMENT);
AppsV1Api appsV1Api = new AppsV1Api(apiClient);
String name = resource.getMetadata().getName();
V1Deployment v1Deployment = null;
try {
resource.getMetadata().putAnnotationsItem(
AnnotationKey.K8S_HYSCALE_LAST_APPLIED_CONFIGURATION.getAnnotation(), GsonProviderUtil.getPrettyGsonBuilder().toJson(resource));
v1Deployment = appsV1Api.createNamespacedDeployment(namespace, resource, DeployerConstants.TRUE, null, null);
} catch (ApiException e) {
HyscaleException ex = new HyscaleException(e, DeployerErrorCodes.FAILED_TO_CREATE_RESOURCE,
ExceptionHelper.getExceptionMessage(getKind(), e, ResourceOperation.CREATE));
LOGGER.error("Error while creating Deployment {} in namespace {}, error {}", v1Deployment, namespace,
ex.toString());
WorkflowLogger.endActivity(Status.FAILED);
throw ex;
}
LOGGER.info("Created Deployment {} in namespace {}",name,namespace);
WorkflowLogger.endActivity(Status.DONE);
return v1Deployment;
}
@Override
public boolean update(ApiClient apiClient, V1Deployment resource, String namespace) throws HyscaleException {
if (resource == null) {
LOGGER.debug("Cannot update null Deployment");
return false;
}
AppsV1Api appsV1Api = new AppsV1Api(apiClient);
String name = resource.getMetadata().getName();
V1Deployment existingDeployment = null;
try {
existingDeployment = get(apiClient, name, namespace);
} catch (HyscaleException ex) {
LOGGER.debug("Error while getting Deployment {} in namespace {} for Update, creating new", name, namespace);
V1Deployment deployment = create(apiClient, resource, namespace);
return deployment != null;
}
WorkflowLogger.startActivity(DeployerActivity.DEPLOYING_DEPLOYMENT);
try {
String resourceVersion = existingDeployment.getMetadata().getResourceVersion();
resource.getMetadata().setResourceVersion(resourceVersion);
appsV1Api.replaceNamespacedDeployment(name, namespace, existingDeployment, DeployerConstants.TRUE, null, null);
} catch (ApiException e) {
HyscaleException ex = new HyscaleException(e, DeployerErrorCodes.FAILED_TO_UPDATE_RESOURCE,
ExceptionHelper.getExceptionMessage(getKind(), e, ResourceOperation.UPDATE));
LOGGER.error("Error while updating Deployment {} in namespace {}, error {}", name, namespace,
ex.toString());
WorkflowLogger.endActivity(Status.FAILED);
throw ex;
}
LOGGER.info("Updated Deployment {} in namespace {}",name,namespace);
WorkflowLogger.endActivity(Status.DONE);
return true;
}
@Override
public V1Deployment get(ApiClient apiClient, String name, String namespace) throws HyscaleException {
AppsV1Api appsV1Api = new AppsV1Api(apiClient);
V1Deployment v1Deployment = null;
try {
v1Deployment = appsV1Api.readNamespacedDeployment(name, namespace, DeployerConstants.TRUE, false, false);
} catch (ApiException e) {
HyscaleException ex = ExceptionHelper.buildGetException(getKind(), e, ResourceOperation.GET);
LOGGER.error("Error while fetching Deployment {} in namespace {}, error {} ", name, namespace,
ex.toString());
throw ex;
}
return v1Deployment;
}
@Override
public List getBySelector(ApiClient apiClient, String selector, boolean label, String namespace) throws HyscaleException {
AppsV1Api appsV1Api = new AppsV1Api(apiClient);
List v1Deployments = null;
try {
String labelSelector = label ? selector : null;
String fieldSelector = label ? null : selector;
V1DeploymentList v1DeploymentList = appsV1Api.listNamespacedDeployment(namespace, DeployerConstants.TRUE, null,
null, fieldSelector, labelSelector, null, null, null, null);
v1Deployments = v1DeploymentList != null ? v1DeploymentList.getItems() : null;
} catch (ApiException e) {
HyscaleException ex = ExceptionHelper.buildGetException(getKind(), e, ResourceOperation.GET_BY_SELECTOR);
LOGGER.error("Error while listing Deployments in namespace {}, with selectors {}, error {} ", namespace,
selector, ex.toString());
throw ex;
}
return v1Deployments;
}
@Override
public List listForAllNamespaces(ApiClient apiClient, String selector, boolean label)
throws HyscaleException {
AppsV1Api appsV1Api = new AppsV1Api(apiClient);
List v1Deployments = null;
try {
String labelSelector = label ? selector : null;
String fieldSelector = label ? null : selector;
V1DeploymentList v1DeploymentList = appsV1Api.listDeploymentForAllNamespaces(null, null, fieldSelector,
labelSelector, null, DeployerConstants.TRUE, null, null, null);
v1Deployments = v1DeploymentList != null ? v1DeploymentList.getItems() : null;
} catch (ApiException e) {
HyscaleException ex = ExceptionHelper.buildGetException(getKind(), e, ResourceOperation.GET_ALL);
LOGGER.error("Error while listing Deployments in all namespaces, with selectors {}, error {} ", selector,
ex.toString());
throw ex;
}
return v1Deployments;
}
@Override
public boolean patch(ApiClient apiClient, String name, String namespace, V1Deployment target) throws HyscaleException {
if (target == null) {
LOGGER.debug("Cannot patch null Deployment");
return false;
}
AppsV1Api appsV1Api = new AppsV1Api(apiClient);
target.getMetadata().putAnnotationsItem(AnnotationKey.K8S_HYSCALE_LAST_APPLIED_CONFIGURATION.getAnnotation(),
GsonProviderUtil.getPrettyGsonBuilder().toJson(target));
V1Deployment sourceDeployment = null;
try {
sourceDeployment = get(apiClient, name, namespace);
} catch (HyscaleException e) {
LOGGER.debug("Error while getting Deployment {} in namespace {} for Patch, creating new", name, namespace);
V1Deployment deployment = create(apiClient, target, namespace);
return deployment != null;
}
WorkflowLogger.startActivity(DeployerActivity.DEPLOYING_DEPLOYMENT);
Object patchObject = null;
String lastAppliedConfig = sourceDeployment.getMetadata().getAnnotations()
.get(AnnotationKey.K8S_HYSCALE_LAST_APPLIED_CONFIGURATION.getAnnotation());
try {
patchObject = K8sResourcePatchUtil.getJsonPatch(GsonProviderUtil.getPrettyGsonBuilder().fromJson(lastAppliedConfig, V1Deployment.class),
target, V1Deployment.class);
V1Patch v1Patch = new V1Patch(patchObject.toString());
appsV1Api.patchNamespacedDeployment(name, namespace, v1Patch, DeployerConstants.TRUE, null, null, null);
} catch (HyscaleException e) {
LOGGER.error("Error while creating patch for Deployment {}, source {}, target {}", name, sourceDeployment,
target);
WorkflowLogger.endActivity(Status.FAILED);
throw e;
} catch (ApiException e) {
HyscaleException ex = new HyscaleException(e, DeployerErrorCodes.FAILED_TO_PATCH_RESOURCE,
ExceptionHelper.getExceptionMessage(getKind(), e, ResourceOperation.PATCH));
LOGGER.error("Error while patching Deployment {} in namespace {} , error {}", name, namespace,
ex.toString());
WorkflowLogger.endActivity(Status.FAILED);
throw ex;
}
WorkflowLogger.endActivity(Status.DONE);
return true;
}
@Override
public boolean delete(ApiClient apiClient, String name, String namespace, boolean wait) throws HyscaleException {
ActivityContext activityContext = new ActivityContext(DeployerActivity.DELETING_DEPLOYMENT);
WorkflowLogger.startActivity(activityContext);
try {
delete(apiClient, name, namespace);
List pendingDeployments = Lists.newArrayList();
pendingDeployments.add(name);
if (wait) {
waitForResourceDeletion(apiClient, pendingDeployments, namespace, activityContext);
}
} catch (ApiException e) {
if (e.getCode() == 404) {
WorkflowLogger.endActivity(activityContext, Status.NOT_FOUND);
return false;
}
HyscaleException ex = new HyscaleException(e, DeployerErrorCodes.FAILED_TO_DELETE_RESOURCE,
ExceptionHelper.getExceptionMessage(getKind(), e, ResourceOperation.DELETE));
LOGGER.error("Error while deleting Deployment {} in namespace {}, error {} ", name, namespace,
ex.toString());
WorkflowLogger.endActivity(activityContext, Status.FAILED);
throw ex;
}
LOGGER.info("Deleted Deployment {} in namespace {}",name, namespace);
WorkflowLogger.endActivity(activityContext, Status.DONE);
return true;
}
private void delete(ApiClient apiClient, String name, String namespace) throws ApiException {
AppsV1Api appsV1Api = new AppsV1Api(apiClient);
V1DeleteOptions deleteOptions = getDeleteOptions();
deleteOptions.setApiVersion("apps/v1");
try {
appsV1Api.deleteNamespacedDeployment(name, namespace, DeployerConstants.TRUE, null, null, null, null, deleteOptions);
} catch (JsonSyntaxException e) {
// K8s end exception ignore
}
}
@Override
public boolean deleteBySelector(ApiClient apiClient, String selector, boolean label, String namespace, boolean wait) throws HyscaleException {
V1DeleteOptions deleteOptions = getDeleteOptions();
deleteOptions.setApiVersion("apps/v1");
try {
List deploymentList = getBySelector(apiClient, selector, label, namespace);
if (deploymentList == null || deploymentList.isEmpty()) {
return false;
}
for (V1Deployment deployment : deploymentList) {
delete(apiClient, deployment.getMetadata().getName(), namespace, wait);
}
} catch (HyscaleException e) {
if (DeployerErrorCodes.RESOURCE_NOT_FOUND.equals(e.getHyscaleError())) {
LOGGER.error("Error while deleting deployment for selector {} in namespace {}, error {}", selector,
namespace, e.toString());
return false;
}
throw e;
}
return true;
}
@Override
public String getKind() {
return ResourceKind.DEPLOYMENT.getKind();
}
@Override
public int getWeight() {
return ResourceKind.DEPLOYMENT.getWeight();
}
@Override
public boolean cleanUp() {
return true;
}
@Override
public ResourceStatus status(V1Deployment deployment) {
V1DeploymentStatus deploymentStatus = deployment.getStatus();
if (deploymentStatus == null) {
return ResourceStatus.FAILED;
}
Integer desiredReplicas = deployment.getSpec().getReplicas();
Integer statusReplicas = deploymentStatus.getReplicas();
Integer updatedReplicas = deploymentStatus.getUpdatedReplicas();
Integer availableReplicas = deploymentStatus.getAvailableReplicas();
Integer readyReplicas = deploymentStatus.getReadyReplicas();
if ((desiredReplicas == null || desiredReplicas == 0) && (statusReplicas == null || statusReplicas == 0)) {
return ResourceStatus.STABLE;
}
// pending case
if (updatedReplicas == null || (desiredReplicas != null && desiredReplicas > updatedReplicas)
|| (statusReplicas != null && statusReplicas > updatedReplicas)
|| (availableReplicas == null || availableReplicas < updatedReplicas)
|| (readyReplicas == null || (desiredReplicas != null && desiredReplicas > readyReplicas))
|| (statusReplicas != null && desiredReplicas == 0)) {
return ResourceStatus.PENDING;
}
return ResourceStatus.STABLE;
}
public static String getDeploymentRevision(V1Deployment deployment) {
if (deployment == null) {
return null;
}
Map annotations = deployment.getMetadata().getAnnotations();
if (annotations == null) {
return null;
}
return annotations.get(AnnotationKey.K8S_DEPLOYMENT_REVISION.getAnnotation());
}
public List getServiceNames(ApiClient apiClient, String selector, boolean label, String namespace)
throws HyscaleException {
return getServiceNames(getBySelector(apiClient, selector, label, namespace));
}
/**
* @param deploymentList
* @return list of service names from label of deployment
*/
public List getServiceNames(List deploymentList) {
if (deploymentList == null) {
return Collections.emptyList();
}
return deploymentList.stream().filter(each -> each != null && each.getMetadata() != null)
.map(each -> ResourceLabelUtil.getServiceName(each.getMetadata().getLabels()))
.collect(Collectors.toList());
}
@Override
public List getStatus(ApiClient apiClient, String selector, boolean label, String namespace) {
try {
return buildStatus(getBySelector(apiClient, selector, label, namespace));
} catch (HyscaleException e) {
LOGGER.error("Error while fetching Deployment with selector {} in namespace {}, error {}", selector,
namespace, e.getMessage());
}
return Collections.emptyList();
}
@Override
public DeploymentStatus buildStatus(V1Deployment deployment) {
if (deployment == null) {
return null;
}
ResourceStatus resourceStatus = status(deployment);
DeploymentStatus.ServiceStatus serviceStatus = ResourceStatus.getServiceStatus(resourceStatus);
if (resourceStatus.equals(ResourceStatus.PENDING) && deployment.getStatus().getReadyReplicas() != null && deployment.getSpec().getReplicas() <= deployment.getStatus().getReadyReplicas()) {
serviceStatus = DeploymentStatus.ServiceStatus.SCALING_DOWN;
}
if (deployment.getSpec().getReplicas() == 0 && resourceStatus.equals(ResourceStatus.STABLE)){
serviceStatus = DeploymentStatus.ServiceStatus.NOT_RUNNING;
}
return buildStatusFromMetadata(deployment.getMetadata(), serviceStatus);
}
@Override
public List buildStatus(List deploymentList) {
if (deploymentList == null) {
return Collections.emptyList();
}
List statuses = new ArrayList<>();
deploymentList.stream().forEach(each -> {
DeploymentStatus deployStatus = buildStatus(each);
if (deployStatus != null) {
statuses.add(deployStatus);
}
});
return statuses;
}
@Override
protected String getPodRevision(ApiClient apiClient, String selector, boolean label, String namespace) {
List deploymentList = null;
try {
deploymentList = getBySelector(apiClient, selector, label, namespace);
} catch (HyscaleException e) {
LOGGER.error("Error fetching deployment for pod selection, ignoring", e);
return null;
}
if (deploymentList == null || deploymentList.isEmpty()) {
return null;
}
String revision = getDeploymentRevision(deploymentList.get(0));
if (StringUtils.isBlank(revision)) {
return null;
}
return getPodTemplateHash(apiClient, namespace, selector, revision);
}
private String getPodTemplateHash(ApiClient apiClient, String namespace, String selector, String revision) {
V1ReplicaSetHandler v1ReplicaSetHandler = (V1ReplicaSetHandler) ResourceHandlers
.getHandlerOf(ResourceKind.REPLICA_SET.getKind());
V1ReplicaSet replicaSet = null;
try {
replicaSet = v1ReplicaSetHandler.getReplicaSetByRevision(apiClient, namespace, selector, true, revision);
} catch (HyscaleException e) {
LOGGER.error("Error fetching replica set with revision {} for pod filtering, ignoring", revision, e);
return null;
}
if (replicaSet == null) {
LOGGER.debug("No Replica set found with revision: {} for filtering pods, returning empty list", revision);
return null;
}
String podTemplateHash = replicaSet.getMetadata().getLabels()
.get(K8SRuntimeConstants.K8S_DEPLOYMENT_POD_TEMPLATE_HASH);
LOGGER.debug("pod-template-hash: {}", podTemplateHash);
return K8SRuntimeConstants.K8S_DEPLOYMENT_POD_TEMPLATE_HASH + "=" + podTemplateHash;
}
@Override
protected String getPodRevision(ApiClient apiClient, V1Deployment deployment) {
if (deployment == null) {
return null;
}
String revision = getDeploymentRevision(deployment);
String selector = deployment.getSpec().getSelector().getMatchLabels().entrySet().stream()
.map(entry -> entry.getKey() + "=" + entry.getValue()).collect(Collectors.joining(","));
return getPodTemplateHash(apiClient, deployment.getMetadata().getNamespace(), selector, revision);
}
@Override
public Integer getReplicas(V1Deployment t) {
return t != null ? t.getSpec().getReplicas() : K8SRuntimeConstants.DEFAULT_REPLICA_COUNT;
}
@Override
public boolean scale(ApiClient apiClient, V1Deployment v1Deployment, String namespace, int value) throws HyscaleException {
if (v1Deployment == null) {
LOGGER.error("Cannot scale 'null' deployment");
return false;
}
String name = v1Deployment.getMetadata().getName();
int currentReplicas = v1Deployment.getSpec().getReplicas();
String lastAppliedConfig = v1Deployment.getMetadata().getAnnotations()
.get(AnnotationKey.K8S_HYSCALE_LAST_APPLIED_CONFIGURATION.getAnnotation());
V1Deployment lastAppliedDeployment = GsonProviderUtil.getPrettyGsonBuilder().fromJson(lastAppliedConfig, V1Deployment.class);
ActivityContext activityContext = new ActivityContext(DeployerActivity.SCALING_SERVICE);
WorkflowLogger.startActivity(activityContext);
boolean status = false;
try {
if (!(currentReplicas == value && lastAppliedDeployment.getSpec().getReplicas() == value)) {
lastAppliedDeployment.getSpec().setReplicas(value);
patch(apiClient, name, namespace, lastAppliedDeployment);
}
status = waitForDesiredState(apiClient, name, namespace, activityContext);
} catch (HyscaleException e) {
LOGGER.error("Error while applying PATCH scale to {} due to : {} code :{}", name, e.getMessage(), e.getCode(), e);
HyscaleException ex = new HyscaleException(DeployerErrorCodes.ERROR_WHILE_SCALING, e.getMessage());
throw ex;
} finally {
if (status) {
WorkflowLogger.endActivity(activityContext, Status.DONE);
} else {
WorkflowLogger.endActivity(activityContext, Status.FAILED);
}
}
return status;
}
private boolean waitForDesiredState(ApiClient apiClient, String name, String namespace,ActivityContext activityContext) throws HyscaleException {
Long startTime = System.currentTimeMillis();
boolean stable = false;
int rotateThreshold = 5;
int sleep = 3;
try {
int rotations = 0;
while (System.currentTimeMillis() - startTime < DeployerConstants.MAX_WAIT_TIME_IN_MILLISECONDS) {
rotations++;
V1Deployment updatedDeployment = null;
updatedDeployment = get(apiClient, name, namespace);
LOGGER.debug("Patched deployment status :{} ", updatedDeployment.getStatus());
if (status(updatedDeployment) == ResourceStatus.STABLE) {
stable = true;
break;
}
if (rotateThreshold == rotations) {
sleep++;
rotations = 0;
}
WorkflowLogger.continueActivity(activityContext);
Thread.sleep(sleep * 1000L);
}
} catch (InterruptedException e) {
LOGGER.error("Sleep Thread interrupted ", e);
Thread.currentThread().interrupt();
} catch (HyscaleException ex){
LOGGER.error("Error while fetching deployment {}", ex.getHyscaleError(), ex);
}
return stable;
}
@Override
public boolean isWorkLoad() {
return true;
}
}
