Yellow Pages (Service Catalog)
Yellow Pages is the service catalog for the Shift Platform. It provides a central registry for discovering, registering, and mapping dependencies between services across your organization.
What It Does
- Service Registration — Register services with metadata, tags, ownership, and system grouping.
- Dependency Mapping — Define and traverse dependency graphs between services (upstream and downstream).
- Full-Text Search — Search across all registered services by name, description, or tags.
- Systems & Owners — Group services into logical systems and assign ownership for accountability.
Key Concepts
| Concept | Description |
|---|---|
| Service | A registered unit in the catalog with metadata, tags, and dependencies. |
| System | A logical grouping of related services. |
| Owner | A person or team responsible for one or more services. |
| Dependency | A directed relationship between two services (upstream/downstream). |
Configuration
| Setting | Value |
|---|---|
| Storage Directory | .yellowpages/ |
| API Dev Port | 4001 |
| Web Dev Port | 4101 |
| Gateway Prefix | /api/v1/catalog/* |
Getting Started
Register your first service:
shift-cli yp services create
Or via the API:
curl -X POST http://localhost:3000/api/v1/catalog/services \
-H "Content-Type: application/json" \
-d '{"name": "my-service", "description": "My first service"}'
Then explore the catalog:
shift-cli yp services list
shift-cli yp search "my-service"
shift-cli yp deps <service-id> --direction down