Torii ⛩️

Torii is a simple, powerful and extensible open-source Internal Developer Portal where developers can find all the tools and services they need to build, deploy, and manage their applications.

Torii focus on three principles:

• Easily configurable: Platform Engineers can easily define a catalog of tools and services available to developers. They can also define a scorecard and a workflow for each tool and service.
• Easily usable: Developers can easily find and use the tools and services they need to build, deploy, and manage their applications via a simple web interface.
• Easily extensible: Platform Engineers can easily extend Torii by adding new tools and services to the catalog.

That's it!

⚠️ Torii is in active development and not ready for production yet.

Concepts

Catalogs Service

The Catalogs Service is the core of Torii. It allows Platform Engineers to define a catalog of tools and services that developers can use to build, deploy, and manage their applications.

The Catalogs Service is a simple YAML file that contains the list of tools and services available to developers. It also contains the list of scripts to run to validate and submit the form.

Scorecard Service

The Scorecard Service is a simple service that allows Platform Engineers to define a scorecard for each tool and service available in the Catalogs Service. The scorecard is a simple YAML file that contains the list of criteria and the score for each criterion.

Workflow Service

The Workflow Service is a simple service that allows Platform Engineers to define a workflow for each tool and service available in the Catalogs Service. The workflow is a simple YAML file that contains the list of steps and the order of each step.

Features

Getting Started

Prerequisites

• MacOSX / Linux / Windows
• Postgres

Installation

cargo build

# run the server
cargo run

Using containers

Build the container images using make for convenience

#From the root of the repository
make docker_build_backend

make docker_build_frontend

Usage

To start Torii, run the following command:

torii --config ./config.yaml

Using docker compose

docker compose up

Configuration

Configuration file

catalog:
  - name: string
    description: string (optional)
    icon: url (optional)
    fields:
      - title: string
        description: string (optional)
        placeholder: string (optional)
        type: string|integer|float|boolean|list
        default: string (optional)
        required: boolean
        autocomplete-fetcher: ./your-script.py (optional)
    validation:
      - validation-script-1.sh # executed first
      - validation-script-2.sh # AND then this one
    post-validation:
      - script: post-validation-script-1.sh # executed first
        model: string (optional) # model name
      - script: post-validation-script-2.sh # AND then this one
        model: string (optional) # model name
      - script: post-validation-script-3.sh # AND finally this one
        model: string (optional) # model name
models:
  - name: string
    description: string (optional)
    fields:
      - title: string
        type: string|integer|float|boolean|list
        default: string (optional)
        required: boolean

Autocomplete Fetcher

An autocomplete fetcher is a script that must print a JSON on standard output. The JSON must contain a results key that contains a list of values.

{
  "results": [
    "val 1",
    "val 2",
    "val 3"
  ]
}

Example of autocomplete fetcher in python:

import json


def get_data_from_fake_api():
    return [
        'val 1',
        'val 2',
        'val 3',
    ]


if __name__ == '__main__':
    # do your stuff here
    results = get_data_from_fake_api()

    data = {'results': results}

    # print json on standard output
    print(json.dumps(data))

Validation Script

An validation script can be any kind of script. It can be a bash script, a python script, a terraform script, etc. The script must exit with a non-zero exit code if the validation fails.

#!/bin/bash

set -e # exit on error
# print error on standard error output

# do your stuff here
exit 0

Post Validation Script

An post validation script can be any kind of script. It can be a bash script, a python script, a terraform script, etc.

• The script must exit with a non-zero exit code if the validation fails.
• The script must be idempotent. It can be executed multiple times without side effects.
• The output of the script must be a JSON that contains the defined model keys with their values. (Torii will update the model with the values returned by the script)

{
  "status": "success",
  "url": "https://my-service.com",
  "username": "my-username",
  "password": "my-password"
}

#!/bin/bash

set -e # exit on error
# print error on standard error output

# do your stuff here
exit 0

Contributing

Torii is still in early development. If you want to contribute, please open an issue or a pull request. We will improve the contribution guidelines as soon as possible.

Motivation

Today you have the choice between two options to build your Internal Developer Portal:

1. Painful: Build it yourself with a framework like Backstage
2. Easy: Use a convenient but proprietary SaaS solution like Port, Cortex, OpsLevel, etc.

We want to bring a third option that takes the best of both worlds: an open-source solution that is easy to use and easy to extend.

FAQ

What's the difference between Torii and Qovery?

• Qovery is an Internal Developer Platform focusing on the Software Development Lifecycle (build, deploy, run).
• Torii is an Internal Developer Portal focusing on unifying the experience of all engineering tools.

Here is a features table to help you understand the difference:

Why Torii?

Torii is a Japanese gate most commonly found at the entrance of or within a Shinto shrine, where it symbolically marks the transition from the mundane to the sacred.