Deploying a Windows Azure Pack Management Portal Extension

 

Applies To: Windows Azure Pack

Deploying a Windows Azure Pack management portal extension is a two-step process. Firstly the extension is installed on a Windows Azure Pack deployment by the administrator. Secondly, if required, the extension is registered for use with the Service Management API.

Installing the Extension

A Windows Azure Pack for Windows Server management portal client-side installation consists of two installation folders; the administrator extension installed in the Windows Azure Pack management portal for administrators IIS website and the tenant management site extension in the management portal for tenants website. The server-side extension is a separate IIS website.

Installing the client-side extension in the management portal for administrator and the management portal for tenants is done by overwriting the extension binaries in the IIS site hosting the portal, then updating the last modified time on the web.config file for the portal. This forces IIS to reload the site.

The following table represents the installation folders for the Hello World Extension sample:

Folder

Description

\inetpub\MgmtSvc-HelloWorld

The Hello World custom provider site. For more information, see Implementing a Custom Server-Side REST Endpoint.

\inetpub\MgmtSvc-<Admin/Tenant>Site\Content\HelloWorldTenant

The Hello World Admin/Tenant site content files (scripts, styles, templates, HelloWorldExtension JavaScript and images).

\inetpub\MgmtSvc-<Admin/Tenant>Site\Manifests\ HelloWorldUIManifiest.xml

The Hello World tenant manifest. For more information, see Windows Azure Pack Management Portal Client-Side Extension Manifests

Hello World Setup Solution

Included in the sample hello world extension is a setup Windows Installer XML (WiX) Windows installation solution that creates a Windows Installer Package (MSI) installer file. The installer installs, updates, or removes the Hello World Custom Provider including the client-side and server-side management portal for administrators and the management portal for tenants. The WiX files are as follows:

File

Description

Product.wix

HelloWorld installation folder information.

Registry.wxi

Registry information. These are placed in HKLM\SOFTWARE\Microsoft\MgmtSvc\HelloWorld.

Upgrade.wxi

Upgrade installation logic.

Prerequisites.wxi

Prerequisites for installing the HelloWorld sample.

ARP.wxi

Add/Remove program information.

Registering the Extension

Once installed, the extension will be accessible from the Windows Azure Pack management portal for administrators. If the extension requires a resource provider to be registered with the Service Management API, an option should be provided in the management portal for administrators to do so. This option should become disabled once the registration is completed. For more information, see Custom Resource Provider Registration.

Windows Azure Pack Resource Provider Registration

Registering an Extension

During registration the Resource Provider should provide the credentials required to talk to the Resource Provider’s REST API endpoint. After this point, the extension should be usable from the Windows Azure Pack management portal for tenants. For the Hello World sample, the endpoint url is http://<computer-name>:30030/. This and this username and password are configurable in the Microsoft.WAP.Samples.HelloWorld.API Web.config file.

Windows Azure Pack Custom Provider Register Dialog

See Also

Windows Azure Pack Management Portal User Interface Extensions