Armoury Project Documentation
[docs.git] / manuals / developer-guide / src / main / asciidoc / armoury / odl-armoury-dev.adoc
1 == Armoury
2
3 === Overview
4 TBD: Overview of the Armoury feature, what logical functionality it
5 provides and why you might use it as a developer.
6
7 === Armoury Architecture
8 TBD: Armoury components and how they work together.
9 Also include information about how the feature integrates with
10 OpenDaylight and architecture.
11
12 === Key APIs and Interfaces
13 TBD: Document the key things a user would want to use.
14
15 ==== Armoury Catalog API
16 TBD: A description of Armoury Catalog API.
17
18 ==== Armoury Workload Manager API
19 TBD: A description of Armoury Workload Manager API.
20
21 ==== Armoury Driver Registry API
22 TBD: A description of Armoury Driver Registry API.
23
24 === API Reference Documentation
25 TBD: Provide links to JavaDoc, REST API documentation, etc.