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.

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

NC | Documentation and CLI help gaps #8595

Open
naveenpaul1 opened this issue Dec 16, 2024 · 0 comments
Open

NC | Documentation and CLI help gaps #8595

naveenpaul1 opened this issue Dec 16, 2024 · 0 comments
Assignees
Labels

Comments

@naveenpaul1
Copy link
Contributor

naveenpaul1 commented Dec 16, 2024

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
@nimrod-becker nimrod-becker added the Non Containerized Non containerized label Dec 16, 2024
@romayalon romayalon changed the title NC | NSFC documentation and CLI help gaps NC | Documentation and CLI help gaps Dec 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants