Solum Directory Structure

Registered by Paul Montgomery on 2013-10-02

This is a proposal for the Solum project directory structure to enable contributions quickly. Marconi, Neutron and Trove were analyzed for standard practices. Let's discuss the structure and reach community consensus.

/doc = all project documentation, config examples and example code
/tests = all integration tests
/tests/etc = integration test config
/tools directory = all management or meta tools that assist or augment Solum functionality but isn't directly needed by runtime services
/tools/bin = general health, management and reporting tools
[External Project] = Solum SDK which enables remote programmatic access to Solum features
[External Project] = Solum CLI which enables remote command line access to Solum features
[External Project] = Plugins for GUI development tools which enables native code submission to Solum

/solum/tests = unit tests (mocked out)
/solum/tests/etc = unit test config
/solum/locale = translation directory
/solum/addons = Solum addons directory (examples, Trove or MongoDB support; if any)
/solum/etc = centralized Solum runtime config
/solum/common = common routines used by many modules in Solum
/solum/openstack/common = common routines borrowed from OpenStack
/solum/db = all database access
/solum/services = all runtime services (example: REST API server)
/solum/languagepacks = all language packs for Solum (if any)

Blueprint information

Status:
Complete
Approver:
Adrian Otto
Priority:
Medium
Drafter:
Paul Montgomery
Direction:
Approved
Assignee:
Adrian Otto
Definition:
Approved
Series goal:
None
Implementation:
Implemented
Milestone target:
milestone icon 2014.1.1
Started by
Adrian Otto on 2013-10-26
Completed by
Adrian Otto on 2013-11-02

Related branches

Sprints

Whiteboard

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.