diff --git a/2.12.0/ldi-nifi/index.html b/2.12.0/ldi-nifi/index.html index c9c75e91b..df35cc6a6 100644 --- a/2.12.0/ldi-nifi/index.html +++ b/2.12.0/ldi-nifi/index.html @@ -1,4 +1,4 @@ - Linked Data Interactions For Apache NiFi | Linked Data Interactions

Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Linked Data Interactions For Apache NiFi

Apache Nifi is an easy to use, powerful, and reliable system to process and distribute data.

Set up NiFi instance with LDI processors

The processors can be imported into a NiFi docker instance via volume binding:

  1. Create a docker-compose.yml file with the following content in a new directory
     services:
    +             Linked Data Interactions For Apache NiFi | Linked Data Interactions             

    Skip to main content Link Menu Expand (external link) Document Search Copy Copied

    Linked Data Interactions For Apache NiFi

    Apache Nifi is an easy to use, powerful, and reliable system to process and distribute data.

    Set up NiFi instance with LDI processors

    The processors can be imported into a NiFi docker instance via volume binding:

    1. Create a docker-compose.yml file with the following content in a new directory
       services:
          nifi:
            image: apache/nifi:2.0.0
            environment:
      diff --git a/2.12.0/ldi-standalones/ldes-discoverer.html b/2.12.0/ldi-standalones/ldes-discoverer.html
      index 9c86cfaf3..f7ad21fb8 100644
      --- a/2.12.0/ldi-standalones/ldes-discoverer.html
      +++ b/2.12.0/ldi-standalones/ldes-discoverer.html
      @@ -1,4 +1,4 @@
      -             Linked Data Interactions LDES Discoverer | Linked Data Interactions             

      Skip to main content Link Menu Expand (external link) Document Search Copy Copied

      Linked Data Interactions LDES Discoverer

      A lightweight application that discovers the structure of an LDES or a view by retrieving all the tree node relations of that LDES or view.

      A use case for this could be when you are only interested in a part of the event stream. To know what part you can follow, the structure can be discovered first.

      Config

      Base configuration

      Property Description Required Default Example Supported values
      url Url where from the discoverer needs to start true N/A http://example.com/my-api HTTP and HTTPS url
      source-format The ‘Content-Type’ that should be requested to the server. false text/turtle application/n-quads Any type supported by Apache Jena

      Optional config

      Authentication

      Property Description Default Example Supported values
      auth-type The type of authentication required by the LDES server NO_AUTH OAUTH2_CLIENT_CREDENTIALS NO_AUTH, API_KEY or OAUTH2_CLIENT_CREDENTIALS
      api-key The api key when using auth-type ‘API_KEY’ N/A myKey String
      api-key-header The header for the api key when using auth-type ‘API_KEY’ X-API-KEY X-API-KEY String
      client-id The client identifier when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A myId String
      client-secret The client secret when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A mySecret String
      token-endpoint The token endpoint when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A http://localhost:8000/token HTTP and HTTPS urls
      scope The Oauth2 scope when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A http://localhost:8000/token HTTP and HTTPS urls

      Further customization

      Property Description Default Example Supported values
      disable-retry Boolean flag that disables retrying to send http requests when the server cannot be reached. (enabled when omitted) N/A N/A N/A
      retry-limit Max number of retries the http client should do (only on absence of disable-retry) 5 100 Integer
      retry-statuses Custom comma seperated list of http status codes that can trigger a retry in the http client. N/A 410,451 Comma seperated list of Integers
      rate-limit Limit of requests per period, which is defined below, that the http client should do N/A 500 Integer
      rate-limit-period Period in which the limit of requests, which is defined above, can be reached by the http client PT1M PT1H ISO 8601 Duration
      header Parameter for each individual header that is required N/A Connection: keep-alive String

      How to run

      This tutorial will show how to use the discoverer in Docker. In this example, we will try to discover the structure of an event stream called observations.

      For simplicity, we recommend passing the config as arguments.

      Run the ldes-discoverer with minimal config

      docker run ldes/ldes-discoverer --url="http://ldes-server/observations"
      +             Linked Data Interactions LDES Discoverer | Linked Data Interactions             

      Skip to main content Link Menu Expand (external link) Document Search Copy Copied

      Linked Data Interactions LDES Discoverer

      A lightweight application that discovers the structure of an LDES or a view by retrieving all the tree node relations of that LDES or view.

      A use case for this could be when you are only interested in a part of the event stream. To know what part you can follow, the structure can be discovered first.

      Config

      Base configuration

      Property Description Required Default Example Supported values
      url Url where from the discoverer needs to start true N/A http://example.com/my-api HTTP and HTTPS url
      source-format The ‘Content-Type’ that should be requested to the server. false text/turtle application/n-quads Any type supported by Apache Jena

      Optional config

      Authentication

      Property Description Default Example Supported values
      auth-type The type of authentication required by the LDES server NO_AUTH OAUTH2_CLIENT_CREDENTIALS NO_AUTH, API_KEY or OAUTH2_CLIENT_CREDENTIALS
      api-key The api key when using auth-type ‘API_KEY’ N/A myKey String
      api-key-header The header for the api key when using auth-type ‘API_KEY’ X-API-KEY X-API-KEY String
      client-id The client identifier when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A myId String
      client-secret The client secret when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A mySecret String
      token-endpoint The token endpoint when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A http://localhost:8000/token HTTP and HTTPS urls
      scope The Oauth2 scope when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A http://localhost:8000/token HTTP and HTTPS urls

      Further customization

      Property Description Default Example Supported values
      disable-retry Boolean flag that disables retrying to send http requests when the server cannot be reached. (enabled when omitted) N/A N/A N/A
      retry-limit Max number of retries the http client should do (only on absence of disable-retry) 5 100 Integer
      retry-statuses Custom comma seperated list of http status codes that can trigger a retry in the http client. N/A 410,451 Comma seperated list of Integers
      rate-limit Limit of requests per period, which is defined below, that the http client should do N/A 500 Integer
      rate-limit-period Period in which the limit of requests, which is defined above, can be reached by the http client PT1M PT1H ISO 8601 Duration
      header Parameter for each individual header that is required N/A Connection: keep-alive String

      How to run

      This tutorial will show how to use the discoverer in Docker. In this example, we will try to discover the structure of an event stream called observations.

      For simplicity, we recommend passing the config as arguments.

      Run the ldes-discoverer with minimal config

      docker run ldes/ldes-discoverer --url="http://ldes-server/observations"
       

      Run the ldes-discoverer with rate-limit, authentication and two additional headers

      docker run ldes/ldes-discoverer --url="http://ldes-server/observations" --retry-limit=3 --rate-limit=400 \
        --header="Connection: keep alive" --header="X-Source-App: ldes-discoverer" \
        --auth-type=API_KEY --api-key="my-secret-api-key"
      diff --git a/2.12.0/ldio/index.html b/2.12.0/ldio/index.html
      index 221f7192f..ec96be357 100644
      --- a/2.12.0/ldio/index.html
      +++ b/2.12.0/ldio/index.html
      @@ -1,4 +1,4 @@
      -             The Linked Data Interactions Orchestrator | Linked Data Interactions             

      Skip to main content Link Menu Expand (external link) Document Search Copy Copied

      The Linked Data Interactions Orchestrator

      A lightweight application maintained by the LDI team. Its creation came when a more lightweight alternative for Apache NiFi was needed.

      Docker Compose

      The easiest way to start working with the LDIO is by using Docker. The image is located on the Docker Hub.

      To set up your environment, start by creating a new folder dedicated to your LDIO project. Within this folder, create two files: a docker-compose.yml and a YAML configuration file. The YAML file can be named according to your preference and can be added to the volume bindings pointing to the ldio/application.yml file.

      To enable Swagger UI, debug logging, or monitoring, please follow the instructions provided below on how to incorporate them into the LDIO YAML configuration file.

      docker-compose.yml:

      version: '3.3'
      +             The Linked Data Interactions Orchestrator | Linked Data Interactions             

      Skip to main content Link Menu Expand (external link) Document Search Copy Copied

      The Linked Data Interactions Orchestrator

      A lightweight application maintained by the LDI team. Its creation came when a more lightweight alternative for Apache NiFi was needed.

      Docker Compose

      The easiest way to start working with the LDIO is by using Docker. The image is located on the Docker Hub.

      To set up your environment, start by creating a new folder dedicated to your LDIO project. Within this folder, create two files: a docker-compose.yml and a YAML configuration file. The YAML file can be named according to your preference and can be added to the volume bindings pointing to the ldio/application.yml file.

      To enable Swagger UI, debug logging, or monitoring, please follow the instructions provided below on how to incorporate them into the LDIO YAML configuration file.

      docker-compose.yml:

      version: '3.3'
       services:
         ldio-workbench:
           container_name: ldio-workbench
      diff --git a/latest/ldi-nifi/index.html b/latest/ldi-nifi/index.html
      index c9c75e91b..df35cc6a6 100644
      --- a/latest/ldi-nifi/index.html
      +++ b/latest/ldi-nifi/index.html
      @@ -1,4 +1,4 @@
      -             Linked Data Interactions For Apache NiFi | Linked Data Interactions             

      Skip to main content Link Menu Expand (external link) Document Search Copy Copied

      Linked Data Interactions For Apache NiFi

      Apache Nifi is an easy to use, powerful, and reliable system to process and distribute data.

      Set up NiFi instance with LDI processors

      The processors can be imported into a NiFi docker instance via volume binding:

      1. Create a docker-compose.yml file with the following content in a new directory
         services:
        +             Linked Data Interactions For Apache NiFi | Linked Data Interactions             

        Skip to main content Link Menu Expand (external link) Document Search Copy Copied

        Linked Data Interactions For Apache NiFi

        Apache Nifi is an easy to use, powerful, and reliable system to process and distribute data.

        Set up NiFi instance with LDI processors

        The processors can be imported into a NiFi docker instance via volume binding:

        1. Create a docker-compose.yml file with the following content in a new directory
           services:
              nifi:
                image: apache/nifi:2.0.0
                environment:
          diff --git a/latest/ldi-standalones/ldes-discoverer.html b/latest/ldi-standalones/ldes-discoverer.html
          index 9c86cfaf3..f7ad21fb8 100644
          --- a/latest/ldi-standalones/ldes-discoverer.html
          +++ b/latest/ldi-standalones/ldes-discoverer.html
          @@ -1,4 +1,4 @@
          -             Linked Data Interactions LDES Discoverer | Linked Data Interactions             

          Skip to main content Link Menu Expand (external link) Document Search Copy Copied

          Linked Data Interactions LDES Discoverer

          A lightweight application that discovers the structure of an LDES or a view by retrieving all the tree node relations of that LDES or view.

          A use case for this could be when you are only interested in a part of the event stream. To know what part you can follow, the structure can be discovered first.

          Config

          Base configuration

          Property Description Required Default Example Supported values
          url Url where from the discoverer needs to start true N/A http://example.com/my-api HTTP and HTTPS url
          source-format The ‘Content-Type’ that should be requested to the server. false text/turtle application/n-quads Any type supported by Apache Jena

          Optional config

          Authentication

          Property Description Default Example Supported values
          auth-type The type of authentication required by the LDES server NO_AUTH OAUTH2_CLIENT_CREDENTIALS NO_AUTH, API_KEY or OAUTH2_CLIENT_CREDENTIALS
          api-key The api key when using auth-type ‘API_KEY’ N/A myKey String
          api-key-header The header for the api key when using auth-type ‘API_KEY’ X-API-KEY X-API-KEY String
          client-id The client identifier when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A myId String
          client-secret The client secret when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A mySecret String
          token-endpoint The token endpoint when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A http://localhost:8000/token HTTP and HTTPS urls
          scope The Oauth2 scope when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A http://localhost:8000/token HTTP and HTTPS urls

          Further customization

          Property Description Default Example Supported values
          disable-retry Boolean flag that disables retrying to send http requests when the server cannot be reached. (enabled when omitted) N/A N/A N/A
          retry-limit Max number of retries the http client should do (only on absence of disable-retry) 5 100 Integer
          retry-statuses Custom comma seperated list of http status codes that can trigger a retry in the http client. N/A 410,451 Comma seperated list of Integers
          rate-limit Limit of requests per period, which is defined below, that the http client should do N/A 500 Integer
          rate-limit-period Period in which the limit of requests, which is defined above, can be reached by the http client PT1M PT1H ISO 8601 Duration
          header Parameter for each individual header that is required N/A Connection: keep-alive String

          How to run

          This tutorial will show how to use the discoverer in Docker. In this example, we will try to discover the structure of an event stream called observations.

          For simplicity, we recommend passing the config as arguments.

          Run the ldes-discoverer with minimal config

          docker run ldes/ldes-discoverer --url="http://ldes-server/observations"
          +             Linked Data Interactions LDES Discoverer | Linked Data Interactions             

          Skip to main content Link Menu Expand (external link) Document Search Copy Copied

          Linked Data Interactions LDES Discoverer

          A lightweight application that discovers the structure of an LDES or a view by retrieving all the tree node relations of that LDES or view.

          A use case for this could be when you are only interested in a part of the event stream. To know what part you can follow, the structure can be discovered first.

          Config

          Base configuration

          Property Description Required Default Example Supported values
          url Url where from the discoverer needs to start true N/A http://example.com/my-api HTTP and HTTPS url
          source-format The ‘Content-Type’ that should be requested to the server. false text/turtle application/n-quads Any type supported by Apache Jena

          Optional config

          Authentication

          Property Description Default Example Supported values
          auth-type The type of authentication required by the LDES server NO_AUTH OAUTH2_CLIENT_CREDENTIALS NO_AUTH, API_KEY or OAUTH2_CLIENT_CREDENTIALS
          api-key The api key when using auth-type ‘API_KEY’ N/A myKey String
          api-key-header The header for the api key when using auth-type ‘API_KEY’ X-API-KEY X-API-KEY String
          client-id The client identifier when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A myId String
          client-secret The client secret when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A mySecret String
          token-endpoint The token endpoint when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A http://localhost:8000/token HTTP and HTTPS urls
          scope The Oauth2 scope when using auth-type ‘OAUTH2_CLIENT_CREDENTIALS’ N/A http://localhost:8000/token HTTP and HTTPS urls

          Further customization

          Property Description Default Example Supported values
          disable-retry Boolean flag that disables retrying to send http requests when the server cannot be reached. (enabled when omitted) N/A N/A N/A
          retry-limit Max number of retries the http client should do (only on absence of disable-retry) 5 100 Integer
          retry-statuses Custom comma seperated list of http status codes that can trigger a retry in the http client. N/A 410,451 Comma seperated list of Integers
          rate-limit Limit of requests per period, which is defined below, that the http client should do N/A 500 Integer
          rate-limit-period Period in which the limit of requests, which is defined above, can be reached by the http client PT1M PT1H ISO 8601 Duration
          header Parameter for each individual header that is required N/A Connection: keep-alive String

          How to run

          This tutorial will show how to use the discoverer in Docker. In this example, we will try to discover the structure of an event stream called observations.

          For simplicity, we recommend passing the config as arguments.

          Run the ldes-discoverer with minimal config

          docker run ldes/ldes-discoverer --url="http://ldes-server/observations"
           

          Run the ldes-discoverer with rate-limit, authentication and two additional headers

          docker run ldes/ldes-discoverer --url="http://ldes-server/observations" --retry-limit=3 --rate-limit=400 \
            --header="Connection: keep alive" --header="X-Source-App: ldes-discoverer" \
            --auth-type=API_KEY --api-key="my-secret-api-key"
          diff --git a/latest/ldio/index.html b/latest/ldio/index.html
          index 221f7192f..ec96be357 100644
          --- a/latest/ldio/index.html
          +++ b/latest/ldio/index.html
          @@ -1,4 +1,4 @@
          -             The Linked Data Interactions Orchestrator | Linked Data Interactions             

          Skip to main content Link Menu Expand (external link) Document Search Copy Copied

          The Linked Data Interactions Orchestrator

          A lightweight application maintained by the LDI team. Its creation came when a more lightweight alternative for Apache NiFi was needed.

          Docker Compose

          The easiest way to start working with the LDIO is by using Docker. The image is located on the Docker Hub.

          To set up your environment, start by creating a new folder dedicated to your LDIO project. Within this folder, create two files: a docker-compose.yml and a YAML configuration file. The YAML file can be named according to your preference and can be added to the volume bindings pointing to the ldio/application.yml file.

          To enable Swagger UI, debug logging, or monitoring, please follow the instructions provided below on how to incorporate them into the LDIO YAML configuration file.

          docker-compose.yml:

          version: '3.3'
          +             The Linked Data Interactions Orchestrator | Linked Data Interactions             

          Skip to main content Link Menu Expand (external link) Document Search Copy Copied

          The Linked Data Interactions Orchestrator

          A lightweight application maintained by the LDI team. Its creation came when a more lightweight alternative for Apache NiFi was needed.

          Docker Compose

          The easiest way to start working with the LDIO is by using Docker. The image is located on the Docker Hub.

          To set up your environment, start by creating a new folder dedicated to your LDIO project. Within this folder, create two files: a docker-compose.yml and a YAML configuration file. The YAML file can be named according to your preference and can be added to the volume bindings pointing to the ldio/application.yml file.

          To enable Swagger UI, debug logging, or monitoring, please follow the instructions provided below on how to incorporate them into the LDIO YAML configuration file.

          docker-compose.yml:

          version: '3.3'
           services:
             ldio-workbench:
               container_name: ldio-workbench