Skip to content

Identifiers

An identifier is a unique ID that references a service or an environment and must be unique across all configuration. An identifier can be anything you like as long as it is expressed in kebab-case (lowercase).

Valid identifiers

  • prod
  • siem-prod
  • service-2-0

Invalid identifiers

  • PROD (identifiers must be lowercase)
  • siem_prod (underscore isn't accepted as a separator)
  • service-2.0 (the dot isn't accepted either)
  • foo- (ending hyphen)
  • -foo (leading hyphen)
  • foo----bar (multiple hyphens)

To create a service named my-service, either use the services command (recommended approach) or manually edit the configuration file to add the following block.

toml
[services]
[services.my-service]
... service definition ...

The service can then be referenced in the command line, for example:

sh
% lgc ping my-service

Uniqueness

Environments are loosely defined, so make sure they don't overlap with services names. For example, declaring a prod environment with a siem-prod service belonging to that environment is possible (and recommended!). However, if for some - weird - reason you wanted to have a service foo and an environment of the same name, that is not possible as lgc won't be able to distinguish the service from the environment.