Creating and Managing Technologies

You can create your own technologies and add them to the Saagie technology catalog using the The "Catalog" module icon is a bento button. Catalog module.

To add new technologies to the catalog, you have to:

You can manage the added technologies afterwards by updating the technologies in your repository.
Technology Creation Process
Figure 1: Technology Creation Process

Creating Metadata Files for Your Technologies

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:

    External technologies require a more advanced setup with additional information on how to establish a connection with the external service and how the life cycle of the external job instance must be executed.
    You can use the attribute reference tables and the metadata example files to create metadata files.

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

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

    • The job, app, and external technology folders have subdirectories for each technology.

    • Each technology subdirectory has its own metadata.yaml file.

      External technologies must include the referenced JavaScript files.
      Folder Hierarchy
      Figure 2: Folder hierarchy

  3. Compress the main folder in .zip format.

    Your .zip file can contain several types of files but only files named metadata.yaml or metadata.yml will be processed.

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

    zip technologies.zip -r technologies/

Creating a Repository

You can create repositories by fetching them from a URL or by uploading a dedicated zip archive directly on Saagie.

For more information on how to create the .zip file, see Creating and Managing Technologies

  1. Click the The "Catalog" module icon is a bento button. Catalog module.
    By default, the The "Repositories" page icon is two plugs being plugged. Repositories page opens.

  2. Click Add Repository to add a new repository to the list.

  3. You can choose between:

    • Upload a zip archive on Saagie

    • Fetch your repository from a URL

    Create a zip archive of your repository and upload it on Saagie.

    1. Click Upload zip archive.

    2. Enter a name for your repository.

      It must be unique and up to 255 characters.

    3. Click Choose file and select the required zip archive in your file explorer.

    4. Click Add repository.
      You are returned to the Repositories page updated with the newly added repository.

      The initial synchronization of your repository is done automatically based on the information that you provided in the .zip file.

    Store your repository and synchronize it with updates.

    1. Click Fetch from URL.

    2. Enter a name for your repository.

      It must be unique and up to 255 characters.

    3. Enter the URL of the repository where you stored the .zip file.

      You can use any HTTP server without authentication.
      For example, Saagie’s technology repository is exposed through a GitHub .zip file accessible via the following URL: https://github.com/saagie/technologies/releases/latest/download/technologies.zip.

    4. Click Add repository.
      You are returned to the Repositories page updated with the newly added repository.