Skip to content

NC | Documentation and CLI help gaps #8595

@naveenpaul1

Description

@naveenpaul1

Environment info

  • NooBaa Version: 5.18
  • Platform: NC

Actual behavior

This issue is to track the gaps in NSFS documentation and CLI help command.

  1. notification is missing CLI help command
    Please run: sudo node src/cmd/manage_nsfs --help 2>/dev/null
    And see:
<type>    Set the resource type: account, bucket, whitelist, diagnose, logging or upgrade

(notifications also need to appear here).

  1. noobaa-cli upgrade <> CLI command do have CLI_MUTUAL_FLAGS? If yes we need to update it in upgrade help doc.

  2. If logging and diagnose commands are permitted when upgrading noobaa, then we need to update it under UPGRADE_START_OPTIONS.

  3. Check if we need to expand the text in: upgrade start
    Please run: sudo node src/cmd/manage_nsfs upgrade start --help 2>/dev/null
    And see:

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.

Do we want to refer also to other noobaa-cli commands here? (logging, notifications, diagnose, etc.)

  1. Update documentation on: logging, notifications

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions