Split tutorial out from Orion-LD, Scorpio and Stellio

jason-fox · jason-fox · commit 8ae183240c66 · 2021-12-10T14:18:09.000+01:00
diff --git a/.env b/.env
@@ -7,7 +7,7 @@ ORION_LD_VERSION=0.8.2
 
 # Scorpio variables
 SCORPIO_PORT=9090
-SCORPIO_VERSION=dev
+SCORPIO_VERSION=1.1.0
 
 # Stellio variables
 STELLIO_DOCKER_TAG=latest
diff --git a/docker-compose/common.yml b/docker-compose/common.yml
@@ -0,0 +1,85 @@
+# WARNING: Do not deploy this tutorial configuration directly to a production environment
+#
+# The tutorial docker-compose files have not been written for production deployment and will not 
+# scale. A proper architecture has been sacrificed to keep the narrative focused on the learning 
+# goals, they are just used to deploy everything onto a single Docker machine. All FIWARE components 
+# are running at full debug and extra ports have been exposed to allow for direct calls to services. 
+# They also contain various obvious security flaws - passwords in plain text, no load balancing,
+# no use of HTTPS and so on. 
+# 
+# This is all to avoid the need of multiple machines, generating certificates, encrypting secrets
+# and so on, purely so that a single docker-compose file can be read as an example to build on, 
+# not use directly. 
+# 
+# When deploying to a production environment, please refer to the Helm Repository
+# for FIWARE Components in order to scale up to a proper architecture:
+# 
+# see: https://github.com/FIWARE/helm-charts/
+#
+version: "3.5"
+services:  
+  # Databases
+  mongo-db:
+    image: mongo:${MONGO_DB_VERSION}
+    hostname: mongo-db
+    container_name: db-mongo
+    expose:
+      - "${MONGO_DB_PORT}"
+    ports:
+      - "${MONGO_DB_PORT}:${MONGO_DB_PORT}" # localhost:27017
+    networks:
+      - default
+    command: --nojournal
+    volumes:
+      - mongo-db:/data
+    healthcheck:
+      test: |
+        host=`hostname --ip-address || echo '127.0.0.1'`; 
+        mongo --quiet $host/test --eval 'quit(db.runCommand({ ping: 1 }).ok ? 0 : 2)' && echo 0 || echo 1
+      interval: 5s
+    
+
+
+  # Tutorial displays a web app to manipulate the context directly
+  tutorial:
+    image: fiware/tutorials.context-provider
+    hostname: tutorial
+    container_name: fiware-tutorial
+    depends_on:
+      - orion
+    networks:
+      default:
+        aliases:
+          - iot-sensors
+          - context-provider
+    expose:
+      - "${TUTORIAL_APP_PORT}" # localhost:3000
+      - "${TUTORIAL_DUMMY_DEVICE_PORT}" # localhost:3001
+    ports:
+      - "${TUTORIAL_APP_PORT}:${TUTORIAL_APP_PORT}" # localhost:3000
+      - "${TUTORIAL_DUMMY_DEVICE_PORT}:${TUTORIAL_DUMMY_DEVICE_PORT}" # localhost:3001
+    environment:
+      - "MONGO_URL=mongodb://mongo-db:27017"
+      - "DEBUG=tutorial:*"
+      - "WEB_APP_PORT=${TUTORIAL_APP_PORT}" # Port used by the content provider proxy and web-app for viewing data
+      - "NGSI_VERSION=ngsi-ld"
+      - "CONTEXT_BROKER=http://orion:${ORION_LD_PORT}/ngsi-ld/v1" # URL of the context broker to update context
+      - "DEVICE_BROKER=http://devices:${ORION_EDGE_PORT}/v2" # URL of the device's context broker to update context
+      - "NGSI_LD_PREFIX=urn:ngsi-ld:"
+      
+      - "IOTA_HTTP_HOST=iot-agent"
+      - "IOTA_HTTP_PORT=${IOTA_SOUTH_PORT}"
+      - "DUMMY_DEVICES_PORT=${TUTORIAL_DUMMY_DEVICE_PORT}" # Port used by the dummy IOT devices to receive commands
+      - "DUMMY_DEVICES_TRANSPORT=HTTP" # Default transport used by dummy Io devices
+
+      - "OPENWEATHERMAP_KEY_ID=<ADD_YOUR_KEY_ID>"
+      - "TWITTER_CONSUMER_KEY=<ADD_YOUR_CONSUMER_KEY>"
+      - "TWITTER_CONSUMER_SECRET=<ADD_YOUR_CONSUMER_SECRET>"
+
+
+
+networks:
+  default: ~
+
+volumes:
+  mongo-db: ~
diff --git a/docker-compose/orion-ld.yml b/docker-compose/orion-ld.yml
@@ -34,33 +34,13 @@ services:
       test: curl --fail -s http://orion:${ORION_LD_PORT}/version || exit 1
       interval: 5s
 
