telefonicaiot/iotagent-ul

FIWARE Ultralight 2.0协议IoT代理

![FIWARE IoT Agents]([] ![]([]

Ultralight 2.0协议的物联网代理（支持AMQP、HTTP和MQTT传输）。此IoT代理旨在作为Ultralight与上下文代理的https://swagger.lab.fiware.org/?url=https://raw.githubusercontent.com/Fiware/specifications/master/OpenAPI/ngsiv2/ngsiv2-openapi.json%E6%8E%A5%E5%8F%A3%E4%B9%8B%E9%97%B4%E7%9A%84%E6%A1%A5%E6%8E%A5%E5%B7%A5%E5%85%B7%E3%80%82

它基于https://github.com/telefonicaid/iotagent-node-lib%E6%9E%84%E5%BB%BA%E3%80%82%E6%9C%89%E5%85%B3FIWARE IoT Agents框架的更多一般信息、其架构和常见交互模型，可在该库的GitHub仓库中找到。

本项目是FIWARE的一部分。更多信息请查看FIWARE目录中的https://github.com/Fiware/catalogue/tree/master/iot-agents%E6%9D%A1%E7%9B%AE%E3%80%82

如何使用此镜像

IoT代理必须实例化并连接到Orion Context Broker实例，下面提供一个docker-compose示例文件。

如果IOTA_REGISTRY_TYPE=mongodb，则还需要MongoDB数据库实例——以下示例假设主机系统中有/data目录用于存放数据库文件，请根据自己的配置修改挂载卷。

yml
version: "3.1"

volumes:
    mongodb: ~

services:
    iot-agent:
        image: fiware/iotagent-ul
        hostname: iot-agent
        container_name: fiware-iot-agent
        depends_on:
            - mongodb
        expose:
            - "4061"
            - "7896"
        ports:
            - "4061:4061"
            - "7896:7896"
        environment:
            - "IOTA_CB_HOST=orion"
            - "IOTA_CB_PORT=1026"
            - "IOTA_NORTH_PORT=4061"
            - "IOTA_REGISTRY_TYPE=mongodb"
            - "IOTA_MONGO_HOST=mongodb"
            - "IOTA_MONGO_PORT=27017"
            - "IOTA_MONGO_DB=iotagent-ul"
            - "IOTA_HTTP_PORT=7896"
            - "IOTA_PROVIDER_URL=http://iot-agent:4061"

    mongodb:
        image: mongo:4.2
        hostname: mongodb
        container_name: db-mongo
        ports:
            - "27017:27017"
        command: --bind_ip_all --smallfiles
        volumes:
            - mongodb:/data

    orion:
        image: fiware/orion
        hostname: orion
        container_name: fiware-orion
        depends_on:
            - mongodb
        expose:
            - "1026"
        ports:
            - "1026:1026"
        command: -dbhost mongodb

使用环境变量配置

许多设置可以通过Docker环境变量配置。典型的IoT代理Docker容器由如下环境变量驱动：

• IOTA_CB_HOST - 用于更新上下文的上下文代理主机名
• IOTA_CB_PORT - 上下文代理监听上下文更新的端口
• IOTA_NORTH_PORT - 用于配置IoT代理和接收来自上下文代理的上下文更新的端口
• IOTA_REGISTRY_TYPE - IoT设备信息存储位置（内存或数据库）
• IOTA_MONGO_HOST - MongoDB主机名（用于存储设备和服务信息）
• IOTA_MONGO_PORT - MongoDB监听端口
• IOTA_MONGO_DB - MongoDB中使用的数据库名称
• IOTA_HTTP_PORT - IoT代理监听HTTP协议IoT设备流量的端口
• IOTA_PROVIDER_URL - 注册命令时传递给上下文代理的URL，当上下文代理向设备发出命令时用作转发URL

更多信息

所有IoT代理通用参数的完整覆盖说明，请参见IoT Agent库安装指南的配置部分。

Ultralight IoT代理本身的更多设置（如MQTT、AMQP和HTTP的特定配置），可在Ultralight IoT代理安装指南中找到。

如何构建镜像

与此镜像关联的https://github.com/telefonicaid/iotagent-ul/blob/master/docker/Dockerfile%E5%8F%AF%E9%80%9A%E8%BF%87%E5%A4%9A%E7%A7%8D%E6%96%B9%E5%BC%8F%E6%9E%84%E5%BB%BA%E9%95%9C%E5%83%8F%EF%BC%9A

• 默认情况下，Dockerfile直接从GitHub获取代码库的最新版本（build-arg为可选）：

console
docker build -t iot-agent . --build-arg DOWNLOAD=latest

• 可通过构建参数DOWNLOAD=stable获取最新稳定版本：

console
docker build -t iot-agent . --build-arg DOWNLOAD=stable

• 也可通过构建参数DOWNLOAD=<version>下载特定版本：

console
docker build -t iot-agent . --build-arg DOWNLOAD=1.7.0

从自己的fork构建

要从GitHub仓库的自己的fork下载代码，请在docker build命令中添加GITHUB_ACCOUNT、GITHUB_REPOSITORY和SOURCE_BRANCH参数（默认master）：

console
docker build -t iot-agent . \
    --build-arg GITHUB_ACCOUNT=<你的账户> \
    --build-arg GITHUB_REPOSITORY=<你的仓库> \
    --build-arg SOURCE_BRANCH=<你的分支>
    --target=distroless|pm2|slim

从自己的源代码文件构建

或者，如果要直接从自己的源代码构建，请将现有Dockerfile复制到仓库根目录，并修改为使用以下命令复制本地源代码：

Dockerfile
COPY . /opt/iotaul/

完整说明可在Dockerfile本身中找到。

使用PM2 / Distroless

Docker镜像中的IoT代理可以使用相关的pm2镜像在pm2进程管理器中运行：

console
docker run --name iotagent -d fiware/iotagent-ul:<tag>-pm2

也可以使用相关的distroless镜像在无发行版容器中运行：

console
docker run --name iotagent -d fiware/iotagent-ul:<tag>-distroless

Docker Secrets

作为通过环境变量传递敏感信息的替代方法，可以在某些敏感环境变量后附加_FILE，使初始化脚本从容器中存在的文件加载这些变量的值。特别是，这可用于从存储在/run/secrets/<secret_name>文件中的Docker secrets加载密码。例如：

console
docker run --name iotagent -e IOTA_AUTH_PASSWORD_FILE=/run/secrets/password -d fiware/iotagent-ul

目前，支持以下变量使用_FILE后缀：

• IOTA_AUTH_USER
• IOTA_AUTH_PASSWORD
• IOTA_AUTH_CLIENT_ID
• IOTA_AUTH_CLIENT_SECRET
• IOTA_MONGO_USER
• IOTA_MONGO_PASSWORD
• IOTA_MQTT_KEY
• IOTA_MQTT_USERNAME
• IOTA_MQTT_PASSWORD
• IOTA_AMQP_USERNAME
• IOTA_AMQP_PASSWORD

最佳实践

在Docker生产部署中增加ULIMIT

Linux系统上的默认ulimit设置假设多个用户共享系统，这些设置限制每个用户使用的资源数量。默认设置对于高性能服务器通常非常低，应予以增加。默认情况下，我们建议在高性能场景中，IoTAgent-UL服务器的ulimit做如下更改：

console
ulimit -n 65535        # nofile: 最大打开文件描述符数（大多数系统不允许设置此值）
ulimit -c unlimited    # core: 创建的核心文件的最大大小
ulimit -l unlimited    # memlock: 可锁定到内存中的最大大小

如果只是进行轻量测试和开发，可以忽略这些设置，系统仍可正常工作。

要在容器中设置ulimit，需要使用以下附加的--ulimit标志运行IoTAgent-UL Docker容器：

console
docker run --ulimit nofile=65535:65535 --ulimit core=100000000:100000000 --ulimit memlock=100000000:100000000 \
--name iotagent -d fiware/iotagent-ul

由于“unlimited”不被支持作为值，因此将core和memlock值设置为100 GB。如果系统RAM超过100 GB，应增加此值以匹配系统可用RAM。

注意：--ulimit标志仅在Docker 1.6或更高版本中可用。然而，请求更多资源（如多个核心）可能比请求一个核心（或更少）的多个不同容器更难被编排工具（Docker Engine或Kubernetes）调度，因为编排工具可能需要寻找一个有足够可用核心的节点，而不是多个节点上的小资源。

如需了解更多关于高性能场景中系统和Node.js配置的详细信息，请参考安装指南。

设置适当的数据库索引

如果使用MongoDB作为数据持久化机制（即IOTA_REGISTRY_TYPE=mongodb），设备和服务组详细信息将从数据库中检索。IoT代理数据库的默认名称是iotagentul。可以通过创建适当的索引来优化数据库访问。

例如：

console
docker exec  <mongo-db-container-name> mongo --eval '
	conn = new Mongo();
	db = conn.getDB("iotagentul");
	db.createCollection("devices");
	db.devices.createIndex({"_id.service": 1, "_id.id": 1, "_id.type": 1});
	db.devices.createIndex({"_id.type": 1});
	db.devices.createIndex({"_id.id": 1});
	db.createCollection("groups");
	db.groups.createIndex({"_id.resource": 1, "_id.apikey": 1, "_id.service": 1});
	db.groups.createIndex({"_id.type": 1});' > /dev/null

数据库名称可通过IOTA_MONGO_DB环境变量更改。如果使用替代数据库，请修改上述conn.getDB()语句。