Catalog guides

Service

On this page

What a Service records#

A Service is a unit of software that is deployed and operated. Names are unique within an Organization.

Field	Content
`name`	Name. Required
`handle`	Web address name. Required; unique among the Services of the same Organization (see address names)
`summary`·`description`	One-line summary and description
`status`	Manual lifecycle. `planned`, `active`, or `retired`

status is a lifecycle recorded by people, not real-time availability.

Web UI#

In Services → 새 Service (New Service), enter the name, summary, description, and Status, then select Service 등록 (Register Service). The detail shows the APIs it implements, 연결 Repository (Connected Repositories), the Databases and structures (Key Patterns, Tables, Collections, Cassandra Tables) it uses, Kafka usage notes, and the Systems it belongs to.

stly#

{"name": "orders-service", "handle": "orders-service", "summary": "Backend Service that processes orders", "status": "active"}

stly services create --input service.json
stly services list --q orders --fields id,name,status

services list --q searches names and is case-sensitive.

Provided APIs#

Each API names one providing Service. The choice is made on the API side; see API. 제공 API (Provided APIs) on the Service detail lists the APIs that name this Service, and you can unlink them one by one. An unlinked API has no providing Service.

stly services apis <service-id> --fields id,name

Repository connections#

Connect the Repositories that hold the Service's code. In the Web UI, edit them in 연결 Repository on the Service detail.

stly services repository-links get <service-id>
stly services repository-links update <service-id> --input repos.json --if-match '"ETag from the connection lookup"'
stly services repositories <service-id> --fields id,name,git_url

repos.json contains the full set of Repository IDs to connect. [] removes all connections.

{"repository_ids": ["3B4cBA6CToA"]}

Other connection lookups#

Command	Result
`stly services databases <service-id>`	Directly connected Databases
`stly services key-patterns <service-id>`	Directly connected Redis Key Patterns
`stly services tables <service-id>`	Directly connected RDB Tables
`stly services collections <service-id>`	Directly connected MongoDB Collections
`stly services cassandra-tables <service-id>`	Directly connected Cassandra Tables
`stly services kafka-usages <service-id>`	Kafka usage notes that name this Service
`stly services systems <service-id>`	Systems that contain this Service

Edit Database and structure connections in Database, and Kafka usage notes in Messaging.

Delete#

A Service cannot be deleted while any of these connections remain (HTTP 409 SERVICE_IN_USE). Remove the connections first.

An API naming it as the providing Service
Repository, Database, or structure connections
Service named in a Kafka usage note

A Service included in a System composition can be deleted, and it is removed from the composition as well.