+     
+  # Tutorial acts as a series of dummy IoT Sensors over HTTP and connects to the Orion-LD Broker
+  tutorial:
+    environment:
+      - IOTA_DEFAULT_RESOURCE=/iot/d
+      - DUMMY_DEVICES_PORT=${TUTORIAL_DUMMY_DEVICE_PORT} # Port used by the dummy IOT devices to receive commands
+      - DUMMY_DEVICES_TRANSPORT=HTTP # Default transport used by dummy Io devices
+      - DUMMY_DEVICES_PAYLOAD=ULTRALIGHT
+      - CONTEXT_BROKER=http://orion:${ORION_LD_PORT}/ngsi-ld/v1 # URL of the context broker to update context
 
-  # Databases
-  mongo-db:
-    image: mongo:${MONGO_DB_VERSION}
-    hostname: mongo-db
-    container_name: db-mongo
-    expose:
-      - "${MONGO_DB_PORT}"
-    ports:
-      - "${MONGO_DB_PORT}:${MONGO_DB_PORT}" # localhost:27017
-    networks:
-      - default
-    command: --nojournal
-    volumes:
-      - mongo-db:/data
-    healthcheck:
-      test: |
-        host=`hostname --ip-address || echo '127.0.0.1'`; 
-        mongo --quiet $host/test --eval 'quit(db.runCommand({ ping: 1 }).ok ? 0 : 2)' && echo 0 || echo 1
-      interval: 5s
-    
-
-networks:
-  default:
-    ipam:
-      config:
-        - subnet: 172.18.1.0/24
-
-volumes:
-  mongo-db: ~
diff --git a/docker-compose/scorpio-aaio.yml b/docker-compose/scorpio-aaio.yml
@@ -68,8 +68,22 @@ services:
     depends_on:
       - kafka
       - postgres
-    healthcheck:
-      test: curl --fail -s http://scorpio:${SCORPIO_PORT}/scorpio/v1/info/ || exit 1
+    #healthcheck:
+    #  test: curl --fail -s http://scorpio:${SCORPIO_PORT}/scorpio/v1/info/ || exit 1
+    deploy:
+      resources:
+        limits:
+          cpus: '0.8'
+          memory: 640M
+        reservations:
+          cpus: '0.6'
+          memory: 480M
 
-networks:
-  default: ~
+  # Tutorial connects to the Scorpio Broker
+  tutorial:
+    environment:
+      - IOTA_DEFAULT_RESOURCE=/iot/d
+      - DUMMY_DEVICES_PORT=${TUTORIAL_DUMMY_DEVICE_PORT} # Port used by the dummy IOT devices to receive commands
+      - DUMMY_DEVICES_TRANSPORT=HTTP # Default transport used by dummy Io devices
+      - DUMMY_DEVICES_PAYLOAD=ULTRALIGHT
+      - CONTEXT_BROKER=http://scorpio:${SCORPIO_PORT}/ngsi-ld/v1 # URL of the context broker to update context
diff --git a/docker-compose/stellio.yml b/docker-compose/stellio.yml
@@ -1,36 +1,18 @@
-# WARNING: Do not deploy this tutorial configuration directly to a production environment
-#
-# The tutorial docker-compose files have not been written for production deployment and will not 
-# scale. A proper architecture has been sacrificed to keep the narrative focused on the learning 
-# goals, they are just used to deploy everything onto a single Docker machine. All FIWARE components 
-# are running at full debug and extra ports have been exposed to allow for direct calls to services. 
-# They also contain various obvious security flaws - passwords in plain text, no load balancing,
-# no use of HTTPS and so on. 
-# 
-# This is all to avoid the need of multiple machines, generating certificates, encrypting secrets
-# and so on, purely so that a single docker-compose file can be read as an example to build on, 
-# not use directly. 
-# 
-# When deploying to a production environment, please refer to the Helm Repository
-# for FIWARE Components in order to scale up to a proper architecture:
-# 
-# see: https://github.com/FIWARE/helm-charts/
-#
-version: "3.5"
+version: '3.5'
 services:
