Docs/Guides/Quick start

Quick start

Work through a basic workflow and create your first service catalog

In this guide, we're going to walk through a basic example of how to get started with Syslab and add your first service to the catalog.


Services is a core concept of Syslab and it can represent any technology asset in your organisation such as a website, a microservice, an ETL pipeline or event a data product. Services can be depended on by other services and owner of services can also post updates to notify any subscribers of any changes.

Step 1: Creating a file

Services in Syslab are configured using .sl files. These are YAML formatted files that contains the information about your service with each .sl file representing one service. Start by creating an empty .sl file:

$ touch

Next, open the newly created file in your favourite text editor. There are many properties that we can define for our service, but there are 4 properties that is always required:

syslabThis fields define the version of the configuration schema that the file follows
handlerThis is a unique URL friendly name of your service, think of it like a social media handler
nameThis is the name of your service, it can have spaces, capitals, etc
ownerThe handler of the team that owns this service. If the team does not exist, an empty team will be automatically created for you.

In your text editor, add these properties to create our todo service:

syslab: 1
handler: todo-service
name: Todo Service
owner: todo-team

The file above specified syslab schema version 1, a service named "Todo Service" with the handler "@todo-service" and owned by the "@todo-team". Next up, let's get this service up and running in the Syslab web portal.

Step 2: Create a service using configuration files

Navigate to the Registry on the Syslab web portal. This is where you can see all of the services in your organisation and create our new Todo Service.

Click on the "Create service" button on the top right of the page, which will take you to the service creation flow. From here, you are able to create a service by either manually uploading a .sl file or connect to your code repository (such as GitHub) and let us automatically handle creating and updating your services from .sl files in your repository. In this case, we want to select "Manual" and select the file that we created in Step 1.

That's it! Todo Service now exists in your organisation's registry. You can now invite other team members to collaborate on this service, add documentation and post status updates. Check out the full capability of Syslab with our handy guides!

Related articles

Facts and Links
Configuration file format