Creating the Metadata Files and the Zip Archive

To add your own technologies to the Saagie Technology Catalog, each technology must be declared in its own metadata.yaml file. The file(s) must then be compressed in a .zip format to constitute the technology repository.

  • Saagie uses three types of technologies: jobs, apps, and external jobs.

  • Saagie supports both .yml and .yaml extensions.

  1. Create the metadata.yaml or metadata.yml file. You can use the attribute reference tables, and the metadata example files to help you create your files.

    External technologies require a more advanced setup. This includes additional information about the connection to the external service, and the execution of the life cycle of the external job instance.

  2. Save your file(s) according to the following architecture:

    • The app and job technologies are in separate folders, which are grouped in a main folder.

      Job and external job technologies are in the same folder.
    • The app and job technology folders have a subdirectory for each technology.

    • Each technology subdirectory has its own metadata.yaml file. It can also have a PNG or JPEG file containing the technology icon.

      • The icon size limit is 64 Ko and it must be square in shape.

      • External technologies must include the referenced JavaScript files.

      Folder Hierarchy
      Figure 2: Folder hierarchy
  3. Compress the main folder in .zip format.

    The .zip file size limit is 10 Mo.

    Your .zip file can contain several types of files but only YAML, PNG, and JPEG files will be processed.

    For example, you can create a Zip archive with the contents of the Saagie technology repository with the following command line:

    zip -r technologies/