Skip to main content

Configuring Global Settings

Global settings enable you to control the behavior of the AtScale engine.

note

Global settings were previously called engine settings.

Global settings are defined in a file called global_settings.yml. Any settings defined in this file override AtScale’s default global settings.

The global settings file is managed in a dedicated Git repository. You can only have one global settings repository for your AtScale instance. This repository must only contain the global_settings.yml file and (optionally) a readme.

note

The global settings repository and file can only be accessed by users with the superuser_user role in the Identity Broker, which is automatically granted to admin and application_admin users. For more information on managing roles in AtScale, see Managing Users with the Identity Broker.

The following sections describe how to set up a global settings repository and manage your global settings.

Create a global settings repository and file​

To create a global settings repository:

  1. Create a new repository in Git.

  2. Link the repository to AtScale:

    1. In Design Center, click Settings in the main navigation bar. The Settings page opens.

    2. In the Settings Repo field, click the pencil icon.

    3. Enter the URL for the global settings repository, then click Save.

      note

      Unlike other repositories in AtScale, you cannot define a name for the global settings repository. It always appears in the Workspace panel as Global Settings.

  3. Open the Workspace panel and switch to the Global Settings repository.

  4. Click the new object icon at the top of the panel and select global_settings.yml. A global_settings.yml file is added to the repository.

You can now edit the file to define your global settings and apply them as needed. For instructions, see the following procedure.

Modify and apply global settings​

To modify global settings:

  1. In Design Center, open the Workspace panel and switch to the Global Settings repository.

  2. Open global_settings.yml and define overrides as needed. For more information, see the global settings file reference below.

  3. Click Save File.

  4. Go to the Source Control panel and commit and sync your changes.

    note

    You can optionally skip this step and apply the settings locally first to test them.

  5. To apply the settings, return to the Workspace panel, click the context menu for the global_settings.yml file, and select Apply Global Settings.

note

You may need to restart the AtScale engine for your changes to take effect. You can do this through your cluster.

Once you have committed and applied your changes, you can view your overrides on the Settings page.

Global settings file reference​

The global settings file supports the following properties.

object_type​

  • Type: const
  • Required: Y

The type of object defined by the file. For global settings files, the value of this property must be global_settings.

overrides​

  • Type: array
  • Required: N

A list of the global setting overrides you want to define. Each override must have the following syntax: “setting.name”: value. For example:

object_type: global_settings
overrides:
    "aggregate.snowflake.table.names.uppercase": true
    "query.drillthrough.max_rows": 1000