About KXS repositories¶
This page describes how KX Sensors organizes code, configuration, and database tables into repositories.
KX Sensors organizes all code, configuration objects, and database tables into repositories such as kxs-core, kxs-utilities, kxs-test, and customer packages. KX Sensors is a collection of repositories that you create and maintain in a version control system such as Git. Repositories can be downloaded as a zip file and, once unzipped, run out of the box.
The api, config, lib, meta, schema, and src directories are standard for all repositories.
| Directory | Description |
|---|---|
api |
Contains a YAML file for each API definition. |
config |
Contains a YAML file for each configuration object. The file defines the default values for each column in the configuration object. |
lib |
Contains kernel modules and shared library images (the C programming code library) needed to boot the system and run the commands in the root filesystem. |
meta |
Contains a YAML file for each configuration object. This file defines each column in the configuration object, for example its datatype (short, string, symbol, etc.), whether it's required or optional, and its overlay rule (fill, first, discard, etc.). Also contains a meta file defining the structure of all tables, and a meta file describing the structure of all APIs. |
schema |
Contains a YAML file for each KXS table. The file defines the default values for each column in the table. |
src |
Contains q code files and any SAPI functions called by an API. |