Skip to content
Yellow Pages
Menu

How it works

How it works

The catalog fills from two directions: people edit it in the console, and systems write to it through the API. Here is the whole loop.

  1. Step 1

    Sign in

    Sign in through Zitadel, the shared Fleetworks identity provider. Your auth role decides whether you may write at all.

  2. Step 2

    Add teams and accounts

    Create the Teams that own things and the AWS and Azure accounts they run in, and attach Labels to classify them.

  3. Step 3

    Catalog services and agents

    Add each Service with its owning Team, accounts and dependencies. Coastguard registers Agents itself through POST /api/agent/register.

  4. Step 4

    Set access rules

    Each row gets an owner, an owner group and a Mode. Leave it public-read, or narrow it to the group or to yourself.

  5. Step 5

    Connect machines

    Issue an API key with read or write scope for scripts and CI, and register webhooks to hear about created, updated and deleted rows.

  6. Step 6

    Read it anywhere

    Search across resources, walk the operational graph, and review the catalog auditor’s findings. Anonymous callers see only public rows.

Look up who owns it in seconds

Sign in with your Fleetworks account, or start with the public rows through the API.