Skip to Content
ConceptsArtifacts

Artifacts

Kubling loads its runtime definition from an application configuration and a set of Modules. Together, these artifacts define how Kubling starts, which Virtual Databases it exposes and which extensions each VDB uses.

Initialization process

  1. The APP_CONFIG environment variable identifies the application configuration.
  2. The application configuration selects the descriptor Module.
  3. The descriptor Module declares the Virtual Databases and references the other Modules they require.
  4. Kubling resolves those references and loads the artifacts before making the configured VDBs available.

The application configuration is the only artifact in this chain that is not a Module. Build Modules with the Kubling CLI instead of assembling their internal format directly, and give each Module an immutable version and release lifecycle.

Kubling artifact loading sequence from application configuration to function bundles

Runtime artifacts

Application configuration

A YAML document containing top-level runtime options and the origin of the descriptor Module.

vdb: descriptorBundle: "https://artifacts.example.com/my-project/descriptor.zip"

The descriptor Module may also be referenced through a supported file: URI when the artifact is mounted with the application configuration.

See the application configuration schema.

Descriptor Module

Declares the Virtual Databases and locates their configuration, endpoint descriptors and referenced Modules. Its Module manifest inventories those contents.

See the descriptor Module schema.

Each listed VDB has its own Virtual Database configuration.

JavaScript data source Module

Contains the definition, scripts and resources required by a JavaScript data source.

See the JavaScript Module schema.

SQL Functions Module

Contains function metadata and scripts added to the Kubling SQL function catalog.

See how to create SQL functions.

Template Functions Module

Contains function metadata and scripts added to the Kubling template function catalog.

See how to create template functions.

Semantic Module v26.5+

Contains the manifest and semantic documents used to add a domain model to a VDB. Semantic federation is a Preview feature.

See how to build and configure semantic Modules.

Artifact dependencies

Artifact references form a dependency graph. The application configuration selects the descriptor Module, and the descriptor Module identifies the VDB configuration and additional Modules that Kubling must resolve.

Dependencies among Kubling configuration and module artifacts

Last updated on