Product Documentation

Create a Platform layer using Network File Share

Jan 11, 2018

This article explains how to create a Platform layer when there is not a Connector Configuration for your hypervisor.

When completing the Create Platform Layer wizard, you start by selecting the Network File Share (NFS) instead of a Connector Configuration. Then, you manually copy the OS disk for the layer to the hypervisor where you want to create your layers and/or publish your Layered Images. You attach the OS disk to a Packaging Machine and deploy it, then install the software, shut down the Packaging Machine, and copy the disk back to your appliance's Network File Share for importing into the new Platform layer.

Prerequisites

  • When creating a Platform Layer for Packaging Layers, you need the software and settings for the hypervisor where you are creating your layers.

  • When creating a Platform Layer for publishing Layered Images, you need the hypervisor prerequisites, plus the prerequisites for any provisioning service and/or connection broker that will run in the environment.

Prepare a new Platform layer

  1. Select Layers > Platform Layers and select Create Platform Layer in the Action bar. This opens the Create Platform Layer wizard.
  2. In the Version Details tab:
    1. Enter a name for the New Version. This can be the software version or other identifying information.
    2. If you are adding a version to an existing layer, the Base Version field lets you choose which version to use as the starting point. The default choice is the latest version. 
  3. In the OS Layer tab, select the OS Layer you want to associate with this Platform Layer.
  4. In the Connector tab, choose the Network File Share instead of a Connector Configuration.
  5. In the Platform Types tab, select the radio button that describes the purpose of this Platform Layer.
    • For creating and updating Layers - Required if you are creating Layers on a different hypervisor than the one from which you imported your OS.
    • For publishing Layered Images - Required whenever you publish Layered Images.
  6. If this Platform Layer is for:
    • Creating and updating layers - Select the hypervisor where you are building your layers.
    • Publishing Layered Images - Select the hypervisor, provisioning service, and connector broker that make up the environment where you will be publishing your Layered Images.
  7. In the Packaging Disk tab, enter a file name for the Packaging Disk, and select the disk format. This disk will be used for the Packaging Machine (the VM) where you will install the tools, as described in the next two sections.
  8. In the Icon Assignment tab, select an icon to assign to the layer. This icon represents the layer in the Layers Module.
    • To use an existing image, select an image in the image box.
    • To import a new image, click Browse and select an image in PNG or JPG format.
  9. In the Confirm and Complete tab, review the details of the App Layer, enter a comment if required, and click Create Layer. Any comments you enter will appear in the Information view Audit History. A Boot disk and a Packaging disk are created, and the Tasks bar displays instructions to navigate to them.
  10. Expand the Tasks bar at the bottom of the UI, and double-click the Packaging Disk task to show the full task description.

    Once the disks have been created, the Task bar displays the location of the disks on the Network File Share: /Unidesk/Packaging Disks.

Next, you can deploy the Packaging Machine for your Layer.

Deploy a Packaging Machine

The Packaging Machine is a temporary VM where you install the platform tools you want to include in the Layer.

Create the Packaging Machine

The Task Description (example shown in the last step above) contains the location in your environment where the disks for this Layer have been created.

  1. Log into the client for your hypervisor.
  2. Locate the Packaging disks in the following directory on the Network File Share:

    \Unidesk\Packaging Disks

  3. Copy the disks to the hypervisor where you will install the software for the Layer.

    Note: Even if the Packaging Disks in \Unidesk\Packaging Disks are already in the hypervisor where you will be installing the tools, we recommend copying the disks to another location. This is because when you use the disk to create a new VM, the directory will quickly become crowded with files generated by your hypervisor.

    Important: Do not copy the disk to the Finalize folder until it is ready to finalize. A disk in the Finalize folder cannot be attached to the new VM that you are going to create next.

  4. In your hypervisor, create a VM from the Boot disk and name it Layer_NameBoot.xxx.

  5. In your hypervisor, select the VM, and attach the disk called Layer_NamePkg.xxx to the VM.

  6. Create a virtual machine using the Packaging Disk as the boot disk. This is the Packaging Machine where you will install the application(s) to include in the layer.

  7. Power on the Packaging Machine.

Install the tools for your hypervisor, provisioning service and connection broker

This section explains how to install the tools your Layered Images will need to run your the target platform onto the Packaging Machine you just created. Keep in mind that the state of the software before you finalize the layer is what the image will use.

