Product Documentation

Connect

May 30, 2018

The first time you use the App Layering service, you need to add at least one connector configuration to use for creating layers and publishing layered images.

A connector is an interface that gives the App Layering appliance access to your hypervisor or provisioning service for the purpose of creating layers or publishing layered images.

A connector configuration is a stored set of values for the App Layering appliance to use when connecting to a storage location in your hypervisor or provisioning service. Each connector configuration includes a storage location, credentials for authentication, and any other information required for the appliance to interface with the environment where you are creating layers and publishing layered images.

Connector configurations are required to:

  • Import your OS into an OS layer - When you create an OS layer, you need a connector configuration to give the appliance access to the location of the OS image.

  • Hyper-V: The Hyper-V connector configuration does not support OS import. Instead, you copy the prepared OS to the appliance’s FileShare for import into the OS layer.

  • Create layers When creating a Platform or App layer, and when adding a version to an OS, Platform, or App layer, you need a connector configuration with the credentials for the location in your environment where you are packaging the layers.

  • Publish layered images - You need a connector configuration for each location to which you are publishing layered images. Once published, you use layered images to provision server farms that serve specific groups of users.

Before you start

To create a connector configuration you need the account and credentials to access a location in your hypervisor or provisioning service. Each platform requires a different set of values. For details, see the connector configuration requirements for the platform(s) you are using.

You can create connector configurations using the management console System > Connectors tab.

Image of the Connectors tab

View your connector configurations

The System > Configuration tab lists the connector configurations that you have created.

By default the connectors are sorted by name. However, you can also sort them by name and platform. The info icon allows you to see a connector’s details, which vary based on the platform.

If you configure cache, you can see how much space is being used and the hit rate. Hit rate is a historical record of how well the cache is working. It is not what is currently in the cache, and will not change when layers are deleted. If you choose not to configure cache, the only details available to you are connector name and platform.

Add a connector configuration

To add a connector configuration, follow these steps:

  1. Access the management console, and select System > Connectors. This is where connector configurations are listed.
  2. Click Add Connector Config in the Action bar. This opens a dialog box where you can select the type of connector configuration to create.
  3. Choose the connector type from the drop-down menu.
  4. Complete the fields on the connector configuration page.
  5. Click the Test button to verify that the connector can access the location specified by using the credentials supplied.
  6. Click Save. The new connector configuration appears on the Connector tab.

Image of the connector configuration

You can also create a connector configuration when in the process of creating a new layer or adding a new version to the layer. To start the process: In the Create Layer wizard, click the Connector tab from the New Connector menu, and continue with the above process..

Edit a connector configuration

To edit a connector:

  1. Access the management console, and select System > Connectors.
  2. Select the connector and click Edit Connector Config on the action panel. The connector configuration is displayed.
  3. Update the configuration, as needed.
  4. Click the Test button to verify that the connector can access the location specified using the credentials supplied.
  5. Click Save. The connector configuration is updated.

Enable or disable caching

When caching is enabled for a connector, the Connectors tab displays the state of the cache for that connector configuration. Once caching is enabled for a connector configuration, you can specify the cache size.

Image of the cache size option

Caching is disabled by default. To enable caching:

  1. Select the connector and click Edit Connector Config on the action panel.
  2. Scroll to Layer Disk Cache Size in GB and enter the amount of space that the cache can occupy.
  3. Click the Test button to verify that the connector can access the location specified by using the credentials supplied.
  4. Click Save. The connector configuration is updated.

Delete a connector configuration

If a connector configuration is deleted by another user while you are working in the Connectors tab, it may take a few minutes for the connector configuration to disappear from the list.

To delete a connector configuration:

  1. In the management console, select System > Connectors.
  2. Make sure that the connector configuration is not in use.
  3. Click Delete on the Action bar.
  4. In the pop-up window that opens, select Yes. The connector configuration is deleted.

Error message

  • Validation Error: Unable to delete connector configuration ‘Citrix PVS - ConnectorExample’ as it is in use. If you receive this error message, remove the configuration from the layer or image template where it is still in use.

Image of the delete connector confirmation