Documented automatic plug-in installation and upgrade #2012

stuclem · 2018-09-03T12:52:55Z

Towards #1941. Documented automatic install and upgrade of the plug-ins.

Also fixes #1940.

stuclem · 2018-09-07T12:58:29Z

115d796, b2a9dd8 fixes #2037

stuclem · 2018-09-07T13:53:09Z

3288a99 is an attempt to fix #1356, to handle deployments with multiple appliances on the same VC. However, I am unsure of the logic of the checkbox. #1952 (comment) suggests that this checkbox was introduced to avoid automatically installing a version of the plug-in that conflicts with an existing appliance of another version. However, in vmware/vic-ui#365 (comment) @jooskim suggests that one must always run the plug-in installer for every appliance that you deploy, even if the plug-in is already installed (although this comment predates the automatic installer and doesn't take different appliance versions into account).

@zjs @renmaosheng can you please clarify the circumstances under which one should deselect the Install UI Plugin checkbox?

stuclem · 2018-09-07T13:54:46Z

I think that this PR is now ready for review. @zjs and @renmaosheng can you please review, or assign an appropriate reviewer? Thanks!

zjs · 2018-09-07T17:38:05Z

I'll take a look, but I'm also adding @morris-jason, who implemented most of the feature, and @wjun, who finished it.

zjs · 2018-09-07T17:42:03Z

docs/user_doc/vic_vsphere_admin/deploy_vic_appliance.md


-You can deploy multiple vSphere Integrated Containers appliances to the same vCenter Server instance. Also, if a Platform Services Controller manages multiple vCenter Server instances, you can deploy multiple appliances to different vCenter Server instances that share that Platform Services Controller.
+If you are deploying vSphere Integrated Containers 1.4.3 or later, by default the vSphere Integrated Containers plug-ins for the vSphere Client are installed automatically. The installer installs a basic plug-in for the Flex-based vSphere Web Client on vCenter Server 6.0, 6.5, or 6.7, and a plug-in with more complete functionality for the HTML5 vSphere Client on vCenter Server 6.5 and 6.7. If you are installing a version of vSphere Integrated Containers that pre-dates 1.4.3, you must install the plug-ins manually. 


The installer installs a basic plug-in for the Flex-based vSphere Web Client on vCenter Server 6.0, 6.5, or 6.7

I don't believe we install the Flex-based plugin on 6.7.

vic-product/installer/fileserver/tasks/plugin.go

Lines 426 to 447 in d6e5e98

func (p *Plugin) denyInstall(op trace.Operation, version string) bool {

vCenterVersion := strings.Split(version, ".")

if len(vCenterVersion) < 2 {

op.Debugf("Cannot filter vSphere version (%s) because it is not a semantic version", strings.Join(vCenterVersion, "."))

return false

}

semver := map[string]string{

"major": vCenterVersion[0],

"minor": vCenterVersion[1],

}

// Deny install if:

// Plugin is the flex plugin AND

// -- major version us 6 AND

// -- -- minor version is greater than Or equal to 7 OR

// -- major version is greater than or equal to 7

return p.Key == flexClientPluginKey &&

((semver["major"] == "6" && semver["minor"] == "7") ||

(semver["major"] == "6" && strings.Compare(semver["minor"], "7") == 1) ||

(strings.Compare(semver["major"], "6") == 1))

}

Also, according to test result of vmware/vic-ui#570 , I think we can document safely as below:

If you are deploying vSphere Integrated Containers 1.4.3 or later, by default the vSphere Integrated Containers plug-ins for the vSphere Client are installed automatically. The installer installs a basic plug-in for the Flex-based vSphere Web Client on vCenter Server 6.0, and a plug-in with more complete functionality for the HTML5 vSphere Client on vCenter Server 6.5 and 6.7. If you are installing a version of vSphere Integrated Containers that pre-dates 1.4.3, you must install the plug-ins manually.

@zjs and @wjun, having one plug-in for 6.0 and one for 6.5/6.7 makes things a lot simpler. Corrected the vSphere version and singularized the word "plug-ins" in 0d64bf5.

zjs · 2018-09-07T17:45:05Z

docs/user_doc/vic_vsphere_admin/deploy_vic_appliance.md

+
+    **NOTES**: 
+    - The option to automatically install the  plug-ins for the vSphere Client is available in vSphere Integrated Containers 1.4.3 and later. 
+    - By default, in an environment in which multiple vSphere Integrated Containers are deployed to the same vCenter Server instance, the vSphere Integrated Containers plug-in connects to whichever appliance was most recently registered with vCenter Server. Consequently, if there are older instances of the appliance registered with vCenter Server and you do not want the plug-in to automatically upgrade to the latest version, deselect the **Install UI Plugin** check box.


