Skip to content

Commit 41a4012

Browse files
Template sharing doc update (apache#62)
* Template sharing doc update * images * typos fix * minor fix * minor addition * Minor updates
1 parent b7c8ca8 commit 41a4012

8 files changed

Lines changed: 66 additions & 1 deletion
19.6 KB
Loading
20.8 KB
Loading
19.4 KB
Loading
20.3 KB
Loading
14.4 KB
Loading
17.9 KB
Loading
18.1 KB
Loading

source/adminguide/templates.rst

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ Uploading Templates from a remote HTTP server
207207

208208

209209
vSphere Templates and ISOs
210-
--------------------------
210+
^^^^^^^^^^^^^^^^^^^^^^^^^^
211211
.. warning::
212212
If you are uploading a template that was created using vSphere Client,
213213
be sure the OVA file does not contain an ISO. If it does, the deployment
@@ -295,6 +295,57 @@ Example GUI dialog of uploading Template/ISO from local (browser) is given below
295295

296296
Note that uploading multi-disk templates is also supported.
297297

298+
Sharing templates with other accounts/projects
299+
----------------------------------------------
300+
301+
When adding a template, the owner can choose to make template public or to keep it private. Once the template is created, the owner can choose to share this template so that other accounts/projects can also use the template.
302+
303+
Currently, the template owner can share his template with:
304+
- other accounts inside his own domain (i.e. can't share the template with other accounts in the subdomain of his domain or any other domains)
305+
- projects where he belongs to (i.e. projects where he is the owner/creator or other projects where he has been joined)
306+
307+
Template permissions can be changed via updateTemplatePermissions API call or via GUI. It is supported to add, remove or reset (remove all) template permissions.
308+
309+
When adding or removing permissions to/from a template, it is required to specify account/project name which is being added/removed from the template permissions.
310+
311+
Global setting "allow.user.view.all.domain.accounts" has a default value of "false". This makes sure that when a regular user (of a "User" role) wants to share a template via GUI, he will not be shown the list of all accounts in his domain and he will need to know the name of the destination account with which he is sharing the template. This makes sense in public clouds where each account of a single domain is a different tenant/customer and privacy is imperative. In this case, the user will be presented with an input field to enter the account name, as on the images below:
312+
313+
|template-permissions-update-manually-1.PNG|
314+
315+
Sharing the template with account "user2"
316+
317+
|template-permissions-update-manually-2.PNG|
318+
319+
Revoking permissions from account "user2"
320+
321+
But in environments where privacy within a domain is not an issue, setting "allow.user.view.all.domain.accounts" setting to "true" will make sure that the user, who is sharing the template, will be presented a more user-friendly multi-select list, listing all the accounts in his domain. This is shown in the images below;
322+
323+
|template-permissions-update-1.PNG|
324+
325+
Sharing the template with just account "user8"
326+
327+
|template-permissions-update-2.PNG|
328+
329+
Sharing template with 2 specific projects
330+
331+
|template-permissions-update-3.PNG|
332+
333+
Revoking permissions from account "user8"
334+
335+
|template-permissions-update-4.PNG|
336+
337+
Revoking permissions from both projects previously added
338+
339+
340+
Finally, template permissions can be reset:
341+
342+
|template-permissions-update-5.PNG|
343+
344+
Resetting (removing all) permissions
345+
346+
.. warning::
347+
Project-owned templates are not supported to be shared outside of
348+
the Project, and if attempted to do so, a proper error message is shown.
298349

299350
Exporting Templates
300351
-------------------
@@ -339,3 +390,17 @@ template.
339390
:alt: Upload ISO from local
340391
.. |template-upload-from-local.PNG| image:: /_static/images/template-upload-from-local.PNG
341392
:alt: Upload Template from local
393+
.. |template-permissions-update-manually-1.PNG| image:: /_static/images/template-permissions-update-manually-1.PNG
394+
:alt: USharing template with account "user2"
395+
.. |template-permissions-update-manually-2.PNG| image:: /_static/images/template-permissions-update-manually-2.PNG
396+
:alt: Revoking permissions from account "user2"
397+
.. |template-permissions-update-1.PNG| image:: /_static/images/template-permissions-update-1.PNG
398+
:alt: Sharing template with just account "user8"
399+
.. |template-permissions-update-2.PNG| image:: /_static/images/template-permissions-update-2.PNG
400+
:alt: Sharing template with 2 specific projects
401+
.. |template-permissions-update-3.PNG| image:: /_static/images/template-permissions-update-3.PNG
402+
:alt: Revoking permissins from account "user8"
403+
.. |template-permissions-update-4.PNG| image:: /_static/images/template-permissions-update-4.PNG
404+
:alt: Revoking permsissons from both projects previously added
405+
.. |template-permissions-update-5.PNG| image:: /_static/images/template-permissions-update-5.PNG
406+
:alt: Reseting (removing all) permissions

0 commit comments

Comments
 (0)