appc-adapters/appc-iaas-adapter/appc-iaas-adapter-bundle/src/main/java/org/onap/appc/adapter/iaas/provider/operation/impl/RebuildServer.java

   1 /*
   2 * ============LICENSE_START=======================================================
   3 * ONAP : APPC
   4 * ================================================================================
   5 * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
   6 * ================================================================================
   7 * Copyright (C) 2017 Amdocs
   8 * =============================================================================
   9 * Licensed under the Apache License, Version 2.0 (the "License");
  10 * you may not use this file except in compliance with the License.
  11 * You may obtain a copy of the License at
  12 *
  13 *      http://www.apache.org/licenses/LICENSE-2.0
  14 *
  15 * Unless required by applicable law or agreed to in writing, software
  16 * distributed under the License is distributed on an "AS IS" BASIS,
  17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18 * See the License for the specific language governing permissions and
  19 * limitations under the License.
  20 *
  21 * ============LICENSE_END=========================================================
  22 */
  23
  24 package org.onap.appc.adapter.iaas.provider.operation.impl;
  25
  26 import com.att.cdp.exceptions.ContextConnectionException;
  27 import com.att.cdp.exceptions.ResourceNotFoundException;
  28 import com.att.cdp.exceptions.ZoneException;
  29 import com.att.cdp.zones.ComputeService;
  30 import com.att.cdp.zones.Context;
  31 import com.att.cdp.zones.ImageService;
  32 import com.att.cdp.zones.Provider;
  33 import com.att.cdp.zones.model.Image;
  34 import com.att.cdp.zones.model.ModelObject;
  35 import com.att.cdp.zones.model.Server;
  36 import com.att.cdp.zones.model.ServerBootSource;
  37 import com.att.eelf.configuration.EELFLogger;
  38 import com.att.eelf.configuration.EELFManager;
  39 import com.att.eelf.i18n.EELFResourceManager;
  40 import org.glassfish.grizzly.http.util.HttpStatus;
  41 import org.onap.appc.Constants;
  42 import com.fasterxml.jackson.databind.JsonNode;
  43 import com.fasterxml.jackson.databind.ObjectMapper;
  44 import org.onap.appc.adapter.iaas.ProviderAdapter;
  45 import org.onap.appc.adapter.iaas.impl.IdentityURL;
  46 import org.onap.appc.adapter.iaas.impl.RequestContext;
  47 import org.onap.appc.adapter.iaas.impl.RequestFailedException;
  48 import org.onap.appc.adapter.iaas.impl.VMURL;
  49 import org.onap.appc.adapter.iaas.provider.operation.common.constants.Property;
  50 import org.onap.appc.adapter.iaas.provider.operation.common.enums.Operation;
  51 import org.onap.appc.adapter.iaas.provider.operation.common.enums.Outcome;
  52 import org.onap.appc.adapter.iaas.provider.operation.impl.base.ProviderServerOperation;
  53 import org.onap.appc.configuration.Configuration;
  54 import org.onap.appc.configuration.ConfigurationFactory;
  55 import org.onap.appc.exceptions.APPCException;
  56 import org.onap.appc.i18n.Msg;
  57 import org.onap.appc.logging.LoggingConstants;
  58 import org.onap.appc.logging.LoggingUtils;
  59 import org.onap.ccsdk.sli.core.sli.SvcLogicContext;
  60 import org.slf4j.MDC;
  61 import java.text.DateFormat;
  62 import java.text.SimpleDateFormat;
  63 import java.util.Date;
  64 import java.util.List;
  65 import java.util.Map;
  66 import java.util.TimeZone;
  67 import static org.onap.appc.adapter.iaas.provider.operation.common.enums.Operation.STOP_SERVICE;
  68 import static org.onap.appc.adapter.utils.Constants.ADAPTER_NAME;
  69 import com.att.cdp.exceptions.StateException;
  70
  71 public class RebuildServer extends ProviderServerOperation {
  72
  73     private static final EELFLogger logger = EELFManager.getInstance().getLogger(RebuildServer.class);
  74     private static EELFLogger metricsLogger = EELFManager.getInstance().getMetricsLogger();
  75     private static final Configuration configuration = ConfigurationFactory.getConfiguration();
  76     // the sleep time used by thread.sleep to give "some time for OpenStack to start
  77     // processing the request"
  78     private long rebuildSleepTime = 10L * 1000L;
  79
  80     /**
  81      * Rebuild the indicated server with the indicated image. This method assumes
  82      * the server has been determined to be in the correct state to do the rebuild.
  83      *
  84      * @param rc
  85      *            The request context that manages the state and recovery of the
  86      *            request for the life of its processing.
  87      * @param server
  88      *            the server to be rebuilt
  89      * @param image
  90      *            The image to be used (or snapshot)
  91      * @throws RequestFailedException
  92      *             if the server does not change state in the allotted time
  93      */
  94     @SuppressWarnings("nls")
  95     private void rebuildServer(RequestContext rc, Server server, String image) throws RequestFailedException {
  96         logger.debug(Msg.REBUILD_SERVER, server.getId());
  97         String msg;
  98         Context context = server.getContext();
  99         Provider provider = context.getProvider();
 100         ComputeService service = context.getComputeService();
 101         /*
 102          * Set Time for Metrics Logger
 103          */
 104         setTimeForMetricsLogger();
 105         try {
 106             while (rc.attempt()) {
 107                 try {
 108                     server.rebuild(image);
 109                     break;
 110                 } catch (ContextConnectionException e) {
 111                     msg = EELFResourceManager.format(Msg.CONNECTION_FAILED_RETRY, provider.getName(), service.getURL(),
 112                             context.getTenant().getName(), context.getTenant().getId(), e.getMessage(),
 113                             Long.toString(rc.getRetryDelay()), Integer.toString(rc.getAttempts()),
 114                             Integer.toString(rc.getRetryLimit()));
 115                     logger.error(msg, e);
 116                     metricsLogger.error(msg, e);
 117                     rc.delay();
 118                 }
 119             }
 120             /*
 121              * We need to provide some time for OpenStack to start processing the request.
 122              */
 123             try {
 124                 Thread.sleep(rebuildSleepTime);
 125             } catch (InterruptedException e) {
 126                 logger.trace("Sleep threw interrupted exception, should never occur");
 127                 metricsLogger.trace("Sleep threw interrupted exception, should never occur");
 128             }
 129         } catch (ZoneException e) {
 130             msg = EELFResourceManager.format(Msg.REBUILD_SERVER_FAILED, server.getName(), server.getId(),
 131                     e.getMessage());
 132             logger.error(msg);
 133             metricsLogger.error(msg);
 134             throw new RequestFailedException("Rebuild Server", msg, HttpStatus.BAD_GATEWAY_502, server);
 135         }
 136         rc.reset();
 137         /*
 138          * Once we have started the process, now we wait for the final state of stopped.
 139          * This should be the final state (since we started the rebuild with the server
 140          * stopped).
 141          */
 142         waitForStateChange(rc, server, Server.Status.READY);
 143         if (rc.isFailed()) {
 144             msg = EELFResourceManager.format(Msg.CONNECTION_FAILED, provider.getName(), service.getURL());
 145             logger.error(msg);
 146             metricsLogger.error(msg);
 147             throw new RequestFailedException("Rebuild Server", msg, HttpStatus.BAD_GATEWAY_502, server);
 148         }
 149         rc.reset();
 150     }
 151
 152     /**
 153      * This method is called to rebuild the provided server.
 154      * <p>
 155      * If the server was booted from a volume, then the request is failed
 156      * immediately and no action is taken. Rebuilding a VM from a bootable volume,
 157      * where the bootable volume itself is not rebuilt, serves no purpose.
 158      * </p>
 159      *
 160      * @param rc
 161      *            The request context that manages the state and recovery of the
 162      *            request for the life of its processing.
 163      * @param server
 164      *            The server to be rebuilt
 165      * @throws ZoneException
 166      *             When error occurs
 167      * @throws RequestFailedException
 168      *             When server status is error
 169      */
 170     @SuppressWarnings("nls")
 171     private void rebuildServer(RequestContext rc, Server server, SvcLogicContext ctx)
 172             throws ZoneException, RequestFailedException {
 173         ServerBootSource builtFrom = server.getBootSource();
 174         /*
 175          * Set Time for Metrics Logger
 176          */
 177         setTimeForMetricsLogger();
 178         String msg;
 179         // Throw exception for non image/snap boot source
 180         if (ServerBootSource.VOLUME.equals(builtFrom)) {
 181             msg = String.format("Rebuilding is currently not supported for servers built from bootable volumes [%s]",
 182                     server.getId());
 183             generateEvent(rc, false, msg);
 184             logger.error(msg);
 185             metricsLogger.error(msg);
 186             throw new RequestFailedException("Rebuild Server", msg, HttpStatus.FORBIDDEN_403, server);
 187         }
 188         /*
 189          * Pending is a bit of a special case. If we find the server is in a pending
 190          * state, then the provider is in the process of changing state of the server.
 191          * So, lets try to wait a little bit and see if the state settles down to one we
 192          * can deal with. If not, then we have to fail the request.
 193          */
 194         Context context = server.getContext();
 195         Provider provider = context.getProvider();
 196         ComputeService service = context.getComputeService();
 197         if (server.getStatus().equals(Server.Status.PENDING)) {
 198             rc.reset();
 199             waitForStateChange(rc, server, Server.Status.READY, Server.Status.RUNNING, Server.Status.ERROR,
 200                     Server.Status.SUSPENDED, Server.Status.PAUSED);
 201         }
 202         // Is the skip Hypervisor check attribute populated?
 203         String skipHypervisorCheck = configuration.getProperty(Property.SKIP_HYPERVISOR_CHECK);
 204         if (skipHypervisorCheck == null && ctx != null) {
 205             skipHypervisorCheck = ctx.getAttribute(ProviderAdapter.SKIP_HYPERVISOR_CHECK);
 206         }
 207         // Always perform Hypervisor Status checks
 208         // unless the skip is set to true
 209         if (skipHypervisorCheck == null || (!skipHypervisorCheck.equalsIgnoreCase("true"))) {
 210             // Check of the Hypervisor for the VM Server is UP and reachable
 211             checkHypervisor(server);
 212         }
 213         /*
 214          * Get the image to use in this priority order: (1) If snapshot-id provided in
 215          * the request, use this (2) If any snapshots exist, then the latest snapshot is
 216          * used (3) Otherwise the image used to construct the VM is used.
 217          */
 218         String imageToUse = "";
 219         try {
 220             ObjectMapper mapper = new ObjectMapper();
 221             String payloadStr = configuration.getProperty(Property.PAYLOAD);
 222             if (payloadStr == null || payloadStr.isEmpty()) {
 223                 payloadStr = ctx.getAttribute(ProviderAdapter.PAYLOAD);
 224             }
 225             JsonNode payloadNode = mapper.readTree(payloadStr);
 226             imageToUse = payloadNode.get(ProviderAdapter.PROPERTY_REQUEST_SNAPSHOT_ID).textValue();
 227             logger.debug("Pulled snapshot-id " + imageToUse + " from the payload");
 228         } catch (Exception e) {
 229             logger.debug("Exception attempting to pull snapshot-id from the payload: " + e.toString());
 230         }
 231         List<Image> snapshots = server.getSnapshots();
 232         if (!imageToUse.isEmpty()) {
 233             logger.debug("Using snapshot-id " + imageToUse + " for the rebuild request");
 234         } else if (snapshots != null && !snapshots.isEmpty()) {
 235             imageToUse = snapshots.get(0).getId();
 236         } else {
 237             imageToUse = server.getImage();
 238             ImageService imageService = server.getContext().getImageService();
 239             rc.reset();
 240             try {
 241                 while (rc.attempt()) {
 242                     try {
 243                         /*
 244                          * We are just trying to make sure that the image exists. We arent interested in
 245                          * the details at this point.
 246                          */
 247                         imageService.getImage(imageToUse);
 248                         break;
 249                     } catch (ContextConnectionException e) {
 250                         msg = EELFResourceManager.format(Msg.CONNECTION_FAILED_RETRY, provider.getName(),
 251                                 imageService.getURL(), context.getTenant().getName(), context.getTenant().getId(),
 252                                 e.getMessage(), Long.toString(rc.getRetryDelay()), Integer.toString(rc.getAttempts()),
 253                                 Integer.toString(rc.getRetryLimit()));
 254                         logger.error(msg, e);
 255                         metricsLogger.error(msg);
 256                         rc.delay();
 257                     }
 258                 }
 259             } catch (ZoneException e) {
 260                 msg = EELFResourceManager.format(Msg.IMAGE_NOT_FOUND, imageToUse, "rebuild");
 261                 generateEvent(rc, false, msg);
 262                 logger.error(msg);
 263                 metricsLogger.error(msg);
 264                 throw new RequestFailedException("Rebuild Server", msg, HttpStatus.METHOD_NOT_ALLOWED_405, server);
 265             }
 266         }
 267         if (rc.isFailed()) {
 268             msg = EELFResourceManager.format(Msg.CONNECTION_FAILED, provider.getName(), service.getURL());
 269             logger.error(msg);
 270             metricsLogger.error(msg);
 271             throw new RequestFailedException("Rebuild Server", msg, HttpStatus.BAD_GATEWAY_502, server);
 272         }
 273         rc.reset();
 274         /*
 275          * We determine what to do based on the current state of the server
 276          */
 277         switch (server.getStatus()) {
 278         case DELETED:
 279             // Nothing to do, the server is gone
 280             msg = EELFResourceManager.format(Msg.SERVER_DELETED, server.getName(), server.getId(), server.getTenantId(),
 281                     "rebuilt");
 282             generateEvent(rc, false, msg);
 283             logger.error(msg);
 284             metricsLogger.error(msg);
 285             throw new RequestFailedException("Rebuild Server", msg, HttpStatus.METHOD_NOT_ALLOWED_405, server);
 286         case RUNNING:
 287             // Attempt to stop the server, then rebuild it
 288             stopServer(rc, server);
 289             rc.reset();
 290             rebuildServer(rc, server, imageToUse);
 291             rc.reset();
 292             startServer(rc, server);
 293             generateEvent(rc, true, Outcome.SUCCESS.toString());
 294             metricsLogger.info("Server status: RUNNING");
 295             break;
 296         case ERROR:
 297             msg = EELFResourceManager.format(Msg.SERVER_ERROR_STATE, server.getName(), server.getId(),
 298                     server.getTenantId(), "rebuild");
 299             generateEvent(rc, false, msg);
 300             logger.error(msg);
 301             metricsLogger.error(msg);
 302             throw new RequestFailedException("Rebuild Server", msg, HttpStatus.METHOD_NOT_ALLOWED_405, server);
 303         case READY:
 304             // Attempt to rebuild the server
 305             rebuildServer(rc, server, imageToUse);
 306             rc.reset();
 307             startServer(rc, server);
 308             generateEvent(rc, true, Outcome.SUCCESS.toString());
 309             metricsLogger.info("Server status: READY");
 310             break;
 311         case PAUSED:
 312             // if paused, un-pause it, stop it, and rebuild it
 313             unpauseServer(rc, server);
 314             rc.reset();
 315             stopServer(rc, server);
 316             rc.reset();
 317             rebuildServer(rc, server, imageToUse);
 318             rc.reset();
 319             startServer(rc, server);
 320             generateEvent(rc, true, Outcome.SUCCESS.toString());
 321             metricsLogger.info("Server status: PAUSED");
 322             break;
 323         case SUSPENDED:
 324             // Attempt to resume the suspended server, stop it, and rebuild it
 325             resumeServer(rc, server);
 326             rc.reset();
 327             stopServer(rc, server);
 328             rc.reset();
 329             rebuildServer(rc, server, imageToUse);
 330             rc.reset();
 331             startServer(rc, server);
 332             generateEvent(rc, true, Outcome.SUCCESS.toString());
 333             metricsLogger.info("Server status: SUSPENDED");
 334             break;
 335         default:
 336             // Hmmm, unknown status, should never occur
 337             msg = EELFResourceManager.format(Msg.UNKNOWN_SERVER_STATE, server.getName(), server.getId(),
 338                     server.getTenantId(), server.getStatus().name());
 339             generateEvent(rc, false, msg);
 340             logger.error(msg);
 341             metricsLogger.error(msg);
 342             throw new RequestFailedException("Rebuild Server", msg, HttpStatus.METHOD_NOT_ALLOWED_405, server);
 343         }
 344     }
 345
 346     /**
 347      * @see org.onap.appc.adapter.iaas.ProviderAdapter#rebuildServer(java.util.Map,
 348      *      org.onap.ccsdk.sli.core.sli.SvcLogicContext)
 349      */
 350     @SuppressWarnings("nls")
 351     public Server rebuildServer(Map<String, String> params, SvcLogicContext ctx) throws APPCException {
 352         Server server = null;
 353         RequestContext rc = new RequestContext(ctx);
 354         rc.isAlive();
 355         setTimeForMetricsLogger();
 356         String msg;
 357         try {
 358             validateParametersExist(params, ProviderAdapter.PROPERTY_INSTANCE_URL,
 359                     ProviderAdapter.PROPERTY_PROVIDER_NAME);
 360
 361             String appName = configuration.getProperty(Constants.PROPERTY_APPLICATION_NAME);
 362             String vm_url = params.get(ProviderAdapter.PROPERTY_INSTANCE_URL);
 363             VMURL vm = VMURL.parseURL(vm_url);
 364             if (validateVM(rc, appName, vm_url, vm))
 365                 return null;
 366             IdentityURL ident = IdentityURL.parseURL(params.get(ProviderAdapter.PROPERTY_IDENTITY_URL));
 367             String identStr = (ident == null) ? null : ident.toString();
 368             ctx.setAttribute("REBUILD_STATUS", "ERROR");
 369             Context context = null;
 370             String tenantName = "Unknown";// to be used also in case of exception
 371             try {
 372                 context = getContext(rc, vm_url, identStr);
 373                 if (context != null) {
 374                     tenantName = context.getTenantName();// this varaible also is used in case of exception
 375                     rc.reset();
 376                     server = lookupServer(rc, context, vm.getServerId());
 377                     logger.debug(Msg.SERVER_FOUND, vm_url, tenantName, server.getStatus().toString());
 378                     // Manually checking image service until new PAL release
 379                     if (hasImageAccess(rc, context)) {
 380                         rebuildServer(rc, server, ctx);
 381                         doSuccess(rc);
 382                         ctx.setAttribute("REBUILD_STATUS", "SUCCESS");
 383                     } else {
 384                         msg = EELFResourceManager.format(Msg.REBUILD_SERVER_FAILED, server.getName(), server.getId(),
 385                                 "Accessing Image Service Failed");
 386                         logger.error(msg);
 387                         metricsLogger.error(msg);
 388                         doFailure(rc, HttpStatus.FORBIDDEN_403, msg);
 389                     }
 390                     context.close();
 391                 } else {
 392                     ctx.setAttribute("REBUILD_STATUS", "CONTEXT_NOT_FOUND");
 393                 }
 394             } catch (StateException ex) {
 395                 logger.error(ex.getMessage());
 396                 ctx.setAttribute("REBUILD_STATUS", "ERROR");
 397                 doFailure(rc, HttpStatus.CONFLICT_409, ex.getMessage());
 398             }
 399             catch (RequestFailedException e) {
 400                 doFailure(rc, e.getStatus(), e.getMessage());
 401                 ctx.setAttribute("REBUILD_STATUS", "ERROR");
 402             } catch (ResourceNotFoundException e) {
 403                 msg = EELFResourceManager.format(Msg.SERVER_NOT_FOUND, e, vm_url);
 404                 ctx.setAttribute("REBUILD_STATUS", "ERROR");
 405                 logger.error(msg);
 406                 metricsLogger.error(msg);
 407                 doFailure(rc, HttpStatus.NOT_FOUND_404, msg);
 408             } catch (Exception e1) {
 409                 msg = EELFResourceManager.format(Msg.SERVER_OPERATION_EXCEPTION, e1, e1.getClass().getSimpleName(),
 410                         STOP_SERVICE.toString(), vm_url, tenantName);
 411                 ctx.setAttribute("REBUILD_STATUS", "ERROR");
 412                 logger.error(msg, e1);
 413                 metricsLogger.error(msg);
 414                 doFailure(rc, HttpStatus.INTERNAL_SERVER_ERROR_500, msg);
 415             }
 416         } catch (RequestFailedException e) {
 417
 418             ctx.setAttribute("REBUILD_STATUS", "ERROR");
 419             doFailure(rc, e.getStatus(), e.getMessage());
 420         }
 421         return server;
 422     }
 423
 424     @Override
 425     protected ModelObject executeProviderOperation(Map<String, String> params, SvcLogicContext context)
 426             throws APPCException {
 427         setMDC(Operation.REBUILD_SERVICE.toString(), "App-C IaaS Adapter:Rebuild", ADAPTER_NAME);
 428         logOperation(Msg.REBUILDING_SERVER, params, context);
 429         setTimeForMetricsLogger();
 430         metricsLogger.info("Executing Provider Operation: Rebuild");
 431         return rebuildServer(params, context);
 432     }
 433
 434     private void setTimeForMetricsLogger() {
 435         String timestamp = LoggingUtils.generateTimestampStr(((Date) new Date()).toInstant());
 436         MDC.put(LoggingConstants.MDCKeys.BEGIN_TIMESTAMP, timestamp);
 437         MDC.put(LoggingConstants.MDCKeys.END_TIMESTAMP, timestamp);
 438         MDC.put(LoggingConstants.MDCKeys.ELAPSED_TIME, "0");
 439         MDC.put(LoggingConstants.MDCKeys.STATUS_CODE, LoggingConstants.StatusCodes.COMPLETE);
 440         MDC.put(LoggingConstants.MDCKeys.TARGET_ENTITY, "cdp");
 441         MDC.put(LoggingConstants.MDCKeys.TARGET_SERVICE_NAME, "rebuild server");
 442         MDC.put(LoggingConstants.MDCKeys.CLASS_NAME,
 443                 "org.onap.appc.adapter.iaas.provider.operation.impl.RebuildServer");
 444
 445     }
 446
 447     /**
 448      * Sets the sleep time used by thread.sleep to give "some time for OpenStack to
 449      * start processing the request".
 450      *
 451      * @param millis
 452      *            Time to sleep in milliseconds
 453      */
 454     public void setRebuildSleepTime(long millis) {
 455         this.rebuildSleepTime = millis;
 456     }
 457 }