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

Added csm auth docs for Preapproved guid feature #470

Merged
merged 5 commits into from
Feb 28, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions content/docs/authorization/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ If you feel that something is unclear or missing in this document, please open u
| [karavictl tenant list](#karavictl-tenant-list) | Lists tenant resources within CSM |
| [karavictl tenant revoke](#karavictl-tenant-revoke) | Get a tenant resource within CSM |
| [karavictl tenant delete](#karavictl-tenant-delete) | Deletes a tenant resource within CSM |
| [karavictl tenant update](#karavictl-tenant-update) | Updates a tenant resource within CSM |


## General Commands
Expand Down Expand Up @@ -1095,3 +1096,42 @@ karavictl tenant delete [flags]
$ karavictl tenant delete --name Alice
```
On success, there will be no output. You may run `karavictl tenant get --name <tenant-name>` to confirm the deletion occurred.



---



### karavictl tenant update

Updates a tenant's resource within CSM

##### Synopsis

Updates a tenant resource within CSM (currently only for powerflex)
Copy link
Contributor

Choose a reason for hiding this comment

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

no need to mention storage system applicability here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed reference to PowerFlex here


```
karavictl tenant update [flags]
```

#### Options

```
-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)
Copy link
Contributor

Choose a reason for hiding this comment

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

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'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

```

##### Options inherited from parent commands

```
--addr string Address of the server (default "localhost:443")
--config string config file (default is $HOME/.karavictl.yaml)
```

##### Output
```
$ 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 update was persisted.
10 changes: 10 additions & 0 deletions content/docs/authorization/configuration/proxy-server/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,16 @@ karavictl tenant create --name Finance --insecure --addr tenant.csm-authorizatio
>__Note__:
> - The `insecure` flag specifies to skip certificate validation when connecting to the tenant service. Run `karavictl tenant create --help` for help.

> - For the Powerflex Pre-approved Guid feature, the `approvesdc` boolean flag is `true` by default. If the `approvesdc` flag is false for a tenant, the proxy server will deny the requests to approve SDC if the SDCs are already in not-approved state. Inorder to change this flag for an already created tenant, see `tenant update` command in CLI section.

```yaml
# RPM Deployment
karavictl tenant create --name Finance --approvesdc=false --insecure --addr grpc.DNS-hostname:443

# Helm Deployment
karavictl tenant create --name Finance --approvesdc=false --insecure --addr tenant.csm-authorization.com:<ingress-nginx-controller-port>
```

### Configuring Roles

A `role` consists of a name, the storage to use, and the quota limit for the storage pool to be used. For example, to create a role named `FinanceRole` using the PowerFlex storage created above with a quota limit of 100GB in storage pool `myStoragePool`:
Expand Down