To install the tools for the selected platform:

  1. Remote log in to the Packaging Machine you created. Be sure to log in using the User account you used to create the OS.

  2. Install the tools that your Layered Image will need to run on vSphere and in PVS, along with any drivers, boot-level applications, or files needed.

    If a software installation requires a system restart, restart it manually. The Packaging Machine does not restart automatically.

  3. Make sure the Packaging Machine is in the state you want it to be in when the image is booted:

    • If the tools you install require any post-installation setup or registration, complete those steps now.
    • Remove any settings, configurations, files, mapped drives, or applications that you do not want to include on the Packaging Machine.

Next, you'll need to shut down the Packaging Machine and verify that the Platform Layer is ready to finalize.

Verify the layer and shut down the Packaging Machine

Once the tools are installed on the Packaging Machine, the next step is to verify that the Layer is ready to finalize. At this point, any required post-installation processing needs to be completed. For example, a reboot may be required, or a Microsoft NGen process may need to complete.

To verify that any outstanding processes are complete, you can run the Shutdown For Finalize tool (icon below), which appears on the Packaging Machine's desktop.

To use the Shutdown For Finalize tool:

  1. Copy the Packaging Machine to the Finalize folder on the Network File Share:

    \Unidesk\Finalize

  2. If you are not logged into the Packaging Machine, remote log in as the user who created the machine.
  3. Double-click the Shutdown For Finalize icon. A command line window displays messages detailing the layer verification process.
  4. If there is an outstanding operation that must be completed before the Layer can be finalized, you are prompted to complete the process. For example, if a Microsoft NGen operation needs to complete, you may be able to expedite the NGen operation, as detailed below.
  5. Once any pending operations are complete, double-click the Shutdown For Finalize icon again. This shuts down the Packaging Machine.

Layer Integrity messages you may see during finalization

Layer integrity messages let you know what queued tasks must be completed before a Layer is finalized.

The new Layer or Version can only be finalized when the following conditions have been addressed:

  • A reboot is pending to update drivers on the boot disk - please check and reboot the Packaging Machine.
  • A post-installation reboot is pending - please check and reboot the Packaging Machine.
  • An MSI install operation is in progress - please check the Packaging Machine.
  • A Microsoft NGen operation is in progress in the background.
    Note: If a Microsoft NGen operation is in progress, you may be able to expedite it, as described in the next section.

Expediting a Micrisoft NGen operation

NGen is the Microsoft Native Image Generator. It is part of the .NET system, and basically re-compiles .NET byte code into native images and constructs the registry entries to manage them. Windows will decide when to run NGen, based on what is being installed and what Windows detects in the configuration. When NGen is running, you must let it complete. An interrupted NGen operation can leave you with non-functioning .NET assemblies or other problems in the .NET system.

You have the choice of waiting for the NGen to complete in the background, or you can force the NGen to the foreground. You can also check the status of the NGen operation, as described below. However, every time you check the queue status, you are creating foreground activity, which might cause the background processing to temporarily pause.

Forcing the NGen to the foreground will allow you to view the progress and once the output has completed, you should be able to finalize the layer.

  1. Force an NGen operation to the foreground.

    Normally, NGen is a background operation and will pause if there is foreground activity. Bringing the task into the foreground can help the task to complete as quickly as possible. To do this:

    1. Open a command prompt as Administrator.

    2. Go to the Microsoft .NET Framework directory for the version currently in use:

      cd C:\Windows\Microsoft.NET\FrameworkNN\vX.X.XXXXX

    3. Enter the NGen command to execute the queued items:

      ngen update /force

      This brings the NGen task to the foreground in the command prompt, and lists the assemblies being compiled.

      Note: It’s okay if you see several compilation failed messages!

    4. Look in the Task Manager to see if an instance of MSCORSVW.EXE is running. If it is, you must allow it to complete, or re-run ngen update /force. Do not reboot to stop the task. You must allow it to complete.
  2. Check the status of an NGen operation

    1. Open a command prompt as Administrator.

    2. Check status by running this command:

      ngen queue status

    3. When you receive the following status, the NGen is complete, and you can finalize the Layer.

      The .NET Runtime Optimization Service is stopped

Finalize the layer

Once the platform tools are installed and the Packaging Machine has been verified and shut down, you are ready to finalize the layer.

Note: When you finalize a Layer, the App Layering appliance may delete the Packaging Machine to minimize storage space used.

  1. Return to the Management Console.
  2. Select Layers > Platform Layers.
  3. Select the Layer to finalize, and then select Finalize on the Action bar. The Layer is finalized and becomes Deployable.

When a layer is ready to finalize:

  1. Return to the Management Console.
  2. Select Layers > Platform Layers.
  3. Select the Platform Layer you just prepared, and select Finalize in the Action bar.
  4. Monitor the Task bar and verify that the layer becomes deployable.