Catalog guides

System

On this page

What a System records#

A System is a composition that groups Services, APIs, Databases, and other Systems. Its name may match another System's name, so tell them apart by ID.

Field	Content
`name`	Name. Required
`handle`	Web address name. Required; unique among the Systems of the same Organization (see address names)
`summary`·`description`	One-line summary and description

The same Service, API, Database, or System can be included in several Systems. Databases used by a Service are not added to a System's composition automatically, so choose them directly. Cycles, where a System ends up including itself, are not allowed.

Web UI#

In Systems → 새 System (New System), enter a name and select System 등록 (Register System). In 직접 구성 편집 (Edit direct composition) on the detail, choose the Services, APIs, Databases, and Systems to include and select 직접 구성 저장 (Save direct composition).

stly#

{"name": "Commerce", "handle": "commerce", "summary": "Group of order and payment capabilities"}

stly systems create --input system.json

The direct composition replaces the full set of Service, API, Database, and System IDs at once. service_ids, api_ids, and system_ids are required. If you omit database_ids, the existing Database composition is kept; send an empty array to remove all of them. The four arrays can hold up to 500 IDs in total.

{"service_ids": ["1I6Nc76wEPd"], "api_ids": ["4pkKFh2ojXs"], "system_ids": [], "database_ids": ["7OzP6PauDBf"]}

stly systems component-links get <system-id>
stly systems component-links update <system-id> --input links.json --if-match '"ETag from the composition lookup"'

The composition ETag is different from the ETag of the System's name and description. Use the etag from component-links get.

Explore the composition#

Command	Result
`stly systems components <system-id> --scope recursive`	Direct and indirect composition. `inclusion` is `direct`, `indirect`, or `both`
`stly systems parents <system-id>`	Parent Systems that contain this System
`stly systems composition <system-id> --target-kind service --target-id <service-id>`	Inclusion paths to the target. `--target-kind` is `system`, `service`, `api`, or `database`
`stly services systems <service-id>` · `stly apis systems <api-id>`	Systems that contain this Service or API

For the next page of systems composition, pass the composition_revision from the first response with --composition-revision. If the composition changes during the lookup and you get HTTP 409, start over from the first page.

Delete#

Deleting a System also removes the connections it contained and the connections from other Systems that contained it. The Services, APIs, Databases, and Systems it contained are not deleted. When a Database can be deleted, it is also removed from System compositions.