BaSyx Go#

BaSyx Go provides Go-based BaSyx backend components and shared libraries for running registries, repositories, and related infrastructure services.

Unless stated otherwise, this user documentation describes the latest stable BaSyx Go release.

Repositories store AAS model content that clients read and change. Registries store descriptors that advertise where content can be reached, while Discovery stores mappings from asset identifiers to AAS identifiers. Other BaSyx Go services provide combined runtimes, package storage, configuration, Digital Product Passport functionality, and related capabilities. The following table provides an overview of the BaSyx Go services and their roles, dependencies, and integrations.

Component Overview#

User goal

Component

Manages or stores

Required dependencies

Optional integration

Documentation

Store and modify AAS content

AAS Repository

AAS content and its references to Submodels

PostgreSQL initialized by the BaSyx Configuration Service

When AAS Registry integration is enabled, Repository changes also maintain AAS Descriptors in the Repository’s PostgreSQL database. A separately deployed AAS Registry can expose them only when it uses the same database

AAS Repository

Store and modify Submodel content

Submodel Repository

Submodels and Submodel Elements

PostgreSQL initialized by the BaSyx Configuration Service

When Submodel Registry integration is enabled, Repository changes also maintain Submodel Descriptors in the Repository’s PostgreSQL database. A separately deployed Submodel Registry can expose them only when it uses the same database

Submodel Repository

Store and expose Concept Descriptions independently

Concept Description Repository

Concept Description content

PostgreSQL initialized by the BaSyx Configuration Service

The AAS Environment provides the same API area when a combined runtime is preferred

Concept Description Repository

Advertise where AAS content is available

AAS Registry

AAS Descriptors and AAS-scoped Submodel Descriptors, not Repository content

PostgreSQL initialized by the BaSyx Configuration Service

Can expose descriptors automatically maintained by an AAS Repository when both use the same PostgreSQL database. When Discovery integration is enabled, descriptor changes also maintain asset-to-AAS mappings in that database

AAS Registry

Advertise independently managed Submodels

Submodel Registry

Standalone Submodel Descriptors, not Submodel content

PostgreSQL initialized by the BaSyx Configuration Service

Can expose descriptors automatically maintained by a Submodel Repository when both use the same PostgreSQL database

Submodel Registry

Find AAS identifiers from global or specific asset identifiers

Basic Discovery

Asset-identifier-to-AAS-identifier mappings, not descriptors or Repository content

PostgreSQL initialized by the BaSyx Configuration Service

Can expose mappings maintained by an AAS Registry or Digital Twin Registry when they use the same PostgreSQL database

Basic Discovery

Use the Catena-X-oriented combined AAS Registry and Discovery API

Digital Twin Registry (DTR)

AAS Descriptors and asset-identifier mappings, not AAS content

PostgreSQL initialized by the BaSyx Configuration Service

Combines AAS Registry and Discovery functionality in one service. Separately deployed Repositories can maintain descriptors in the same database when their Registry integration is enabled

Digital Twin Registry

Use AAS, Submodel, Concept Description, Registry, Discovery, upload, and serialization APIs in one runtime

AAS Environment

AAS, Submodel, and Concept Description content; AAS and Submodel descriptors; asset-identifier mappings

PostgreSQL initialized by the BaSyx Configuration Service

Repository-to-Registry synchronization is controlled by explicit flags and maintains descriptors in the same PostgreSQL database; Discovery functionality is included

AAS Environment

Store, list, download, replace, and delete AASX packages

AASX File Server

Complete AASX package files and package metadata

PostgreSQL initialized by the BaSyx Configuration Service

Package AAS identifiers can be used for list filtering; package contents are not imported into Repositories

AASX File Server

Create and manage Digital Product Passports through the IDTA-aligned DPP API

Digital Product Passport API

DPP metadata and content represented as an AAS and Submodels

PostgreSQL initialized by the BaSyx Configuration Service

Can record historical passport states and, when the respective integrations are enabled, maintain AAS/Submodel descriptors and product Discovery mappings in the shared database

Digital Product Passport API

Discover company-provided service endpoints

Company Lookup

Company Descriptors containing company identity and service endpoints

PostgreSQL initialized by the BaSyx Configuration Service

Describes external services; it does not automatically connect or synchronize them

Company Lookup

Initialize or migrate the shared BaSyx database

Configuration Service

Database schema, schema version, and schema state; it is a one-shot job

PostgreSQL

Must complete successfully before database-backed BaSyx runtimes start

Configuration Service

For separate Repository and Registry processes, see Repository-to-Registry Integration for the required setup and configuration. Synchronization uses their shared database. Simply starting both HTTP services does not connect them.

Shared Guidance#

For Kubernetes installations, see Deploy BaSyx Go with Helm: a learning path from Kubernetes basics and a step-by-step installation in an existing cluster to configuration, security, and operations.

See Common for shared deployment, configuration, security, query, observability, pagination, history and evidence, ReBAC, eventing, and API behavior.