-
   zookeeper:
     image: confluentinc/cp-zookeeper:5.4.1
-    container_name: stellio-zookeeper
+    container_name: zookeeper
     ports:
       - 2181:2181
     environment:
       ZOOKEEPER_SERVER_ID: 1
       ZOOKEEPER_CLIENT_PORT: 2181
       ZOOKEEPER_TICK_TIME: 2000
+
   kafka:
     image: confluentinc/cp-kafka:5.4.1
-    container_name: stellio-kafka
+    container_name: kafka
     ports:
       - 29092:29092
     environment:
@@ -43,86 +25,99 @@ services:
       KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
     depends_on:
       - zookeeper
-  neo4j:
-    image: neo4j:4.0
-    container_name: stellio-neo4j
-    volumes:
-      - stellio-neo4j-storage:/data
-    environment:
-      - NEO4J_dbms_allow__upgrade=${NEO4J_ALLOW_UPGRADE}
-      - NEO4J_dbms_default__database=${NEO4J_DEFAULT_DATABASE}
-      - NEO4J_AUTH=neo4j/${NEO4J_PASSWORD}
-      - "NEO4J_dbms_security_procedures_unrestricted=apoc.*"
-      - "NEO4J_dbms_security_procedures_whitelist=apoc.*"
-      - NEO4JLABS_PLUGINS=["apoc"]
-    ports:
-      - 7474:7474
-      - 7687:7687
-  postgres:
-    image: stellio/stellio-timescale-postgis:1.7.2-pg11
-    container_name: stellio-postgres
-    environment:
-      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
-      - "POSTGRES_MULTIPLE_DATABASES=${STELLIO_SEARCH_DB_DATABASE},${STELLIO_SEARCH_DB_USER},${STELLIO_SEARCH_DB_PASSWORD}: ${STELLIO_SUBSCRIPTION_DB_DATABASE},${STELLIO_SUBSCRIPTION_DB_USER},${STELLIO_SUBSCRIPTION_DB_PASSWORD}"
-      # not sure it is really necessary but it does not break anything ...
-      - PGDATA=/var/lib/postgresql/data/pgdata
-    ports:
-      - 5432:5432
-    volumes:
-      - stellio-postgres-storage:/var/lib/postgresql/data
+
   api-gateway:
     container_name: stellio-api-gateway
+    hostname: stellio
     image: stellio/stellio-api-gateway:${STELLIO_DOCKER_TAG}
     environment:
-      - SPRING_PROFILES_ACTIVE=${ENVIRONMENT}
+      - SPRING_PROFILES_ACTIVE=docker
     ports:
-      - 8080:8080
+      - "${STELLIO_PORT}:8080"
+
   entity-service:
     container_name: stellio-entity-service
     image: stellio/stellio-entity-service:${STELLIO_DOCKER_TAG}
     environment:
-      - SPRING_DATA_NEO4J_PASSWORD=${NEO4J_PASSWORD}
-      - SPRING_PROFILES_ACTIVE=${ENVIRONMENT}
-      - APPLICATION_AUTHENTICATION_ENABLED=${STELLIO_AUTHENTICATION_ENABLED}
+      - SPRING_PROFILES_ACTIVE=docker
+      - APPLICATION_AUTHENTICATION_ENABLED=false
     ports:
       - 8082:8082
     depends_on:
       - neo4j
       - kafka
+
   search-service:
     container_name: stellio-search-service
     image: stellio/stellio-search-service:${STELLIO_DOCKER_TAG}
     environment:
