Overview

What is an AYON Addon Service?

AYON Addons can include services, which are standalone, containerized Python scripts designed to run alongside the AYON server. These services help offload repetitive or resource-intensive tasks from the server. For example, a service can continuously monitor events on third-party production trackers like ftrack or Flow (Shotgrid) and respond to those events.

If an addon includes a service and isn’t functioning as expected, it’s often due to incorrect service setup.

Typically, these services are containerized using Docker and pushed to our Docker Hub library.

AYON Services Page

While you can manage these services using third-party tools, AYON provides a built-in solution for convenience. The Services Page (shortcut: v+v) allows you to easily manage your services. AYON automatically detects your addons, fetches their associated services from our Docker Hub library, and runs them on dedicated workers called AYON Service Host (ASH).

For more information about the required setup to manage your services through AYON, refer to the Prerequisites section below.

Prerequisites

To get your service up and running, you'll need to have an active AYON Service Host (ASH) and obtain an AYON API key.

• AYON Service Host (ASH): It hosts and runs the service. For additional info, see AYON Service Host (ASH).

  If you’re on an AYON subscription, your cloud AYON instance includes one pre-configured ASH worker. If needed, you can also set up additional service hosts on-premises by following the same steps.

• AYON API Key: Required for authentication. For more information on how to obtain an AYON API key, see the Add Service User section.

Working with AYON Services

The AYON services page v+v allows you to spawn, start, stop, and manage services as needed.

Spawn Services

To spawn a new service:

1. Navigate to the services page and click the + New Service button.

2. A window will appear where you can configure the following options:

   • Host: Select the AYON service host where the service will run.

   • Addon Name: Choose the addon from which the service will run.

   • Addon Version: Specify the addon version. Ensure the service version matches the addon version in your production bundle.

   • Service: Select the service you want to spawn.

   • Service Name: Provide a name for the service.

   • Advanced Settings:

     • Settings Variant: Choose the bundle for the addon settings.

     • Storages: Define the service’s storage location, exposing its Docker storage volume.

     • Ports: Define which ports the service should run on,

Manage Spawned Services

On the service page, you can manage services by right-clicking on them.
Available actions include:

• Start Selected: Start the chosen service(s).

• Stop Selected: Stop the chosen service(s).

• Edit Service: Modify the service host and advanced settings.

  

• Delete Selected: Remove the service.

Service Statuses

Services can have the following statuses:

• Unknown: The AYON server isn’t receiving a response from the service.

• Not Running: The service has been started but isn’t running yet.

• Running: The service is active and functioning as expected.

• Disabled: The service has been stopped.

Service Details

When you select a service, its details will appear on the right side of the page. This includes information about its configuration, status, and other relevant data.

FAQ

Is ASH paid?

ASH itself is free to use, however, some services may be part of paid addons. In such cases, you’ll need to purchase the addon to access those services.