Setup OneImporter & OneGate

The Versio.io OneImporter & OneGate provides ready-to-use data import integrations for specific product solutions, hyperscalers and technologies.

Execution variants and prerequisites

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

• systemd service (see freedesktop.org)
• Docker and Docker-Compose (see install script)

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:

Table: Overview of supported operating systems

Installation, startup & shutdown

All necessary steps to install, run, terminate the OneImporter & OneGate & OneGate are supported by a wizard in the Versio.io 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 & OneGate & OneGate instances

Following configuration parameter can be used to startup the OneImporter & OneGate & OneGate:

Table: OneImporter & OneGate configuration parameter

Optional parameters

With the following optional parameters you can influence the execution behavior and the server activation of the OneImporter & OneGate.

Environment variables

Table: Optional environment variable parameters for OneImporter & OneGate execution

Infrastructure-as-Code configuration (IaC)

For the inventory of assets and configurations, customer-specific OneImporter & OneGate or OneGate configurations are necessary. Versio.io recommends creating the configurations via the user interface.

Alternatively, there are two ways to influence or extend the importer configuration on the OneImporter & OneGate or OneGate side:

1. Only credential extension: The authorisation data is stored locally on the OneImporter & OneGate or OneGate and extends an existing importer configuration on the Versio.io server with the authorisation information (credentials). The Versio.io server has full access to the configuration, but not the authorisation. Changes to the configuration can be made on the server side and do not require a restart of the OneImporter & OneGate or OneGate.
2. Complete configuration: The complete importer configuration is on the OneImporter & OneGate or OneGate hosts. The Versio.io server instance does not have access to this configuration. The importer configuration must always be changed locally and the OneImporter & OneGate or OneGate must be restarted!

The configuration file can be found in the following directory:

# Folder structure of the configuration file
{install directory}/conf/{variant}/{environment ID}/importer.conf.json

# Example folder and file 
/opt/versio.io/one-importer/conf/service/f4hqa7b37l/importer.conf.json

Please use the Versio.io user interface to create the Importer Configuration, which is offered as JSON format with the button "Infrastructure as Code configuration".

Figure: Infrastructure as code wizzard

The following configuration shows an example of how to set up the credentials and importer configurations:

{
  "credentialsForServerConfigurations": { // set or override credentials for server configurations. Usefull to store crendentials only on local machine
    "66698d8e-8dca-4ad3-a177-b06703747b50": { // Configuration ID (Available from Versio.io GUI)
      "username": "localUsername", // set a username
      "password": "localPassword" // set a password
    },
    "c8133ba6-d8b2-4bbb-a6a0-2bde848ee760": { // another configuration ID (Available from Versio.io GUI)
      "username": "localUsername", // set a username
      "password": "localPassword" // set a password
    }
    ...
  },
  "localImporterConfigurations": [ // Complete OneImporter & OneGate module configurations for execution
    // Example for SSL-Importer configuration:
    { // Available from Versio.io GUI
      "active": true,
      "scheduleTime": "*/5 * * * *", // every 5 minutes
      "name": "Versio.io domain certificates",
      "entity": "ssl-certificate",
      "domains": [
        "www.versio.io",
        "live.versio.io"
      ],
      "instanceModification": [],
      "moduleType": "importer-ssl"
    },
    {...} // Available from Versio.io GUI
  ]
}

Configuration: Example configuration to set credentials and complete importer configuration

The necessary ID for the extension of the credentials can be found in the Importer configuration display in the user interface. To set up a complete Importer configuration, please also use the Importer configuration display in the user interface as a kind of wizard. You can set up the configuration and then copy the JSON section from the user interface without having to save it.

Update

OneImporter and OneGate are continuously expanded, optimized and bug-fixed. It is therefore necessary to update them continuously. Versio.io offers the following five options to support different customer operating models:

• Manual update
  1. update individual OneImporter or OneGate
     1. user interface via “Update” button (see 1)
     2. determine update command from the installation wizard via “Modify installation” (see 2) and execute on the host
  2. update all OneImporters or OneGate via “Update all OneImporters” (see 3)
• Automated update
  1. update individual OneImporters or OneGate via “Nightly update” (see 4)
  2. determine update command from the installation wizard via “Modify installation” (see 5) and execute via software distribution on all corresponding hosts

Figure: Variants for updating the software of OneImporter and OneGate

Security features

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

• The OneImporter & OneGate can optionally be instructed at startup to only establish connections with the Versio.io platform that have a known Certificate Authority (CA) (no self-generated SSL certificates).
• Communication always starts from the OneImporter & OneGate to the Versio.io platform.
• The OneImporter & OneGate is automatically restarted when the host is restarted or the process is terminated.
• The OneImporter & OneGate continuously sends HeartBeat calls to the Versio.io platform (15 seconds) to implement changes to the importer configurations.
• The OneImporter & OneGate makes the last 1,000 lines of the OneImporter & OneGate log file available to the Versio.io platform so that users can debug failed executions of Importer configurations.
• The execution of Importer modules in OneImporter & OneGate (e.g. file importer) can be configured when OneImporter & OneGate is started and thus prevented at runtime.
• A OneImporter & OneGate only receives Importer configurations from the Server for execution if the OneImporter & OneGate has been authorized on the server side.
• The OneImporter & OneGate 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.
• Use local importer configuration to prevent the use of credentials in the Versio.io server instance.