Skip to content

Latest commit

 

History

History
233 lines (178 loc) · 7.53 KB

4_improve_project_layout.md

File metadata and controls

233 lines (178 loc) · 7.53 KB

Improve project layout

Release Signoff Checklist

  • Enhancement issue in release milestone, which links to pull request in [keylime/enhancements]
  • Core members have approved the issue with the label implementable
  • Design details are appropriately documented
  • Test plan is in place
  • User-facing documentation has been created in [keylime/keylime-docs]

Summary

This enhancement proposes to to re-organize source codes logically grouped into separate directories, e.g.:

  • keylime/cmd for script entries
  • keylime/db for database model
  • keylime/common for common utilities
  • keylime/tpm for the tpm layer

Motivation

The motivation is to make the source code layout of the project more intuitive and further refactoring easier.

Goals

The initial goal is to implement the proposed structure, as well as light code refactoring involved in the change.

Non-Goals

This is not a once for all change but a start point to do the job.

Proposal

User Stories (optional)

This should be a non user sensible change.

Story 1

Story 2

Notes/Constraints/Caveats (optional)

Risks and Mitigations

Design Details

Test Plan

Upgrade / Downgrade Strategy

Drawbacks

Alternatives

Infrastructure Needed (optional)