Skip to content

Setup OneImporter

The OneImporter provides ready-to-use data import integrations for specific product solutions, cloud platforms and technologies.

Execution variants and prerequisites

An OneImporter instance can be executed as a systemd service or as a docker container:

Please note that all operating specific importer (host, process, file and folder structure) running in a container, if you use docker or docker compose variant!

Supported operating systems

The following operating systems are supported:

  • Ubuntu
  • Red Hat
  • SUSE (SLES, openSUSE, openSUSE Leap, openSUSE Tumbleweed)
  • Oracle Linux
  • Debian
  • Fedora
  • CentOS and CentOS Stream
  • Rocky Linux
  • Clear Linux OS
  • Alpine Linux
  • Linux Mint
  • Windows 10 and 11
  • Windows Server

Installation, startup & shutdown

All necessary steps to install, run, terminate the OneImporter are supported by a wizard in the web interface.

It is only necessary to select your desired configurations in the first step and the wizard then displays all necessary calls including the call parameters. The calls can be executed in a command line of the operating system. All that is required is authorization to execute Docker Containers or Node.js applications.

Figure: Command line wizard for install, startup, validate and shutdown OneImporter instances

Following configuration parameter can be used to startup the OneImporter:

Parameter Description
Operating System Operating system on which the OneImporter is to run
Variant Execution variant for the OneImporter (Docker oder operating system process).
CA validation The Certificate Authority check can be disabled if self-generated SSL certificates are used in the server.
Debug mode Extends the output of debug information.
Supported importer Specification of the executable importer types to restrict their execution for IT security reasons.

Table: OneImporter configuration parameter

Optional parameters

With the following environment variables you can influence the execution behavior and the server activation of the OneImporter.

Environment variable Description
ONE_IMPORTER_USER User with which the OneImporter is executed as a service. By default, OneImporter runs as root user.
Attention: Please note that changing the user and group assignment will limit the execution permissions and therefore possibly the scope of the inventory by OneImporter.
ONE_IMPORTER_GROUP Group with which the OneImporter is executed as a service. By default, OneImporter runs as root group.
https_proxy / http_proxy / no_proxy
The communication from OneImporter to the platform should be done via the specified proxy (see configuration details). Please note: When changing the environment variables it is necessary to restart the OneImporter with the or startup.bat command.
ONE_IMPORTER_API_TOKEN Automated authorization and activation of the OneImporter instance. Should be used if new host or container instances are always continuously created and discarded as part of DevOps pipelines.
Table: Optional parameters for OneImporter execution

Security features

The following functions ensure that the OneImporter runs in compliance with IT security requirements:

  • The OneImporter can optionally be instructed at startup to only establish connections with the platform that have a known Certificate Authority (CA) (no self-generated SSL certificates).
  • Communication always starts from the OneImporter to the platform.
  • The OneImporter is automatically restarted when the host is restarted or the process is terminated.
  • The OneImporter continuously sends HeartBeat calls to the platform (15 seconds) to implement changes to the importer configurations.
  • The OneImporter makes the last 1,000 lines of the OneImporter log file available to the platform so that users can debug failed executions of Importer configurations.
  • The execution of Importer modules in OneImporter (e.g. file importer) can be configured when OneImporter is started and thus prevented at runtime.
  • A OneImporter only receives Importer configurations from the Server for execution if the OneImporter has been authorized on the server side.
  • The OneImporter can be deactivated or activated on the server side at any time. Deactivation stops the execution of all assigned Importer configurations.
  • The Importer configurations can be deactivated and activated on the server side. Deactivation stops the execution of these specific Importer Configurations.