-      - SPRING_PROFILES_ACTIVE=${ENVIRONMENT}
-      - SPRING_R2DBC_URL=r2dbc:postgresql://postgres/${STELLIO_SEARCH_DB_DATABASE}
-      - SPRING_FLYWAY_URL=jdbc:postgresql://postgres/${STELLIO_SEARCH_DB_DATABASE}
-      - SPRING_R2DBC_USERNAME=${STELLIO_SEARCH_DB_USER}
-      - SPRING_R2DBC_PASSWORD=${STELLIO_SEARCH_DB_PASSWORD}
-      - APPLICATION_AUTHENTICATION_ENABLED=${STELLIO_AUTHENTICATION_ENABLED}
+      - SPRING_PROFILES_ACTIVE=docker
+      - SPRING_R2DBC_URL=r2dbc:postgresql://postgres/stellio_search
+      - SPRING_FLYWAY_URL=jdbc:postgresql://postgres/stellio_search
+      - SPRING_R2DBC_USERNAME=stellio_search
+      - SPRING_R2DBC_PASSWORD=stellio_search_db_password
+      - APPLICATION_AUTHENTICATION_ENABLED=false
     ports:
       - 8083:8083
     depends_on:
       - postgres
       - kafka
+
   subscription-service:
     container_name: stellio-subscription-service
     image: stellio/stellio-subscription-service:${STELLIO_DOCKER_TAG}
     environment:
-      - SPRING_PROFILES_ACTIVE=${ENVIRONMENT}
-      - SPRING_R2DBC_URL=r2dbc:postgresql://postgres/${STELLIO_SUBSCRIPTION_DB_DATABASE}
-      - SPRING_FLYWAY_URL=jdbc:postgresql://postgres/${STELLIO_SUBSCRIPTION_DB_DATABASE}
-      - SPRING_R2DBC_USERNAME=${STELLIO_SUBSCRIPTION_DB_USER}
-      - SPRING_R2DBC_PASSWORD=${STELLIO_SUBSCRIPTION_DB_PASSWORD}
-      - APPLICATION_AUTHENTICATION_ENABLED=${STELLIO_AUTHENTICATION_ENABLED}
+      - SPRING_PROFILES_ACTIVE=docker
+      - SPRING_R2DBC_URL=r2dbc:postgresql://postgres/stellio_subscription
+      - SPRING_FLYWAY_URL=jdbc:postgresql://postgres/stellio_subscription
+      - SPRING_R2DBC_USERNAME=stellio_subscription
+      - SPRING_R2DBC_PASSWORD=stellio_subscription_db_password
+      - APPLICATION_AUTHENTICATION_ENABLED=false
     ports:
       - 8084:8084
     depends_on:
       - postgres
       - kafka
 
-networks:
-  default: ~
+  # Databases
+  neo4j:
+    image: neo4j:4.2
+    hostname: neo4j
+    container_name: db-neo4j
+    volumes:
+      - neo4j-db:/data
+    environment:
+      - NEO4J_dbms_default__database=stellio
+      - NEO4J_AUTH=none
+      - "NEO4J_dbms_security_procedures_unrestricted=apoc.*"
+      - "NEO4J_dbms_security_procedures_allowlist=apoc.*"
+      - NEO4JLABS_PLUGINS=["apoc"]
+    ports:
+      - 7474:7474
+      - 7687:7687
+
+  postgres:
+    image: stellio/stellio-timescale-postgis:2.3.0-pg13
+    hostname: postgres
+    container_name: db-postgres
+    environment:
+      - POSTGRES_PASSWORD=password
+      - "POSTGRES_MULTIPLE_DATABASES=stellio_search,stellio_search,stellio_search_db_password: stellio_subscription,stellio_subscription,stellio_subscription_db_password"
+      - PGDATA=/var/lib/postgresql/data/pgdata
+    ports:
+      - 5432:5432
+    volumes:
+      - postgres-db:/var/lib/postgresql/data
 
+  # Tutorial connects to the Stellio Broker
+  tutorial:
+    environment:
+      - IOTA_DEFAULT_RESOURCE=/iot/d
+      - DUMMY_DEVICES_PORT=${TUTORIAL_DUMMY_DEVICE_PORT} # Port used by the dummy IOT devices to receive commands
+      - DUMMY_DEVICES_TRANSPORT=HTTP # Default transport used by dummy Io devices
+      - DUMMY_DEVICES_PAYLOAD=ULTRALIGHT
+      - CONTEXT_BROKER=http://api-gateway:${STELLIO_PORT}/ngsi-ld/v1 # URL of the context broker to update context
+     
 volumes:
-  stellio-neo4j-storage: ~
-  stellio-postgres-storage: ~
+  neo4j-db: ~
+  postgres-db: ~
diff --git a/services b/services
