Skip to content
This repository has been archived by the owner on Nov 9, 2020. It is now read-only.

Update admin-cli.md #838

Merged
merged 7 commits into from
Dec 23, 2016
Merged

Update admin-cli.md #838

merged 7 commits into from
Dec 23, 2016

Conversation

lipingxue
Copy link
Contributor

Update user guide (admin-cli.md) accordingly after the DEFAULT_TENANT, DEFAULT_PRIVILEGE, and DEFAULT_DATASTORE change are introduced.

  • update existing samples with the latest command output
  • add a section about new command "tenant update"
  • update the description of command "tenant access add" regarding the "default_datastore" management.

@lipingxue
Copy link
Contributor Author

@pdhamdhere @kerneltime Please review it.


optional arguments:
-h, --help show this help message and exit
```

### Create
A tenant named "_DEFAULT" should have been created by system automatically before users try to create any tenant.
Copy link
Contributor

Choose a reason for hiding this comment

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

A tenant named "_DEFAULT" should have been created by system automatically before users try to create any tenant. => A tenant named "_DEFAULT" will be created automatically post install.

@kerneltime
Copy link
Contributor

We need a small write up of the default tenant behavior here
It should explain that default tenant is created.. what is the behavior for default tenant for datastores, when and what should a VM that gets assigned to default tenant expect..

@kerneltime
Copy link
Contributor

Will continue to review.

Copy link
Contributor

@msterin msterin left a comment

Choose a reason for hiding this comment

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

LGTM + a couple of small corrections

@@ -93,35 +99,100 @@ optional arguments:
-h, --help show this help message and exit
```

### Update
Update existing tenant. This command allows to update "Description", "Default_datastore" or rename an existing tenant.
Copy link
Contributor

Choose a reason for hiding this comment

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

This command allows to update "Description" and "Default_datastore" fields, or rename an existing tenant.

Datastore access Permissions granted: Choices =
['create', 'delete', 'mount', 'all']
--name NAME Tenant name
--allow-create Allow create and delete on datastore if set to True
Copy link
Contributor

Choose a reason for hiding this comment

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

the datastore to be consistent with other help

@lipingxue
Copy link
Contributor Author

@kerneltime
Mark has a detailed design about default_tenant, default_privilege and default_datastore here. #621
Please take a look. Should we just put a link to this document in tenancy.md or we can write a short paragraph based on this document.

@lipingxue
Copy link
Contributor Author

Address comments fro Ritesh. A small write up of the default tenant behavior is added.

@@ -17,6 +17,21 @@ limits at granularity of datastore.

Tenants can be created and managed via the [Admin CLI](/user-guide/admin-cli/#tenant)

## Default tenant
When a VM which does not belong to any tenant issues a request to vmdk_ops, this VM will be assumed to be in _DEFAULT tenant, and will get privileges
associated with this tenant. \_DEFAULT tenant will be automatically created by system post install, so by default vmdk_ops will support request from
Copy link
Contributor

@kerneltime kerneltime Dec 22, 2016

Choose a reason for hiding this comment

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

typo? _Default => _Default?

---------- ------------- ------------- ------------ --------------- ----------
datastore1 1 1 1 500.00GB 2.00TB
[root@localhost:~] /usr/lib/vmware/vmdkops/bin/vmdkops_admin.py tenant access ls --name=tenant1
Datastore Allow_create Max_volume_size Total_size
Copy link
Contributor

Choose a reason for hiding this comment

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

White space at the end

datastore1 1 1 1 500.00GB 2.00TB
[root@localhost:~] /usr/lib/vmware/vmdkops/bin/vmdkops_admin.py tenant access ls --name=tenant1
Datastore Allow_create Max_volume_size Total_size
---------- ------------ --------------- ----------
Copy link
Contributor

Choose a reason for hiding this comment

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

Here as well

Copy link
Contributor

@kerneltime kerneltime left a comment

Choose a reason for hiding this comment

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

some minor nits need addressing. LGTM

Copy link
Contributor

@shuklanirdesh82 shuklanirdesh82 left a comment

Choose a reason for hiding this comment

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

few Nits to keep it consistent with other help

usage: vmdkops_admin.py tenant create [-h] --name NAME
[--description DESCRIPTION]
[--vm-list vm1, vm2, ...]

optional arguments:
-h, --help show this help message and exit
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: show => Show (to keep it consistent with the rest)

[--new-name NEW_NAME]

optional arguments:
-h, --help show this help message and exit
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: same as above

usage: vmdkops_admin.py tenant rm [-h] --name NAME [--remove-volumes]

optional arguments:
-h, --help show this help message and exit
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: same as above

@lipingxue lipingxue merged commit 67cabe4 into master Dec 23, 2016
@msterin msterin deleted the tenant_document.liping branch January 10, 2017 07:29
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants