Manage configuration group aliases

A configuration group alias is a human-readable name for a group. Use it in place of the group ID in the Telegraf Controller UI and API, including the short /c/ URL agents use to retrieve the group’s merged TOML.

Aliases share a single namespace across configurations and configuration groups and follow the same naming rules. For the naming rules, conflict and transfer semantics, and short URL behavior, see Manage configuration aliases.

Manage a group’s aliases

1. In the Telegraf Controller web interface, select Config Groups in the navigation bar.
2. Click the name of the group.
3. Select the Aliases tab.

The aliases table shows each alias and the number of agents reporting with it. Add an alias with Add Alias, and transfer or delete an alias from its row actions, exactly as for configuration aliases.

Repoint agents from a configuration to a group

Because the alias namespace spans configurations and groups, you can transfer an alias from a single configuration to a group. Agents that retrieve TOML by that alias switch from the single configuration to the group’s merged configuration on their next check, without any agent-side changes. Use this to migrate a fleet from one configuration to a composed role profile:

1. Build the group and review its merged TOML.
2. On the group’s Aliases tab, add the alias that is currently assigned to the configuration. Telegraf Controller reports the conflict, shows how many agents use the alias, and offers to transfer it.
3. Confirm the transfer. Agents using the alias load the group on their next watch interval.

To roll back, transfer the alias back to the original configuration.