NC | Online Upgrade CLI

Signed-off-by: Romy <[email protected]>

Author: romayalon

src/cmd/manage_nsfs.js

@@ -18,6 +18,7 @@ const ManageCLIResponse = require('../manage_nsfs/manage_nsfs_cli_responses').Ma
 const manage_nsfs_glacier = require('../manage_nsfs/manage_nsfs_glacier');
 const manage_nsfs_logging = require('../manage_nsfs/manage_nsfs_logging');
 const noobaa_cli_diagnose = require('../manage_nsfs/diagnose');
+const noobaa_cli_upgrade = require('../manage_nsfs/upgrade');
 const nsfs_schema_utils = require('../manage_nsfs/nsfs_schema_utils');
 const { print_usage } = require('../manage_nsfs/manage_nsfs_help_utils');
 const { TYPES, ACTIONS, LIST_ACCOUNT_FILTERS, LIST_BUCKET_FILTERS, GLACIER_ACTIONS } = require('../manage_nsfs/manage_nsfs_constants');
@@ -65,6 +66,8 @@ async function main(argv = minimist(process.argv.slice(2))) {
             await logging_management();
         } else if (type === TYPES.DIAGNOSE) {
             await noobaa_cli_diagnose.manage_diagnose_operations(action, user_input, config_fs);
+        } else if (type === TYPES.UPGRADE) {
+            await noobaa_cli_upgrade.manage_upgrade_operations(action, config_fs);
         } else {
             // we should not get here (we check it before)
             throw_cli_error(ManageCLIError.InvalidType);

src/manage_nsfs/manage_nsfs_cli_errors.js

@@ -75,6 +75,12 @@ ManageCLIError.InvalidDiagnoseAction = Object.freeze({
     http_code: 400,
 });
 
+ManageCLIError.InvalidUpgradeAction = Object.freeze({
+    code: 'InvalidUpgradeAction',
+    message: 'Invalid action, available actions are start, status and history',
+    http_code: 400,
+});
+
 ManageCLIError.InvalidArgument = Object.freeze({
     code: 'InvalidArgument',
     message: 'Invalid argument',
@@ -89,7 +95,7 @@ ManageCLIError.InvalidArgumentType = Object.freeze({
 
 ManageCLIError.InvalidType = Object.freeze({
     code: 'InvalidType',
-    message: 'Invalid type, available types are account, bucket, logging or whitelist',
+    message: 'Invalid type, available types are account, bucket, logging, whitelist or upgrade',
     http_code: 400,
 });
 
@@ -445,6 +451,34 @@ ManageCLIError.BucketNotEmpty = Object.freeze({
     http_code: 400,
 });
 
+
+///////////////////////////////
+//      UPGRADE ERRORS       //
+///////////////////////////////
+
+ManageCLIError.UpgradeFailed = Object.freeze({
+    code: 'UpgradeFailed',
+    message: 'Upgrade request failed',
+    http_code: 500,
+});
+
+ManageCLIError.UpgradeStatusFailed = Object.freeze({
+    code: 'UpgradeStatusFailed',
+    message: 'Upgrade status request failed',
+    http_code: 500,
+});
+
+ManageCLIError.UpgradeHistoryFailed = Object.freeze({
+    code: 'UpgradeHistoryFailed',
+    message: 'Upgrade history request failed',
+    http_code: 500,
+});
+
+///////////////////////////////
+//       ERRORS MAPPING      //
+///////////////////////////////
+
+
 ManageCLIError.FS_ERRORS_TO_MANAGE = Object.freeze({
     EACCES: ManageCLIError.AccessDenied,
     EPERM: ManageCLIError.AccessDenied,

src/manage_nsfs/manage_nsfs_cli_responses.js

@@ -117,13 +117,37 @@ ManageCLIResponse.BucketList = Object.freeze({
 });
 
 ///////////////////////////////
-// LOGGING RESPONSES ///
+//     LOGGING RESPONSES     //
 ///////////////////////////////
+
 ManageCLIResponse.LoggingExported = Object.freeze({
     code: 'LoggingExported',
     status: {}
 });
 
+///////////////////////////////
+//     UPGRADE RESPONSES     //
+///////////////////////////////
+
+ManageCLIResponse.UpgradeSuccessful = Object.freeze({
+    code: 'UpgradeSuccessful',
+    status: {}
+});
+
+ManageCLIResponse.UpgradeStatus = Object.freeze({
+    code: 'UpgradeStatus',
+    status: {}
+});
+
+ManageCLIResponse.UpgradeHistory = Object.freeze({
+    code: 'UpgradeHistory',
+    status: {}
+});
+
+///////////////////////////////
+//  RESPONSES-EVENT MAPPING  //
+///////////////////////////////
+
 const NSFS_CLI_SUCCESS_EVENT_MAP = {
     AccountCreated: NoobaaEvent.ACCOUNT_CREATED,
     AccountDeleted: NoobaaEvent.ACCOUNT_DELETED,

src/manage_nsfs/manage_nsfs_constants.js

@@ -7,7 +7,8 @@ const TYPES = {
     IP_WHITELIST: 'whitelist',
     GLACIER: 'glacier',
     LOGGING: 'logging',
-    DIAGNOSE: 'diagnose'
+    DIAGNOSE: 'diagnose',
+    UPGRADE: 'upgrade'
 };
 
 const ACTIONS = {
@@ -30,6 +31,12 @@ const DIAGNOSE_ACTIONS = {
     METRICS: 'metrics'
 };
 
+const UPGRADE_ACTIONS = {
+    START: 'start',
+    STATUS: 'status',
+    HISTORY: 'history'
+};
+
 
 const CONFIG_ROOT_FLAG = 'config_root';
 const CLI_MUTUAL_OPTIONS = new Set([CONFIG_ROOT_FLAG, 'config_root_backend', 'debug']);
@@ -134,6 +141,7 @@ exports.TYPES = TYPES;
 exports.ACTIONS = ACTIONS;
 exports.GLACIER_ACTIONS = GLACIER_ACTIONS;
 exports.DIAGNOSE_ACTIONS = DIAGNOSE_ACTIONS;
+exports.UPGRADE_ACTIONS = UPGRADE_ACTIONS;
 exports.VALID_OPTIONS = VALID_OPTIONS;
 exports.OPTION_TYPE = OPTION_TYPE;
 exports.FROM_FILE = FROM_FILE;

src/manage_nsfs/manage_nsfs_help_utils.js

@@ -1,7 +1,7 @@
 /* Copyright (C) 2024 NooBaa */
 'use strict';
 
-const { TYPES, ACTIONS, GLACIER_ACTIONS, DIAGNOSE_ACTIONS } = require('./manage_nsfs_constants');
+const { TYPES, ACTIONS, GLACIER_ACTIONS, DIAGNOSE_ACTIONS, UPGRADE_ACTIONS } = require('./manage_nsfs_constants');
 
 const HELP = `
 Help:
@@ -281,6 +281,42 @@ Usage:
 
 `;
 
+
+const UPGRADE_OPTIONS = `
+Usage:
+
+'upgrade' is a noobaa-core command that will return the exported metrics of the deployed NooBaa system.
+
+Usage:
+
+    noobaa-cli upgrade <action> [flags]
+
+List of actions supported:
+
+    start
+    status
+    history
+    
+`;
+
+const UPGRADE_START_OPTIONS = `
+'upgrade start' is a noobaa-core command that will start config directory upgrade run.
+Run upgrade start after upgrading NooBaa RPMs on all the cluster nodes, after starting an upgrade of the config directory,
+S3 I/O, S3 Buckets getters and NooBaa CLI Account/Buckets/Whitelist getters operations will still be working
+But updates of the config directory will be blocked during the upgrade of the config directory.
+`;
+
+const UPGRADE_STATUS_OPTIONS = `
+'upgrade status' is a noobaa-core command that will return the status of an ongoing upgrade run.
+
+`;
+
+const UPGRADE_HISTORY_OPTIONS = `
+'upgrade history' is a noobaa-core command that will return the history of past upgrades.
+
+`;
+
+
 /** 
  * print_usage would print the help according to the arguments that were passed
  * @param {string} type
@@ -306,6 +342,9 @@ function print_usage(type, action) {
         case TYPES.DIAGNOSE:
             print_help_diagnose(action);
             break;
+        case TYPES.UPGRADE:
+            print_help_upgrade(action);
+            break;
         default:
             process.stdout.write(HELP + '\n');
             process.stdout.write(USAGE.trimStart() + '\n');
@@ -368,6 +407,9 @@ function print_help_bucket(action) {
     process.exit(0);
 }
 
+/**
+ * @param {string} action
+ */
 function print_help_glacier(action) {
     switch (action) {
         case GLACIER_ACTIONS.MIGRATE:
@@ -384,6 +426,9 @@ function print_help_glacier(action) {
     }
 }
 
+/**
+ * @param {string} action
+ */
 function print_help_diagnose(action) {
     switch (action) {
         case DIAGNOSE_ACTIONS.HEALTH:
@@ -400,5 +445,25 @@ function print_help_diagnose(action) {
     }
 }
 
+/**
+ * @param {string} action
+ */
+function print_help_upgrade(action) {
+    switch (action) {
+        case UPGRADE_ACTIONS.START:
+            process.stdout.write(UPGRADE_START_OPTIONS.trimStart());
+            break;
+        case UPGRADE_ACTIONS.STATUS:
+            process.stdout.write(UPGRADE_STATUS_OPTIONS.trimStart());
+            break;
+        case UPGRADE_ACTIONS.HISTORY:
+            process.stdout.write(UPGRADE_HISTORY_OPTIONS.trimStart());
+            break;
+        default:
+            process.stdout.write(UPGRADE_OPTIONS.trimStart());
+    }
+}
+
+
 // EXPORTS
 exports.print_usage = print_usage;

src/manage_nsfs/manage_nsfs_validations.js

@@ -12,7 +12,7 @@ const bucket_policy_utils = require('../endpoint/s3/s3_bucket_policy_utils');
 const { throw_cli_error, get_options_from_file, get_boolean_or_string_value,
     check_root_account_owns_user, get_bucket_owner_account} = require('../manage_nsfs/manage_nsfs_cli_utils');
 const { TYPES, ACTIONS, VALID_OPTIONS, OPTION_TYPE, FROM_FILE, BOOLEAN_STRING_VALUES, BOOLEAN_STRING_OPTIONS,
-    GLACIER_ACTIONS, LIST_UNSETABLE_OPTIONS, ANONYMOUS, DIAGNOSE_ACTIONS } = require('../manage_nsfs/manage_nsfs_constants');
+    GLACIER_ACTIONS, LIST_UNSETABLE_OPTIONS, ANONYMOUS, DIAGNOSE_ACTIONS, UPGRADE_ACTIONS } = require('../manage_nsfs/manage_nsfs_constants');
 const iam_utils = require('../endpoint/iam/iam_utils');
 
 /////////////////////////////
@@ -76,6 +76,8 @@ function validate_type_and_action(type, action) {
         if (!Object.values(GLACIER_ACTIONS).includes(action)) throw_cli_error(ManageCLIError.InvalidAction);
     } else if (type === TYPES.DIAGNOSE) {
         if (!Object.values(DIAGNOSE_ACTIONS).includes(action)) throw_cli_error(ManageCLIError.InvalidDiagnoseAction);
+    } else if (type === TYPES.UPGRADE) {
+        if (!Object.values(UPGRADE_ACTIONS).includes(action)) throw_cli_error(ManageCLIError.InvalidUpgradeAction);
     }
 }
 

src/manage_nsfs/upgrade.js

@@ -0,0 +1,79 @@
+/* Copyright (C) 2024 NooBaa */
+'use strict';
+
+const dbg = require('../util/debug_module')(__filename);
+const { ManageCLIError } = require('./manage_nsfs_cli_errors');
+const { UPGRADE_ACTIONS } = require('./manage_nsfs_constants');
+const { ManageCLIResponse } = require('../manage_nsfs/manage_nsfs_cli_responses');
+const { throw_cli_error, write_stdout_response } = require('./manage_nsfs_cli_utils');
+
+/**
+ * manage_upgrade_operations handles cli upgrade operations
+ * @param {string} action 
+ * @returns {Promise<Void>}
+ */
+async function manage_upgrade_operations(action, config_fs) {
+    switch (action) {
+        case UPGRADE_ACTIONS.START:
+            await exec_config_dir_upgrade();
+            break;
+        case UPGRADE_ACTIONS.STATUS:
+            await get_upgrade_status(config_fs);
+            break;
+        case UPGRADE_ACTIONS.HISTORY:
+            await get_upgrade_history(config_fs);
+            break;
+        default:
+            throw_cli_error(ManageCLIError.InvalidAction);
+    }
+}
+
+/**
+ * exec_config_dir_upgrade handles cli upgrade operation
+ * @returns {Promise<Void>}
+ */
+async function exec_config_dir_upgrade() {
+    try {
+        // TODO - add verifications and a call to the config directory upgrade
+        throw new Error('Upgrade Config Directory is not implemented yet');
+    } catch (err) {
+        dbg.warn('could not upgrade config directory successfully - err', err);
+        throw_cli_error({ ...ManageCLIError.UpgradeFailed, cause: err?.errors?.[0] || err });
+    }
+}
+
+/**
+ * get_upgrade_status handles cli upgrade status operation
+ * @param {import('../sdk/config_fs').ConfigFS} config_fs
+ * @returns {Promise<Void>}
+ */
+async function get_upgrade_status(config_fs) {
+    try {
+        const system_config = await config_fs.get_system_config_file();
+        const upgrade_status = system_config?.config_directory?.in_progress_upgrade;
+        if (!upgrade_status) throw new Error('Config directory upgrade status is empty, there is no ongoing config directory upgrade or there is an error', { cause: system_config });
+        write_stdout_response(ManageCLIResponse.UpgradeStatus, upgrade_status);
+    } catch (err) {
+        dbg.warn('could not get upgrade status response', err);
+        throw_cli_error({ ...ManageCLIError.UpgradeStatusFailed, cause: err?.errors?.[0] || err });
+    }
+}
+
+/**
+ * get_upgrade_history handles cli upgrade history operation
+ * @param {import('../sdk/config_fs').ConfigFS} config_fs
+ * @returns {Promise<Void>}
+ */
+async function get_upgrade_history(config_fs) {
+    try {
+        const system_config = await config_fs.get_system_config_file();
+        const upgrade_history = system_config?.config_directory?.upgrade_history;
+        if (!upgrade_history) throw new Error('Config directory upgrade history is empty', { cause: system_config });
+        write_stdout_response(ManageCLIResponse.UpgradeHistory, upgrade_history);
+    } catch (err) {
+        dbg.warn('could not get upgrade history response', err);
+        throw_cli_error({ ...ManageCLIError.UpgradeHistoryFailed, cause: err?.errors?.[0] || err });
+    }
+}
+
+exports.manage_upgrade_operations = manage_upgrade_operations;

src/sdk/config_fs.js

@@ -65,6 +65,7 @@ class ConfigFS {
         this.identities_dir_path = path.join(config_root, CONFIG_SUBDIRS.IDENTITIES);
         this.access_keys_dir_path = path.join(config_root, CONFIG_SUBDIRS.ACCESS_KEYS);
         this.buckets_dir_path = path.join(config_root, CONFIG_SUBDIRS.BUCKETS);
+        this.system_json_path = path.join(config_root, 'system.json');
         this.config_json_path = path.join(config_root, 'config.json');
         this.fs_context = fs_context || native_fs_utils.get_process_fs_context(this.config_root_backend);
     }
@@ -347,7 +348,7 @@ class ConfigFS {
      * @returns {string} 
     */
     get_identity_dir_path_by_id(id) {
-        return path.join(this.config_root, CONFIG_SUBDIRS.IDENTITIES, id, '/');
+        return path.join(this.identities_dir_path, id, '/');
     }
 
     /**
@@ -772,6 +773,14 @@ class ConfigFS {
         await native_fs_utils.delete_config_file(this.fs_context, this.buckets_dir_path, bucket_config_path);
     }
 
+    /**
+     * get_system_config_file read system.json file
+     * @returns {Promise<Object>}
+     */
+    async get_system_config_file() {
+        const system_data = await this.get_config_data(this.system_json_path);
+        return system_data;
+    }
 
     ////////////////////////
     ///     HELPERS     ////

src/test/system_tests/test_utils.js

@@ -239,7 +239,7 @@ function get_coretest_path() {
  * @param {string} type
  * @param {string} action
  * @param {object} options
- * @returns {Promise<string>}
+ * @returns {Promise<string | Error>}
  */
 async function exec_manage_cli(type, action, options, is_silent, env) {
     let flags = ``;