@netin-ds/netin-ds-db

Information

netin-ds-db is a preconfigured instance, for Netin Systems, of MongoDB official image. This image is used in the different entity types of a NetinDS System: NetinDS Agents, NetinDS Server and NetinDS Standalone.

Use

Default settings

The service is offered at the port 28900.

Environment variables

General container configuration

• CONFIG_AGENT_CONFIG_FILE_PATH default(/data/netin/config/config.json): Absolute address inside the container where the configuration JSON file is located.

  {
    "entityUUID": "Agent",                // Equal to CONFIG_AGENT_ENTITY_UUID
    "entity": "Agent",                    // Equal to CONFIG_AGENT_ENTITY
    "serviceMode": "agent",               // Equal to CONFIG_SERVICE_MODE
    "agentMode": "agent",                 // Equal to CONFIG_AGENT_MODE @deprecated
    "serverAddr": "172.16.25.26",         // Equal to CONFIG_SERVER_ADDR
    "serverPort": "28800",                // Equal to CONFIG_SERVER_PORT
    "accessToken": " ",                   // Equal to CONFIG_ACCESS_TOKEN
    "brokerURL": "tcp://127.0.0.1:61616", // Equal to CONFIG_BROKER_URL
    "seedsFolder": "/opt/seeds",          // Equal to CONFIG_SEEDS_FOLDER
  }
  

  Copy

  Configuration can be used together using environment and file variables. In cases in which the same variable is configured in both ways, the configuration by file will prevail.

• CONFIG_AGENT_ENTITY_UUID default('22ab0031-525c-5245-92dd-5edab547b734'): unique identifier of the agent. For legacy compatibility this identifier must calculated according to the UUID V5 standard (RFC4122), where the seed value used is CONFIG_AGENT_ENTITY and the namespace the following UUID '66b9e185-a38d-4c33-ab89-5921305db9a7'. Please use a tool like: https://www.uuidtools.com/v5⁠ in order to calculate the correct UUID if your are using some legacy components. Only relevant when CONFIG_SERVICE_MODE is configured as 'agent'.

• CONFIG_AGENT_ENTITY default('Agent'): Legacy identification of NetinDS entities.Only relevant when CONFIG_SERVICE_MODE is configured as 'agent'.

• CONFIG_SERVICE_MODE default(server): operation mode of the NetinDS entity. Allowed values are: 'server', 'agent' or 'standalone'.

• CONFIG_AGENT_MODE: alias of CONFIG_SERVICE_MODE.

• CONFIG_SERVER_ADDR default('127.0.0.1'): IP address or name of the host where the NetinDS Server associated with this agent is located. Only relevant when CONFIG_SERVICE_MODE is configured as 'agent'.

• CONFIG_SERVER_PORT default(28800): port where the agent management service is offered (NetinDS-Datasource). Only relevant when CONFIG_AGENT_MODE is configured as 'agent'.

• CONFIG_ACCESS_TOKEN default(' '): Server access token. Only relevant when CONFIG_AGENT_MODE is configured as 'agent'.

• CONFIG_BROKER_URL default('tcp://127.0.0.1:61616'): Connection url to NetinDS Server data broker.Only relevant when CONFIG_AGENT_MODE is configured as 'agent'.

• CONFIG_SEEDS_FOLDER default(/data/netin/repository): path where the data to be pre-loaded into the system at the time of configuration is located. Within the indicated path, the system will search for the following folders: templates, locations, addresses, devices and alarms. The files with extension .json that are within these folders, will be uploaded within the corresponding collections.

Collaboration

As in the rest of the repositories of Netin Systems, all collaboration is always welcome.

If you believe that an error exists, create a bug⁠ providing all possible information.

If you want to make a new contribution, create a new branch, respecting at all times the flow of versions established by GitFlow⁠, make your modifications to it and request approval of the same by Pull Request⁠, correctly filling in the template of the same.

License

Copyright 2021 Network Intelligence S.L. All rights reserved.

Note: All information contained herein is, and remains the property of Network Intelligence S.L. and its suppliers, if any. The intellectual and technical concepts contained herein are property of Network Intelligence S.L. and its suppliers and may be covered by European and Foreign patents, patents in process, and are protected by trade secret or copyright. Dissemination of this information or the reproduction of this material is strictly forbidden unless prior written permission is obtained from Network Intelligence.