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.

Access to the global settings repository and file is controlled by the global_settings_apply role in the Identity Broker, which is automatically granted to admin users. Only users with this role can view and modify global settings. 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.

Creating a global settings repository

note

Before performing this procedure, ensure that you have the global_settings_apply role assigned in the Identity Broker.

To create a global settings repository:

1. Create a new repository in Git.

2. Connect the repository to AtScale and set it as the global settings repository:

   1. In the main menu, select Settings.

   2. In the Settings panel, click Git Repositories.

   3. Click the plus icon.

   4. In the Add AtScale Git Repo panel, complete the following fields:

      • Repo name: Enter a name for the repository to use within AtScale.
      • URL: Enter the URL for the repository.

   5. Select the Global Settings Repo checkbox. This designates the repository as the global settings repository.

   6. Click Save.

3. In Design Center, open the Repo Browser and switch to the global settings repository.

4. Click the new object icon 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.

Modifying and applying global settings

note

Before performing this procedure, ensure that you have the global_settings_apply role assigned in the Identity Broker, and that you have created and connected a global settings repository, as described above.

To modify global settings:

1. In Design Center, open the Repo Browser and switch to the global settings repository.

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

3. Save the file.

4. Go to the Source Control panel and commit 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 Repo Browser, click the context menu for the global_settings.yml file, and select Apply Global Settings.

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

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