Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

NSFS | noobaa-cli Help format Update #8581

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

NSFS | noobaa-cli Help format Update #8581

wants to merge 1 commit into from

Conversation

naveenpaul1
Copy link
Contributor

Explain the changes

  1. Noobaa CLI help output updated to below format for all the CLI commnds
node src/cmd/manage_nsfs upgrade --help 2>/dev/null
Help:

    'upgrade' noobaa-core command will initiate version upgrade and also return the upgrade status or history.

Usage:

    noobaa-cli upgrade <action> [flags]

List of actions supported:

    start
    status
    history

Issues: Fixed #xxx / Gap #xxx

  1. NC | noobaa-cli Help Needs Update in action Part #8565

Testing Instructions:

  1. run help command for all the CLI combinations.

Note : Doc is not updated for the MD5 changes

  • Doc added/updated
  • Tests added

@romayalon
Copy link
Contributor

@naveenpaul1 when you put the issue under the fixes section you must have 'Fixed' keyword before so it'll close the issue automatically.
@shirady please review this PR, thanks in advance

@naveenpaul1 naveenpaul1 linked an issue Dec 5, 2024 that may be closed by this pull request
NC | noobaa-cli Help Needs Update in action Part #8565
Open
shirady
shirady reviewed Dec 8, 2024
View reviewed changes
Copy link
Contributor

@shirady shirady left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added comments and also mentioned other team member as I think we can improve and make it more accurate.

src/manage_nsfs/manage_nsfs_help_utils.js Outdated Show resolved Hide resolved
src/manage_nsfs/manage_nsfs_help_utils.js Outdated Show resolved Hide resolved
src/manage_nsfs/manage_nsfs_help_utils.js
Comment on lines 11 to 12
"noobaa-cli" will provide a command line interface (CLI) to create new accounts and map existing directories
to NooBaa as buckets. For more information refer to the NooBaa docs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can also update this part, we have more options in the menu.
@romayalon what do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shirady I think we should not add all the details here. A small description like this should be enough.

src/manage_nsfs/manage_nsfs_help_utils.js Outdated Show resolved Hide resolved
src/manage_nsfs/manage_nsfs_help_utils.js
logging Use this to upload all the bucket logging collected in the system to their target buckets
Help:

Use this to upload all the bucket logging collected in the system to their target buckets
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I understand this.
@jackyalbo can we make it more clear?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shirady its better to discuss this in another PR, This PR only update the format, not the content

src/manage_nsfs/manage_nsfs_help_utils.js
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why in some cases we have this line "execute with root permission or use sudo before each command" and in other cases we don't?
I would leave this only in sudo node src/cmd/manage_nsfs --help.

src/manage_nsfs/manage_nsfs_help_utils.js Show resolved Hide resolved
src/manage_nsfs/manage_nsfs_help_utils.js

'upgrade start' is a noobaa-cli 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@romayalon - NooBaa CLI logging and diagnose are not available?

src/manage_nsfs/manage_nsfs_help_utils.js Outdated
@@ -18,191 +19,298 @@ Usage:
execute with root permission or use sudo before each command

noobaa-cli <type> <action> [flags]

`;

const ARGUMENTS = `
Arguments:

<type> Set the resource type: account, bucket, whitelist, diagnose, logging or upgrade
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

notification is missing here?
@alphaprinz do you plan to update it in a separate PR?

src/manage_nsfs/manage_nsfs_help_utils.js

Usage:

noobaa-cli upgrade status
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@romayalon we don't have any flag? (not even those in CLI_MUTUAL_FLAGS? config_root, config_root_backend, debug?)
Same question for upgrade start and upgrade history

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shirady shirady shirady left review comments

@romayalon romayalon Awaiting requested review from romayalon

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
size/L
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

NC | noobaa-cli Help Needs Update in action Part
3 participants
@naveenpaul1 @romayalon @shirady