Basic configurations

    system log

    When the user sets the value of the environment variable named KuiperSyslogKey to true, the log will be printed to the syslog.

    1. basic:
    2.   # CLI bind IP
    3.   ip: 0.0.0.0
    4.   # CLI port
    5.   port: 20498

    Rest Service Configuration

    1. basic:
    2.   # REST service bind IP
    3.   restIp: 0.0.0.0
    4.   # REST service port
    5.   restTls:
    6.     certfile: /var/https-server.crt
    7.     keyfile: /var/https-server.key

    The port for the rest api http server to listen to.

    restTls

    The tls cert file path and key file path setting. If restTls is not set, the rest api server will listen on http. Otherwise, it will listen on https.

    For such a default configuration, eKuiper will export metrics and serve prometheus at

    Pluginhosts Configuration

    The URL where hosts all of pre-build plugins. By default it’s at packages.emqx.io. There could be several hosts (host can be separated with comma), if same package could be found in the several hosts, then the package in the 1st host will have the highest priority.

    Please notice that only the plugins that can be installed to the current eKuiper instance will be listed through below Rest-APIs. 

    1. GET http://localhost:9081/plugins/sources/prebuild
    2. GET http://localhost:9081/plugins/sinks/prebuild
    3. GET http://localhost:9081/plugins/functions/prebuild
    • eKuiper version: The plugins must be built for the eKuiper instance version. If the plugins cannot be found for a specific version, no plugins will be returned.
    • Operating system: Now only Linux system is supported, so if eKuiper is running at other operating systems, no plugins will be returned.
    • CPU architecture: Only with correct CPU architecture built plugins are found in the plugin repository can the plugins be returned.
    • EMQ official released Docker images: Only when the eKuiper is running at EMQ official released Docker images can the plugins be returned.
    1. pluginHosts: https://packages.emqx.io

    It could be also as following, you can specify a local repository, and the plugin in that repository will have higher priorities.

    The directory structure of the plugins should be similar as following.

    1. http://host:port/kuiper-plugins/0.9.1/alpine/sinks
    2. http://host:port/kuiper-plugins/0.9.1/alpine/sources
    3. http://host:port/kuiper-plugins/0.9.1/alpine/functions

    The content of the page should be similar as below.

    1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
    2. <html>
    3. <title>Directory listing for enterprise: /4.1.1/</title>
    4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    5. <body>
    6.     <h2>Directory listing for enterprise: /4.1.1/</h2>
    8.     <ul>
    9.         <li><a href="file_386.zip">file_386.zip</a>
    10.         <li><a href="file_amd64.zip">file_amd64.zip</a>
    11.         <li><a href="file_arm.zip">file_arm.zip</a>
    12.         <li><a href="file_arm64.zip">file_arm64.zip</a>
    13.         <li><a href="file_ppc64le.zip">file_ppc64le.zip</a>
    15.         <li><a href="influx_386.zip">influx_386.zip</a>
    16.         <li><a href="influx_amd64.zip">influx_amd64.zip</a>
    17.         <li><a href="influx_arm.zip">influx_arm.zip</a>
    18.         <li><a href="influx_arm64.zip">influx_arm64.zip</a>
    19.         <li><a href="influx_ppc64le.zip">influx_ppc64le.zip</a>
    20.     </ul>
    21.     <hr>
    22. </body>