AYON Platform Update

Last updated About 2 months ago

The AYON Studio platform is composed of different components, and updates are run separately for each part.

Update AYON Web Server

Updating the AYON Server ensures you receive the latest features and fixes.

Cloud AYON Servers

For AYON cloud instances hosted on Ynput Cloud, you do not have to worry about this. Updates, backups, and rollbacks are well managed on our infrastructure.

Community AYON Server

Upgrades are usually safe, but downgrading requires extra attention, particularly in cases where database schema changes have occurred. If you skip the backup, you cannot restore the server's previous state, which risks permanent data loss if the update fails or downgrading is required.

A typical update procedure for a self-hosted AYON community server incorporates the following steps:

  1. Back up Server DB (HIGHLY RECOMMENDED).

  2. Update Server: Run the update via the command: docker compose up -d --build

  3. Rollback Procedure: If issues occur, modify the server version tag in your compose file, run docker compose up -d --build, and then restore the database backup taken prior to the upgrade (if you have taken one).

For further information about backing up your server DB and updating your AYON server, see:

Update AYON Production & Pipeline Features

Addons may be compatible with certain server versions. The compatibility check during bundle creation should inform you about the compatibility requirements. Ensure your AYON Server is running the required compatible version.

AYON is a modular platform, and extending its production or pipeline features follows this same procedure:

  1. Addon Market Updates: Navigate to the Addon Market and install the latest versions of your desired addons (e.g., Core, Applications, Review Sessions).

  2. Create New Bundle: In Studio Settings > Bundles, create a new bundle. Select the newly updated addon versions for inclusion.

  3. Update Pipeline Client Components:

    • Launcher: Update the AYON Launcher executable version in this new Bundle.

      Admins can update the available launcher executable versions list by downloading them from GitHub ayon-launcher/releases and uploading them to the AYON server.

    • Dependency Packages: If required by new addons, create and upload a new dependency package and assign it to the bundle.

  4. Addon Settings: Update any required Addon Settings in Studio or Project Settings (e.g., adding recent versions of DCCs in the Applications addon).

  5. Service Update: If a new addon version includes an associated service, spawn a new version of the service as required.

You can use the Update Pipeline Tool in the Web UI to quickly get a new bundle with the latest production approved pipeline release which include several DCC integration addons, AYON launcher and dependency packages. However, you will still need to manually update addon settings and services.

For more information:

Deploying DCC Dependencies

Some DCC integration addons include dependencies that needed to be installed on the DCC side for the respective addon to function correctly.

These dependencies could be:

  • Native plugins (e.g., for Unreal, Photoshop, and After Effects).

  • Python dependencies (e.g., installing PyQt for Blender and Unreal).

Typically, the associated AYON addon will attempt to install these dependencies automatically, if any are required, to ensure seamless integration and help avoid repeated manual effort on every user machine.

Exception: Render Farm Addons (Deadline & Royal Render)

For the Deadline & Royal Render Addons, installing their associated plugins will require some manual effort.

When updating Render Farm Addons, you might want to update their respective plugins as well. You can feel free to skip this step if you know the plugins remain unchanged in the new version.

For further information on how to update these plugins, please visit the documentation sections on: