Skip to content

telefonicaid/orchestrator

Repository files navigation

Build Status License badge Travis badge Docker badge Support badge Join the chat at https://gitter.im/telefonicaid/orchestrator

Orchestrator tries to group all provision operations for IoT platform that typically implies several steps or several systems' interaction. Orchestrator exposes an API and provides scripts to perform all these operations. Scripts simplifies the inherent usage of keystone, such as usage of long identifiers not so easy to remember and to use, using names and resolving internally to deal with keystone. Orchestrator scripts can interact with any remote 3rd party, since related host and port should be provideed as argument to earch script.

A typical scenario for IoT Platform can be these scenarios.

Orchestrator is used to:

  • Create/List/Update/Delete services
  • Create/List/Update/Delete subservices
  • Create/List/Update/Delete users in a service
  • Create/List/Update/Delete roles in a service
  • Create/List/Update/Delete groups in a service
  • Assign/unassign roles to users in a service
  • Create/List Trust Tokens
  • Activate / deactivate IoT Modules
  • Retrieve statistics and metrics about API usage
  • Create, List, Modify LDAP Users
  • Create, List, Modify LDAP Groups

Orchestrator is based mainly on:

  • Python 3 needed
  • Django / DjangoRestFramework

Orchestrator relies on these other IoT parts:

  • Identity Manager: Keystone (mandatory)
  • Access Control: Keypass (mandatory)
  • Context Broker: Orion (optional)
  • CEP: Perseo (optional)
  • Cygnus (optional)
  • OpenLDAP (optional)
  • Mailer (optional)
  • MongoDB (optional)

Some of these IoT parts are optional, this means that orchestrator can work without them but excluding the part of feature in which are involved. This way Keystone and Keypass are mandatory to deal with Orchestrator.

These are all dependencies requirements.txt.

Orchestrator needs a WSGI server like Apache, Lighttpd or NGIX: wsgi.py.

Orchestrator interacts mainly with Identity Manager Keystone and Access Control Keypass. Since ContextBroker and CEP are secured elements (by PepProxy) orchestrator can interact directly with tem using user provided credencials. If credencials or access control level is not enoght then orchestrator operation will not be performed.

In this README document you could find how to get started with the application and basic concepts. For a more detailed information you can read the following docs: