NC | Lifecycle | Add status, events, timeout

Signed-off-by: Romy <35330373+romayalon@users.noreply.github.com>

Author: romayalon

config.js

@@ -1011,7 +1011,8 @@ config.NC_DISABLE_SCHEMA_CHECK = false;
 
 ////////// NC LIFECYLE  //////////
 
-config.LIFECYCLE_LOGS_DIR = '/var/log/noobaa/lifecycle';
+config.NC_LIFECYCLE_LOGS_DIR = '/var/log/noobaa/lifecycle';
+config.NC_LIFECYCLE_TIMEOUT_MS = 6 * 60 * 60 * 1000;
 
 // NC_LIFECYCLE_RUN_TIME must be of the format hh:mm which specifies
 // when NooBaa should allow running nc lifecycle process

src/cmd/manage_nsfs.js

@@ -883,7 +883,8 @@ async function list_connections() {
 async function lifecycle_management(args) {
     const disable_service_validation = get_boolean_or_string_value(args.disable_service_validation);
     const disable_runtime_validation = get_boolean_or_string_value(args.disable_runtime_validation);
-    await noobaa_cli_lifecycle.run_lifecycle_under_lock(config_fs, disable_service_validation, disable_runtime_validation);
+    const short = get_boolean_or_string_value(args.short);
+    await noobaa_cli_lifecycle.run_lifecycle_under_lock(config_fs, { disable_service_validation, disable_runtime_validation, short });
 }
 
 exports.main = main;

src/manage_nsfs/manage_nsfs_cli_errors.js

@@ -534,6 +534,18 @@ ManageCLIError.NooBaaServiceIsNotActive = Object.freeze({
     http_code: 400,
 });
 
+ManageCLIError.LifecycleFailed = Object.freeze({
+    code: 'LifecycleFailed',
+    message: 'Lifecycle worker run failed.',
+    http_code: 400,
+});
+
+ManageCLIError.LifecycleWorkerReachedTimeout = Object.freeze({
+    code: 'LifecycleWorkerReachedTimeout',
+    message: `Lifecycle worker reached timeout - configured timeout is ${config.NC_LIFECYCLE_TIMEOUT_MS} ms`,
+    http_code: 400,
+});
+
 ///////////////////////////////
 //       ERRORS MAPPING      //
 ///////////////////////////////
@@ -556,7 +568,8 @@ ManageCLIError.RPC_ERROR_TO_MANAGE = Object.freeze({
     NO_SUCH_USER: ManageCLIError.InvalidAccountDistinguishedName,
     INVALID_MASTER_KEY: ManageCLIError.InvalidMasterKey,
     INVALID_BUCKET_NAME: ManageCLIError.InvalidBucketName,
-    CONFIG_DIR_VERSION_MISMATCH: ManageCLIError.ConfigDirUpdateBlocked
+    CONFIG_DIR_VERSION_MISMATCH: ManageCLIError.ConfigDirUpdateBlocked,
+    LIFECYCLE_WORKER_TIMEOUT: ManageCLIError.LifecycleWorkerReachedTimeout
 });
 
 const NSFS_CLI_ERROR_EVENT_MAP = {
@@ -569,7 +582,9 @@ const NSFS_CLI_ERROR_EVENT_MAP = {
     BucketSetForbiddenBucketOwnerNotExists: NoobaaEvent.UNAUTHORIZED, // GAP - add event
     BucketSetForbiddenBucketOwnerIsIAMAccount: NoobaaEvent.UNAUTHORIZED, // // GAP - add event
     LoggingExportFailed: NoobaaEvent.LOGGING_FAILED,
-    UpgradeFailed: NoobaaEvent.CONFIG_DIR_UPGRADE_FAILED
+    UpgradeFailed: NoobaaEvent.CONFIG_DIR_UPGRADE_FAILED,
+    LifecycleFailed: NoobaaEvent.LIFECYCLE_FAILED,
+    LifecycleWorkerReachedTimeout: NoobaaEvent.LIFECYCLE_TIMEOUT
 };
 
 exports.ManageCLIError = ManageCLIError;

src/manage_nsfs/manage_nsfs_cli_responses.js

@@ -1,6 +1,8 @@
 /* Copyright (C) 2016 NooBaa */
 'use strict';
 
+const config = require('../../config');
+
 const NoobaaEvent = require('../manage_nsfs/manage_nsfs_events_utils').NoobaaEvent;
 
 // TODO : define list & status types
@@ -197,6 +199,24 @@ ManageCLIResponse.ConnectionList = Object.freeze({
     list: {}
 });
 
+///////////////////////////////
+//    LIFECYCLE RESPONSES    //
+///////////////////////////////
+
+ManageCLIResponse.LifecycleSuccessful = Object.freeze({
+    code: 'LifecycleSuccessful',
+    message: 'Lifecycle worker run finished successfully',
+    status: {}
+});
+
+ManageCLIResponse.LifecycleWorkerNotRunning = Object.freeze({
+    code: 'LifecycleWorkerNotRunning',
+    message: `Lifecycle worker must run at ${config.NC_LIFECYCLE_RUN_TIME} ` +
+        `with delay of ${config.NC_LIFECYCLE_RUN_DELAY_LIMIT_MINS} minutes ` +
+        `in timezone ${config.NC_LIFECYCLE_TZ}`,
+    status: {}
+});
+
 ///////////////////////////////
 //  RESPONSES-EVENT MAPPING  //
 ///////////////////////////////
@@ -209,7 +229,8 @@ const NSFS_CLI_SUCCESS_EVENT_MAP = {
     WhiteListIPUpdated: NoobaaEvent.WHITELIST_UPDATED,
     LoggingExported: NoobaaEvent.LOGGING_EXPORTED,
     UpgradeStarted: NoobaaEvent.CONFIG_DIR_UPGRADE_STARTED,
-    UpgradeSuccessful: NoobaaEvent.CONFIG_DIR_UPGRADE_SUCCESSFUL
+    UpgradeSuccessful: NoobaaEvent.CONFIG_DIR_UPGRADE_SUCCESSFUL,
+    LifecycleSuccessful: NoobaaEvent.LIFECYCLE_SUCCESSFUL
 };
 
 exports.ManageCLIResponse = ManageCLIResponse;

src/manage_nsfs/manage_nsfs_constants.js

@@ -96,7 +96,7 @@ const VALID_OPTIONS_CONNECTION = {
     'status': new Set(['name', 'decrypt', ...CLI_MUTUAL_OPTIONS]),
 };
 
-const VALID_OPTIONS_LIFECYCLE = new Set(['disable_service_validation', 'disable_runtime_validation', ...CLI_MUTUAL_OPTIONS]);
+const VALID_OPTIONS_LIFECYCLE = new Set(['disable_service_validation', 'disable_runtime_validation', 'short', ...CLI_MUTUAL_OPTIONS]);
 
 const VALID_OPTIONS_WHITELIST = new Set(['ips', ...CLI_MUTUAL_OPTIONS]);
 
@@ -158,6 +158,7 @@ const OPTION_TYPE = {
     // lifecycle options
     disable_service_validation: 'boolean',
     disable_runtime_validation: 'boolean',
+    short: 'boolean',
     //connection
     notification_protocol: 'string',
     agent_request_object: 'string',
@@ -170,7 +171,7 @@ const OPTION_TYPE = {
 
 const BOOLEAN_STRING_VALUES = ['true', 'false'];
 const BOOLEAN_STRING_OPTIONS = new Set(['allow_bucket_creation', 'regenerate', 'wide', 'show_secrets', 'force',
-    'force_md5_etag', 'iam_operate_on_root_account', 'all_account_details', 'all_bucket_details', 'anonymous', 'disable_service_validation', 'disable_runtime_validation']);
+    'force_md5_etag', 'iam_operate_on_root_account', 'all_account_details', 'all_bucket_details', 'anonymous', 'disable_service_validation', 'disable_runtime_validation', 'short']);
 
 // CLI UNSET VALUES
 const CLI_EMPTY_STRING = '';

src/manage_nsfs/manage_nsfs_events_utils.js

@@ -410,4 +410,52 @@ NoobaaEvent.NOTIFICATION_FAILED = Object.freeze({
     state: 'HEALTHY',
 });
 
+////////////////////////////
+//   LIFECYCLE EVENTS     //
+////////////////////////////
+
+NoobaaEvent.LIFECYCLE_STARTED = Object.freeze({
+    event_code: 'noobaa_lifecycle_worker_started',
+    entity_type: 'NODE',
+    event_type: 'INFO',
+    message: 'NooBaa Lifecycle worker run started.',
+    description: 'NooBaa Lifecycle worker run started.',
+    scope: 'NODE',
+    severity: 'INFO',
+    state: 'HEALTHY',
+});
+
+NoobaaEvent.LIFECYCLE_SUCCESSFUL = Object.freeze({
+    event_code: 'noobaa_lifecycle_worker_finished_successfully',
+    entity_type: 'NODE',
+    event_type: 'INFO',
+    message: 'NooBaa Lifecycle worker run finished successfully.',
+    description: 'NooBaa Lifecycle worker finished successfully.',
+    scope: 'NODE',
+    severity: 'INFO',
+    state: 'HEALTHY',
+});
+
+NoobaaEvent.LIFECYCLE_FAILED = Object.freeze({
+    event_code: 'noobaa_lifecycle_worker_failed',
+    message: 'NooBaa Failed to run lifecycle worker.',
+    description: 'NooBaa Lifecycle worker run failed due to an error.',
+    entity_type: 'NODE',
+    event_type: 'ERROR',
+    scope: 'NODE',
+    severity: 'ERROR',
+    state: 'DEGRADED',
+});
+
+NoobaaEvent.LIFECYCLE_TIMEOUT = Object.freeze({
+    event_code: 'noobaa_lifecycle_worker_timeout',
+    message: 'NooBaa lifecycle worker run timed out.',
+    description: 'NooBaa Lifecycle worker run timed out.',
+    entity_type: 'NODE',
+    event_type: 'ERROR',
+    scope: 'NODE',
+    severity: 'ERROR',
+    state: 'DEGRADED',
+});
+
 exports.NoobaaEvent = NoobaaEvent;