lunar-cataloger.yml

Cataloger Plugins

• lunar-cataloger.yml

• Type: YAML file

• Form:

  version: 0
  
  name: <cataloger-name>
  description: <cataloger-description>
  author: <author-name>
  
  catalogers:
    - <cataloger-object>
    - <cataloger-object>
    - ...
  
  inputs:
    <input-name>:
      description: <input-description>
      default: <input-default-value>

This page describes the configuration of a cataloger plugin. Cataloger plugins are used to synchronize software catalog information from external systems. Cataloger plugins can be imported from the Lunar configuration file, lunar-config.yml via the uses cataloger form.

Cataloger plugins can be defined either in a separate repository or in the same repository as the Lunar configuration, in a dedicated directory. Either way, the cataloger plugin must contain a lunar-cataloger.yml file in the root of the repository or directory. This file is used to configure the behavior of the cataloger plugin.

When using catalogers in the Main or Run forms (e.g. mainBash or runBash), the cataloger plugin directory may also contain an install.sh file. This file can be used to specify any environment setup logic to be executed before executing the main script. In ephemeral environments, the installation is executed every time the environment is created. Lunar uses a lock file under the hood to detect if the script has previously been executed.

version

• lunar-cataloger.yml -> version

• Type: numeric

• Required

The version field is used to specify the version of the cataloger configuration file. The current version is 0.

name

• lunar-cataloger.yml -> name

• Type: string

• Required

The name field is used to specify the name of the cataloger.

description

• lunar-cataloger.yml -> description

• Type: string

• Optional

The description field is used to specify a description of the cataloger.

author

• lunar-cataloger.yml -> author

• Type: string

• Required

The author field is used to specify the author of the cataloger.

catalogers

• lunar-cataloger.yml -> catalogers

• Type: array

• Required

The catalogers field is used to specify the configuration of the cataloger. The format of a cataloger is the same as in lunar-config.yml. To learn more about the configuration of a cataloger, see the catalogers page.

inputs

• lunar-cataloger.yml -> inputs

• Type: object

• Optional

The inputs field is used to specify the inputs required by the cataloger. Each input is defined as a key-value pair, where the key is the input name.

Inputs are passed to the cataloger when invoked in the form of environment variables.

description

• lunar-cataloger.yml -> inputs.<input-name>.description

• Type: string

• Optional

The description field is used to specify a description of the input.

default

• lunar-cataloger.yml -> inputs.<input-name>.default

• Type: string

• Optional

The default field is used to specify the default value of the input. If no default value is specified, the input is required.