By default, in an environment in which multiple vSphere Integrated Containers are deployed to the same vCenter Server instance, the vSphere Integrated Containers plug-in connects to whichever appliance was most recently registered with vCenter Server.

Is this true? (I'm not sure what the current behavior is when multiple appliances are present.)

cc @wjun

The plugin behavior does not change in 1.4.3, so with multiple VIC instances existing, the plugin still pick up one instance with the previous algorithm which cannot guarantee the latest version to be selected. Thus, I think we could document like below:

in an environment in which multiple vSphere Integrated Containers are deployed to the same vCenter Server instance, the vSphere Integrated Containers plug-in connects to one appliance that may not be the most recently registered with vCenter Server. Consequently, if there are older instances of the appliance registered with vCenter Server and you do not want the plug-in to automatically upgrade to the latest version, deselect the Install UI Plugin check box.

Fixed in 1f2db4c.

zjs · 2018-09-07T17:45:31Z

docs/user_doc/vic_vsphere_admin/deploy_vic_appliance.md

+    - By default, in an environment in which multiple vSphere Integrated Containers are deployed to the same vCenter Server instance, the vSphere Integrated Containers plug-in connects to whichever appliance was most recently registered with vCenter Server. Consequently, if there are older instances of the appliance registered with vCenter Server and you do not want the plug-in to automatically upgrade to the latest version, deselect the **Install UI Plugin** check box.
+    - If you deselect the **Install UI Plugin** check box, you can install or upgrade the plug-ins later. 
+    - If you are installing a version of vSphere Integrated Containers that pre-dates 1.4.3, you must install the plug-ins manually.
+13. Verify that the certificate thumbprint for vCenter Server is valid, and click **Continue** to initialize the appliance.


I think we have a page about how to verify thumprints. Should this link there?

We do so from the prereqs. Our editorial guidelines advise against including links in procedure steps, which cause people go off and look at other stuff and then forget what they were doing or where they were in the procedure.

wjun · 2018-09-10T03:41:48Z

docs/user_doc/vic_vsphere_admin/upgrade_appliance.md

-6. Verify that the upgrade script has detected your upgrade path correctly.        
+8. To automatically upgrade the vSphere Integrated Containers plug-in for vSphere Client, enter `y` at the prompt to `Upgrade VIC UI Plugin`.
+
+    **NOTE**: The option to automatically upgrade the  plug-in for the vSphere Client is available in vSphere Integrated Containers 1.4.3 and later. If you you enter `n` to skip the plug-in upgrade, you can upgrade the plug-in later. If are upgrading to a version of vSphere Integrated Containers that pre-dates 1.4.3, you must upgrade the plug-in manually.


"In are upgrading to a version of vSphere Integrated Containers", missing 'you'

Fixed in b2c586a

wjun

My comments are addressed.

stuclem · 2018-09-11T12:59:37Z

Thanks @wjun !

stuclem · 2018-09-12T07:04:27Z

@lgayatri needs the auto-install/upgrade docs for testing purposes. Merging. @morris-jason please feel free to make comments even after I have merged.

Documented automatic plug-in installation.

e70b068

vmwclabot added the cla-not-required label Sep 3, 2018

stuclem added 2 commits September 3, 2018 14:56

Minor rewording

01554ba

Updated upgrade docs for auto-upgrade of plug-ins

3a79589

stuclem changed the title ~~WIP: Documented automatic plug-in installation.~~ WIP: Documented automatic plug-in installation and upgrade Sep 4, 2018

stuclem mentioned this pull request Sep 4, 2018

Getting Started page is no longer called Getting Started #2015

Closed

stuclem added 5 commits September 5, 2018 10:28

Adding deployment topologies and how client handles multi-OVAs

83e5e93

Removing deployment topologies from this PR

a522a7d

Updating manual upgrade procedure and added 1.4.3 bundle

86a5f68

Added 1.4.3 to manual plug-in install

aa2fd89

Documented post-deployment install/upgrade for 1.4.3

b2a9dd8

stuclem added 3 commits September 7, 2018 15:01

Mentioned that UI files are not in bundle in 1.4.3

115d796

Minor edits from self-proofread

485c970

Attempting to document multi-OVA behaviour with plug-in

3288a99

stuclem requested review from renmaosheng and zjs September 7, 2018 13:53

stuclem changed the title ~~WIP: Documented automatic plug-in installation and upgrade~~ Documented automatic plug-in installation and upgrade Sep 7, 2018

zjs requested review from wjun and a user September 7, 2018 17:36

zjs reviewed Sep 7, 2018

View reviewed changes

wjun reviewed Sep 10, 2018

View reviewed changes

stuclem mentioned this pull request Sep 10, 2018

Added topic on multiple appliance deployment topologies #2020

Merged

stuclem added 3 commits September 10, 2018 16:26

Corrected vSphere versions for plug-in, and singularized "plug-ins"

0d64bf5

Comment from wjun

1f2db4c

Typo

b2c586a

stuclem removed the request for review from renmaosheng September 10, 2018 14:38

stuclem added 2 commits September 10, 2018 17:17

Another typo

06966ac

Added auto-upgrade for plug-in to the manual method.

17170af

wjun approved these changes Sep 11, 2018

View reviewed changes

stuclem merged commit 0a6415e into vmware:master Sep 12, 2018

stuclem deleted the auto-plugins branch September 12, 2018 07:04

This was referenced Sep 12, 2018

Document automated installation/upgrade of the vSphere Client plug-in #1941

Closed

Document that UI bundle is no longer included in the VIC Engine bundle #2037

Closed

stuclem added the area/pub Published documentation for end-users label Sep 18, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documented automatic plug-in installation and upgrade #2012

Documented automatic plug-in installation and upgrade #2012

stuclem commented Sep 3, 2018 •

edited

Loading

stuclem commented Sep 7, 2018 •

edited

Loading

stuclem commented Sep 7, 2018

stuclem commented Sep 7, 2018

zjs commented Sep 7, 2018

zjs Sep 7, 2018

wjun Sep 10, 2018

stuclem Sep 10, 2018

zjs Sep 7, 2018

wjun Sep 10, 2018

stuclem Sep 10, 2018

zjs Sep 7, 2018

stuclem Sep 10, 2018

wjun Sep 10, 2018

stuclem Sep 10, 2018

wjun left a comment

stuclem commented Sep 11, 2018

stuclem commented Sep 12, 2018


		You can deploy multiple vSphere Integrated Containers appliances to the same vCenter Server instance. Also, if a Platform Services Controller manages multiple vCenter Server instances, you can deploy multiple appliances to different vCenter Server instances that share that Platform Services Controller.
		If you are deploying vSphere Integrated Containers 1.4.3 or later, by default the vSphere Integrated Containers plug-ins for the vSphere Client are installed automatically. The installer installs a basic plug-in for the Flex-based vSphere Web Client on vCenter Server 6.0, 6.5, or 6.7, and a plug-in with more complete functionality for the HTML5 vSphere Client on vCenter Server 6.5 and 6.7. If you are installing a version of vSphere Integrated Containers that pre-dates 1.4.3, you must install the plug-ins manually.

	func (p *Plugin) denyInstall(op trace.Operation, version string) bool {
	vCenterVersion := strings.Split(version, ".")

	if len(vCenterVersion) < 2 {
	op.Debugf("Cannot filter vSphere version (%s) because it is not a semantic version", strings.Join(vCenterVersion, "."))
	return false
	}
	semver := map[string]string{
	"major": vCenterVersion[0],
	"minor": vCenterVersion[1],
	}
	// Deny install if:
	// Plugin is the flex plugin AND
	// -- major version us 6 AND
	// -- -- minor version is greater than Or equal to 7 OR
	// -- major version is greater than or equal to 7
	return p.Key == flexClientPluginKey &&
	((semver["major"] == "6" && semver["minor"] == "7") \|\|
	(semver["major"] == "6" && strings.Compare(semver["minor"], "7") == 1) \|\|
	(strings.Compare(semver["major"], "6") == 1))

	}

Documented automatic plug-in installation and upgrade #2012

Documented automatic plug-in installation and upgrade #2012

Conversation

stuclem commented Sep 3, 2018 • edited Loading

stuclem commented Sep 7, 2018 • edited Loading

stuclem commented Sep 7, 2018

stuclem commented Sep 7, 2018

zjs commented Sep 7, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wjun left a comment

Choose a reason for hiding this comment

stuclem commented Sep 11, 2018

stuclem commented Sep 12, 2018

stuclem commented Sep 3, 2018 •

edited

Loading

stuclem commented Sep 7, 2018 •

edited

Loading