Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.maia.ai/llms.txt

Use this file to discover all available pages before exploring further.

If your s are deployed in your own cloud infrastructure in a Hybrid SaaS configuration, there are certain management tasks you can perform directly from the user interface. This article discusses those management tasks.
This article covers s only. For s, read Create a .

​
List Maia runner instances

To see a full list of s, in the left navigation, click s. Then, select Runners from the menu. The Runners list shows all s currently created, and for each it shows:
  • Runner: The name of the . Click the name to display the full details for the .
  • Status: The status of the . This will be one of the following:
    • Pending: The has been created but hasn’t yet connected to .
    • Running: The is connected and ready for development and pipeline tasks.
    • Unknown: The is in an unknown state.
    • Stopping: The is in the process of shutting down. Existing tasks are being allowed to complete, including any open transactions.
    • Stopped: The has been stopped.
    • Pausing: The has had a Pause request and is finishing existing tasks and/or transactions.
    • Paused: The has completed all work and any new requests are being queued. The may also have been stopped on the cloud provider if the offline indicator is present.
  • Platform: The cloud platform that the is installed on. Hover over this icon to read the description, which will include one of the following:
    • Snowflake.
    • AWS Fargate.
    • Azure Container App or ACI.
    • Matillion Hosted. This is a Full SaaS hosted and managed by Matillion. You will not be able to view further details or perform management actions on this .
  • Type: The type of , which will be or Streaming. For more details of s, read Create a .
  • Version reported by runner: This is the version of the currently installed in your cloud infrastructure. If a new version is available, this column will also display the notice Update Available.
Click the three dots … to the right of this information to display the actions menu for the .
The Runners list does not show which s are assigned to which projects. To see which is assigned to a project, go to the Environments tab of the project and observe the Default Runner column.You can also query environments via the API and get the name associated with each environment. Read the API documentation for details.

​
Maia runner details

On the Runners list, locate the you want to pause and click the ‘s name to open its details page. The details page displays information in four tabs:

​
Overview

  • Runner name: The name of the .
  • Description: The optional description you entered when you created the .
  • Runner status: The status of the . This will be one of the following:
    • Pending: The has been created but hasn’t yet connected to .
    • Running: The is connected and ready for development and pipeline tasks.
    • Unknown: The is in an unknown state.
    • Stopping: The is in the process of shutting down. Existing tasks are being allowed to complete, including any open transactions.
    • Stopped: The has been stopped.
    • Pausing: The has had a Pause request and is finishing existing tasks and/or transactions.
    • Paused: The has completed all work and any new requests are being queued. The may also have been stopped on the cloud provider if the offline indicator is present.
  • Type: The type of , which will be or Streaming. For more details of s, read Create a .
  • Cloud provider: The cloud platform that the is installed on. Currently, Snowflake, AWS, and Azure are supported.
  • Deployment: The supported deployment method for the given cloud provider. Currently, Native App for Snowflake, Fargate for AWS, and Container App/ACI for Azure are supported.
  • Auto update: If the has auto update enabled, then whenever a new version is released on its version track, the will be automatically updated to that version. You can change a ‘s auto update status at any time by toggling Auto update. Read Auto update for details of how this setting is applied.
  • Version track: The release version track that the is using, Current or Stable. Read Version tracks for details. If you need to change the track that an existing is on, you can use the Update a public API endpoint. However, take note of the following:
    • Changing the ‘s version track does not update the itself. You must update the image URI for the service in your cloud provider. If you don’t, the version may show as “Out of support”.
    • If you change the state from Current to Stable and update the installed service, pipelines created using a newer (Current) version might not run as expected on an older (Stable) version.
  • Latest version: The latest version of the that’s available on the version track.
  • Version release date: The date that the latest version of the was released by Matillion.
  • Version reported by runner: This is the version of the currently installed in your cloud infrastructure. If there is a discrepancy between this version number and the Latest version number, you should consider upgrading the . If you have enabled Auto update, the versions should be in sync.
  • Update Available: This will be displayed if a new version is available.

​
Deployment

This tab contains links to the template (either AWS CloudFormation or Azure ARM) used to deploy the in your cloud infrastructure. This tab will not be visible if there is no deployment option for the type, for example with Snowflake s.

​
Parameters

This tab displays the parameters you need to install your , and also optional parameters that you can set to specify functionality such as external drivers or Python libraries.

​
Credentials

Credentials include the Client ID and Client Secret that are used to authenticate the . These credentials are generated when you create the , and are required for the to connect to . Each must use its own unique Client ID and Client Secret, as credentials are specific to the individual and can’t be shared. For security, these credentials are obscured on screen. Click Reveal to display them. You can then click the Copy icon to copy them to the clipboard. You can also click Regenerate to generate a new set of credentials. This will invalidate the old credentials, so you should only do this if you are sure that the is not currently using them. Read Refresh credentials for more details.

​
Allow List

This tab lets you restrict which projects or environments can use the . This is useful if you have multiple s and want to ensure that a project only uses specific ones. Read Restricting s for details of this function.

​
Actions

To carry out management actions on a : On the Runners list, locate the in the Runners list, and click the three dots … to the right of it to open the actions menu. The actions that can be selected from this menu are described below.
  • Runner details: Select this action to view the full details page, described above.
  • Test connectivity: Select this action to test connectivity for the .
  • Restart runner: Select this action to restart the . Read Restart a for details.
  • Pause runner: Select this action to pause the . Read Pause a for details.
  • Remove runner: Select this action to delete the . Deleting the here doesn’t remove the underlying AWS or Azure resources. You should go into Snowflake’s Snowpark Container Services, AWS Console, or Azure Portal and clean up any resources that you no longer require.
Deleting a that is currently running may interrupt scheduled pipelines or pipelines that are currently running. Therefore, you should always stop the service before deleting it.

​
Test connectivity

You can perform a basic connection test for a . This tests the outbound connection from the to a specified host and port, and reports the result. A connection test can only be performed for a Running . If the has any other status, the option will be unavailable. To perform the test:
  1. On the Runners list, locate the in the Runners list, and click the three dots … to the right of it to open the actions menu.
  2. Click Test connectivity on the actions menu.
  3. Complete the details in the Test connectivity panel:
    • Endpoint: The domain name or IP address you want to test the connection to.
    • Port: The port number to connect to for the test.
  4. Click Test.
After a few seconds, the test response will be shown, in the following format: 
{
  "result": "SUCCESS",
  "host": "matillion.com",
  "port": 80
}
The result value in the response will show SUCCESS if the connection was successfully achieved, or TIMEOUT if it was not. If you receive the response Runner task failed: The runner version does not support this feature, you should upgrade your version as described in updates.