Managing Remote Configurations

Remote configuration are configurations which have been created or imported using the Config Editor to be associated with one or more LogScale Collector instance using the Enroll command and token.

The Config Overview page provides information on the LogScale Collector configuration files you have created for remote centralized use, how they are being used, and details on all the enrolled instances of LogScale Collector.

This page also allows you to delete configuration files directly or create and edit files through the Config Editor.

Note

Note that if you want to switch the configuration assigned to an enrolled instance see Extending Remote Configurations.

  1. To access the Config Overview page go the Data ingest tab.

  2. Click Config overview and the page is displayed.

Creating a Remote Configuration

You can create a new configuration from this page which can then be assigned to multiple LogScale Collector instances and managed centrally.

  1. Go to Config overview and click + New Config.

    Config Overview

    Figure 21. Config Overview


  2. Type the name for your new configuration and click either:

    • Create New - creates a new configuration from scratch

    • Create from template and browse for a previously exported or manually created configuration file (.yaml).

      Create New Configuration

      Figure 22. Create New Configuration


  3. The Draft Editor is displayed, configure the file to meet your needs, note that you can only edit the sections: sources, sinks and settings, see Sources & Examples for more information.

    The editor helps by underlining misspelled or incorrectly positioned entities (incorrect level) and by auto-completing entities when you are inserting new entities, additionally you can hover-over entities for useful tips and information.

    Config Editor

    Figure 23. Config Editor


  4. You can perform additional tabs from this page:

    • Click the Information tab to change the name of the configuration or add a description.

    • Click the Test tab to view the status of the tests related to this configuration.

    • Export either the draft configuration or the currently published configuration.

    • Import a configuration as a starting point.

  5. Once you have finished making changes in the editor you can:

    • Click Save as draft to save the changes without publishing.

    • Click Start test to test your configuration file by publishing it to specific instances.

    • Click Publish draft to save the changes and publish them to all the instances which are using the configuration.

Editing a Remote Configuration

You can edit remote configuration and if they are assigned to multiple instances the changes will impact all of the instances of the LogScale Collector.

  1. Click the ellipsis menu next to the configuration you want to edit and click Edit config.

  2. Make the required changes, note that you can only edit the sections: sources, sinks and settings, see Sources & Examplesfor details on the file.

    Config Editor

    Figure 24. Config Editor


  3. You can perform additional tabs from this page:

    • Click the Information tab to change the name of the configuration or add a description.

    • Click the Edit log collector instances tab to assign instances to a configuration, unenroll an instance or view the details of an assigned instance.

    • Click the Test tab to view the status of the tests related to this configuration.

    • Export either the draft configuration or the currently published configuration.

    • Import a configuration as a starting point.

  4. Once you have finished making changes click either:

    • Save as draft to save the changes without publishing.

    • Start test to test a draft on a set of instance which you can choose in the next step, see Editing and Publishing a Test Configuration.

    • Click Publish to save the changes and publish them to all the instances which are using the configuration.

Export Configuration Template

You can export a configuration as a template which can then be imported and modified as required from the create new pop-up, see Creating a Configuration - Fleet.

  1. Go to the Config overview page.

    Config Overview

    Figure 25. Config Overview


  2. Click the ellipsis menu next to the configuration you want to export and click Export as template, you can also export from the editor page, see Editing a Remote Configuration.

  3. Select the a radio button to export either:

    • Published version

    • Draft version

    Export Pop-up

    Figure 26. Export Pop-up


    And click Export as template

  4. Browse for the location to save the file, specify a name for the file and click Save.

Deleting a Remote Configuration

You can delete a configuration from the Config overviewpage.

  1. Go to the Config overview page.

    Config Overview

    Figure 27. Config Overview


  2. Click the ellipsis menu next to the configuration you want to delete and click Delete config.

    Important

    It is not possible to delete a configuration which is associated to any instances.

  3. Click Delete config to confirm.

    Delete Pop-up

    Figure 28. Delete Pop-up


Testing a Remote Configuration

When you edit a configuration you can test the configuration on one or more instances before publishing the configuration to its assigned instances, this is useful when you want to test the impact of your changes without impacting instances which are collecting data.

  1. Go the Data ingest and select Config overview.

  2. Click on the ellipsis menu next to the configuration you want to change and select Edit config.

  3. You can test any changes which have been saved as draft, to do so click Start test and select the instance to which you want to assign the draft configuration.

To view the status and add instances to the configuration test see Editing and Publishing a Test Configuration.

Managing Configurations

The editor page consists of the following areas:

  • Information

    • change the name of a configuration

    • add a description for the configuration

      Information

      Figure 29. Information


  • Test status

    • Add/remove instance from the configuration test

    • View the status of instances assigned to a test

      Test status

      Figure 30. Test status


Editing Configuration Settings

This page allows you to edit some details about your configuration, like name and description.

  1. Go to Config overview and click the ellipsis menu next to the required configuration and select Config settings, the Information page is displayed.

    Information

    Figure 31. Information


  2. Once you have made the required changes on the Information page click Save changes.

Editing and Publishing a Test Configuration

The Test status page allows you to view the status of the instance on which you are testing a draft configuration, add or remove assigned instances and publish the test draft to all the instances assigned to the configuration. You can also see the status of the test configuration, which could be okay or error.

See Testing a Remote Configuration for information on how to test a draft.

  1. Go to Config overview and click the ellipsis menu next to the required configuration and select Test and the Test page is displayed.

    Test status

    Figure 32. Test status


  2. You can now:

    • Add or Remove instances: Click Assign instance select and deselect instances and click Assign instances to save the changes.

    • Remove an instance from the configuration test: Click ellipsis and Remove from test.

    • Publish Draft to All Assigned instances: Click Publish tested draft to assign the instances to their previous configurations, where applicable.

    • Revert assigned configurations: Click Revert to published config to reassign the instances to which the draft test is currently applied to their previous configurations, where applicable.