NuoDB sidecar container image

The NuoDB sidecar container image bundles additional tools which help running NuoDB database in Kubernetes cluster.

Requirements

Software	Release Requirements
Kubernetes	The latest and previous minor released versions of Kubernetes.
NuoDB	Version 6.0.2 and onwards.

Tools

Command	Description
config_watcher	Watches for changes in ConfigMap or Secret resources and creates files out of resource's data in a target directory.
nuodb-operations	Starts a server with NuoDB backup hooks and optionally custom operation handlers.

Usage

Follow the instructions on the NuoDB Helm charts installation page.

NuoDB sidecar is used in Admin and Database charts when enabling NuoDB collector (see nuocollector.watcher Helm variable). NuoDB sidecar is used in Database chart when enabling database backup hooks (see database.backupHooks.image).

Contribute

Test requirements

Software	Release Requirements
Python	Version 3.12 and onwards.
Docker	Version 27.4.0 and onwards.

Development environment

To develop and test the tools locally, follow below steps.

• Create Python virtual environment with an IDE or by running:

python3 -m venv .venv
source .venv/bin/activate

• Install Python dependencies for the tool that is under development. E.g.

python3 -m pip install -r config_watcher/requirements.txt
python3 -m pip install -r config_watcher/test-requirements.txt

• Make the necessary changes

• Run static analysis

make fmt lint

• Run the tests

make test