Added csm auth docs for Preapproved guid feature #470
Conversation
ashleyvjoy
requested review from
Deepak-Ghivari,
gallacher,
mjsdell,
prablr79,
rajendraindukuri,
rajkumar-palani,
rsedlock1958 and
shanmydell
as code owners
content/docs/authorization/cli.md
Outdated
|
|
||
| ### karavictl tenant update | ||
|
|
||
| Updates a tenant's approvesdc boolean flag value within CSM only for Powerflex Pre-approved Guid feature |
There was a problem hiding this comment.
Make this a generic command description for tenant update, this could also support other features in the future.
There was a problem hiding this comment.
Made the changes.
This is the doc PR for Powerflex driver settings for this feature
#455
content/docs/authorization/cli.md
Outdated
| ``` | ||
| $ karavictl tenant update --name Alice --approvesdc=false | ||
| ``` | ||
| On success, there will be no output. You may run `karavictl tenant get --name <tenant-name>` to confirm the deletion occurred. |
There was a problem hiding this comment.
'to confirm the deletion occurred' should be changed to 'confirm the update was persisted'
There was a problem hiding this comment.
made the changes
content/docs/authorization/cli.md
Outdated
|
|
||
| ##### Synopsis | ||
|
|
||
| Updates a tenant resource within CSM (currently only for powerflex) |
There was a problem hiding this comment.
no need to mention storage system applicability here
There was a problem hiding this comment.
Removed reference to PowerFlex here
content/docs/authorization/cli.md
Outdated
| ``` | ||
| -h, --help help for create | ||
| -n, --name string Tenant name | ||
| --approvesdc boolean (Usage: --approvesdc=true/false | true value will allow the tenant's request to approve SDC pass through proxy server to powerflex array. false value will block the request to approve SDC if SDC is not in approved state) |
There was a problem hiding this comment.
Please mention this flag is only applicable for PowerFlex. Also can reword 'true value allows the tenant's SDC approval request to be forwarded to the PowerFlex array'
content/docs/authorization/cli.md
Outdated
| ``` | ||
| -h, --help help for create | ||
| -n, --name string Tenant name | ||
| --approvesdc boolean (Usage: --approvesdc=true/false | This flag is only applicable to PowerFlex. true value allows the tenant's SDC approval request to be forwarded to the PowerFlex array. false value will block the request to approve SDC if SDC is not in approved state) |
There was a problem hiding this comment.
Since this flag is being specified as boolean then Usage: --approvesdc=true/false isn't necessary. Can you align Tenant name and This flag ... statements?
Can this be refined to say something like Approve/Deny a tenant's SDC request ?
There was a problem hiding this comment.
It was kept as --approvesdc=true/false so as to not use the flag as approvesdc value as it is for other flags.
There was a problem hiding this comment.
Refined the statement as requested
* added csm auth docs for Preapproved guid feature * Updated documentation * addressed review comments * updated flag information * addressed review comments
Description
Doc updates - CSM Authorization for Powerflex Pre-approved GUIDs
GitHub Issues
List the GitHub issues impacted by this PR:
| GitHub Issue # |
| dell/csm#402 |
Checklist: