[Design Note] Kapua Directory Layout

The goal of this design note is to propose an alternative directory layout for the Kapua source code repository. The new layout recognizes the 8 micro services that Kapua is currently organized as and creates a separate self-contained directory for each of those. Also, share library code is organized under a single lib directory.

Root Directory Proposed Layout

kapua

• lib
  • service-api
  • locator
  • commons
  • message
  • translator
  • transport
• services
  • account
  • auth
  • user
  • device-registry
  • device-management
  • data-store
  • tag
• apps
  • broker
  • console
  • api-gateway
• util
  • assembly
  • build-tools
  • dev-tools
• qa
  • qa
  • qa-openshift
• docs
• clients
  • client
  • kura-simulator
• CONTRIBUTING.md
• LICENSE
• README.md

Service Directory Proposed Layout

kapua/services

• [service-name]
  • [service-name]-api
  • [service-name]-internal

Example Service Directory Proposed Layout

kapua/services

• account-service
  • account-service-api
  • account-service-internal
• auth-service
  • authentication-api
  • authorization-api
  • auth-internal-shiro