File: lgc.yaml

The recommended approach to create or modify the lgc.yaml configuration file is using the lgc command.

However, in some situations, it is handy to directly create or modify the file manually. This section details the specifications of the lgc.yaml.

Important

LogCraft CLI uses kebab-case as a naming convention for identifiers.

# List the installed plugins. They then are instanciated as
# services.
plugins:
  <plugin-name>:
    source:
      type: Local
      location: .logcraft/<plugin-name>
    author: <author>
    description: <description>
    version: <semver>

# Instanciate plugins as services
services:
  # specifications
  - id: <service-id>
    plugin: <plugin-name>
    settings:
      <plugin-settings>
  # example
  - id: splunk-prod
    plugin: splunk
    settings:
      authorization_scheme: Bearer
      authorization: ef02fe....
      endpoint: https://my-splunk-instance.my-domain.local:8089

# Aggregate services per zones, as environments.
envs:
  # specifications
  - id: <service-id>
    services: 
      - <list-of-services>
  # example
  - name: prod
    services:
        - splunk-prod