orangeqs.juice.orchestration.data#
Utilities for managing data folders.
Module Contents#
Functions#
Create all data folders for OrangeQS Juice. |
|
Render the runtime data systemd service file. |
|
Create a unique setup ID file if it does not exist. |
API#
- orangeqs.juice.orchestration.data.create_data_folders(data_folder_settings: orangeqs.juice.orchestration.settings.DataFolderSettings) None#
Create all data folders for OrangeQS Juice.
An exception is the runtime data folder, which is created by a systemd service.
Parameters#
data_folder_settings (DataFolderSettings): The settings block for the data folders.
- orangeqs.juice.orchestration.data.render_runtime_data_service(data_folder_settings: orangeqs.juice.orchestration.settings.DataFolderSettings) str#
Render the runtime data systemd service file.
This is a systemd service that ensures the shared runtime data folder is created on boot.
Parameters#
data_folder_settings (DataFolderSettings): The settings block for the data folders.
Returns#
(str): The name of the rendered service file without extension.
- orangeqs.juice.orchestration.data.ensure_setup_id_exists(settings: orangeqs.juice.orchestration.settings.DataFolderSettings) str#
Create a unique setup ID file if it does not exist.
This can be used to track the specific OrangeQS Juice installation. Writes it to profile.d so that it is available in the environment for all processes. Also exports it to the current shell session, so that it is available immediately for the current process and any child processes.