smartsdk / smartsdk-recipes

This repository is part of the SmartSDK project and contains recipes to use different FIWARE Generic Enablers to develop FIWARE-based applications.

SmartSDK Recipes

Introduction

This repository is part of the SmartSDK project and contains recipes to deploy different FIWARE Generic Enablers on Docker Swarm clusters.

For more info, refer to the docs.

Requirements

See the Installation section of the docs.

How to use

See the Home section of the docs.

License

This repository is licensed under Affero General Public License (GPL) version 3.

Contributing

See the Contributing section of the docs.

smartsdk-recipes's Issues

Test ticket from Code Climate

Add connectivity and smoke-tests to CI

At least smoke tests deploying in a single-node cluster and checking cross-GEs connections.

missing documentation on external networks creation

for example, looking at the context-broker HA documentation, there is no explanation about the fact that you need to set-up two networks upfront.

Add resource contraints to all recipes

Expose them as part of the configuration, but have some reasonable defaults. They're clearly part of the good practices.

Fix "TODO" issue in recipes/iot-services/iotagent-json/README.md

TODO found

https://codeclimate.com/github/smartsdk/smartsdk-recipes/recipes/iot-services/iotagent-json/README.md#issue_5a1ea24f7099dd0001000050

can we use a better name than test-channel?

smartsdk-recipes/recipes/data-management/cygnus/ha/conf/cygnus_agent.conf

Line 2 in c4c7f95

cygnus-ngsi.channels = test-channel

document multisite deployment

it should be added in the documentation in the line of the presentation made at FIWARE Tech Summit 2017

cygnus recipe is misleading w.r.t. mysql

mysql is not in ha since it is not synched, the difference instances will end up containing different data.
i would explain this and i would not show 3 replica in the example.

Improve docs: good practices

Things to improve:

• Document that all recipes that use env variables must have (reasonable) defaults. Defaults that actually work in Fiware Lab (e.g, network MTU)
• Harmonize (factor out) common settings documentation in all recipes (e.g network configuration).

Add recipe for IoT-Manger

Add postman collections

Many are used to using Postman. Keep in this repo a nice postman collection with the common methods for all Generic Enablers (in addition to the curl command examples).

if it's commented should not stay in there?

smartsdk-recipes/recipes/data-management/cygnus/ha/conf/cygnus_agent.conf

Line 20 in c4c7f95

#cygnus-ngsi.channels.test-channel.type = file

using submodule?

it could be the easiest way to keep also mongo and other external repositories in a single place

clean up mongodb recipe

i think it is better to separate the controller code from the recipes.
i provided a fixed version (the number of bugs was quite high...) that include also ability to load configuration here: https://github.com/smartsdk/mongo-rs-controller-swarm

i recommend to review it and improve if needed, and finally to clean the recipe in the repository here.

Orion optimizations

Checkout details explained in https://fiware-orion.readthedocs.io/en/master/admin/perf_tuning/index.html.
Why not using those by default?

images don't work in markdown documentation

e.g. check https://github.com/smartsdk/smartsdk-recipes/blob/master/recipes/data-management/context-broker/ha/readme.md

Bash script for quantumleap

create a bash script deploy.sh for quantumleap to go in line with the rest of the recipes.

refactor contexbroker structure

for all the other cases, we didn't document the simple case. I would make it flat then.