May 30, 2018
The App Layering upgrade process is partially automated. The appliance periodically checks for upgrades, and downloads available packages to your appliance. The appliance verifies the downloaded package, and extracts the files in the background.
When you next log in, a message indicates that an upgrade is ready to install. You can run the upgrade by clicking the Start Upgrade button. Or, you can dismiss the message and start the upgrade later by selecting System tab > Manage Appliance > Upgrade.
Notification when an upgrade is available
When an upgrade is available, every user receives a notification when they log in. As you would expect, only an administrator can run the upgrade. Notifications you may receive include:
- If an update is not available - Nothing happens. Another check is made at the next scheduled interval.
- If an update is available, but there is no network file share configured - The user receives a message that there is an upgrade available and that the administrator needs to finish configuring a network file share before it can be downloaded and applied.
If an update is available - A job is started to “Download Upgrade Media.” You can check for progress through the following tasks:
- Downloading the upgrade media to local storage.
- Ensuring the checksum of the successfully downloaded upgrade package is correct.
- Extracting the downloaded upgrade package to the configured Network File Share. The download is extracted to the appliance’s file share:
- If extraction is successful, the next time any user logs in they will be notified that an upgrade is available.
- If at any time during this process an error is encountered that requires Administrator intervention (out of space on local storage, out of space on the network file share, invalid file found, etc.) the job will fail with an appropriate error.
If a job fails it will be retried at the next check interval regardless of whether the Administrator has resolved the fixed.
- If another update is found before a previously downloaded one is installed - The new upgrade is downloaded, and once successfully completed, becomes the “Upgrade Available.”
- If one upgrade is downloading when another is made available - The running download is aborted and a new download is started. All files related to the in-progress download are deleted.
Before you start
Verify that a network file share has been configured. You can confirm the share by logging onto the appliance, navigating to System > Settings and Configuration, and finding the network file share setting. After ensuring you configured the file share, you can upgrade the appliance.
Back up the appliance. Take a snapshot or checkpoint of the appliance.
Check for available upgrades (optional)
In most cases you won’t need to check for updates, given the periodic checks and notifications. However, if you want to check, you can. Here’s how.
Log in as Administrator.
Click the Start Upgrade button to open the Upgrade Wizard. The downloaded information is displayed in the Upgrade Disk field.
As Administrator, you can select a different Upgrade Disk. You can also run the Upgrade “manually” by going to the System tab and selecting the Upgrade action as before. If an upgrade is available, the Upgrade Disk appears.
When a user who does not have administrator privileges logs in, the user cannot click the Start Upgrade button nor launch the Upgrade wizard. The user should report the available upgrade to their administrator.
Manually download the App Layering upgrade
If automatic downloading is not occurring due to firewall requirements, you can manually download the latest upgrade package from the Citrix download site. After downloading, copy the package to the network file share so that the appliance can access it.
- Navigate to the .zip file and extract the files.
- Log on to the management console, select System and then click Upgrade to start the Upgrade Wizard.
- On the Upgrade Disk Details tab, click Browse.
- Navigate to the upgrade file, and click Choose.
- Verify the upgrade path, and click Upgrade. The upgrade process starts and opens a status page in the browser.
- When the upgrade is complete, the status changes to Upgrade Status: Complete. Refresh the webpage to return to the management console.
- Verify that the upgrade was successful by clicking the About link in the management console to confirm the version number.
Upgrade the App Layering agent (if you are using the agent)
To upgrade the App Layering agent:
- Uninstall the previous version of the App Layering agent from the server(s) where they are installed.
- Make sure that you have copied the App Layering agent Upgrade file to the server(s) where the agent is installed.
- Double-click the agent upgrade file, and follow the instructions for upgrading the agent.
Create a Citrix Cloud Connector (if you are new to Citrix Cloud)
If you are upgrading from 4.0.x to 4.1.0 or later, you can access the App Layering Management Console via the Citrix Cloud, but you’ll need a Citrix Cloud Connector to do so. If you don’t yet have a Cloud Connector, you can create one as described here. For known issues when accessing the Management Console via the Cloud, see the list of issues below.
Log in to the Citrix Cloud. A Citrix App Layering tile should be displayed at the bottom of the page.
On the Citrix App Layering tile, click Request Trial, and check your email for a message from Citrix Cloud.
In the message you received, click the Sign In button. This returns you to the Cloud.
Click Manage on the App Layering tile. The Citrix App Layering page is displayed.
Get familiar with the service by reading the Overview. When ready, click the Get Started button to open the Getting Started tab.
Under Step 1, click the Get Cloud Connector button, and for instructions click the Documentation link.
Use the Connector documentation to install a Cloud Connector, then return to the Getting Started tab.
Under Step 4, the Documentation link opens the instructions for logging in. (The link below opens the same article.)
Click the Log into Appliance button. This opens the Manage tab. Follow the instructions to access the appliance.
Known issues and considerations with Management Console access via Citrix Cloud (App Layering Labs)
As an App Layering Labs feature (not intended for use in production), you may encounter a few behaviors that are either not optimal or not yet implemented.
- Accessing the console. Accessing the console via the Cloud can take up to one minute. As the console is being launched, the page is white. And every time you log in, you must re-enter the IP address.
- Session timeout error. If you see a session timeout error, click within the window and press Control-R to refresh.
Hidden controls and tabs.
- Expanding menu. Near the top of the page, there is an expandable menu where you can access Receiver and other options. Click the Receiver icon to expand the menu.
- Browser tab bar. Toward the bottom of the page, hover over the black bar. A browser tab bar is revealed, where each page you have open is displayed in a tab in the black bar. For example, when you open the documentation, you can use the Browser tab bar to return to the Management Console.
- Remember Me feature. The Remember Me feature does not save your user name.
- Session Timeout. A System Settings Timeout longer than 10 minutes is currently not honored.
- Uploads. Layer and Image Icons, and Certificates must be uploaded when accessing the Management Console via a web browser, rather than via the Cloud.
- Export Log Files requires Email Send Option. When you export App Layering log files, you must select the Email option on the Send Options tab, as the logs cannot be downloaded via the cloud.
- vSphere packaging links during Layer Creation. In the Management Console Taskbar, vSphere packaging links are broken.
- Copy and Paste. Copy and Paste between the Receiver window and the local clipboard must be performed using the Receiver clipboard.
- Access via Tablets and Phones. Tablet and phone usage is not supported. This is designed for the full browser experience.