1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
Component Information Template
==============================
High level architecture, design, and packaging information for release planning and delivery.
.. toctree::
:maxdepth: 1
Delivery
--------
Th package component is composed of the functional layers and packaged into run-time components as illustrated in the following diagrams.
.. blockdiag::
blockdiag layers {
orientation = portrait
a -> m;
b -> n;
c -> x;
m -> y;
m -> z;
group l1 {
color = blue;
x; y; z;
}
group l2 {
color = yellow;
m; n;
}
group l3 {
color = orange;
a; b; c;
}
}
Offered APIs
------------
.. csv-table::
:header-rows: 0
:header: "Container or Library", "API Reference", "Purpose", "Protocol", "Port", "TCP/UDP"
:widths: 20, 25, 25, 10, 10, 10
:delim: |
:file: offered-apis.csv
Consumed APIs
-------------
.. csv-table::
:header-rows: 0
:header: "Project Repo/Group ID", "Container or Library Offering API"
:widths: 30, 30
:delim: |
:file: consumed-apis.csv
Logging & Diagnostic Information
--------------------------------
Description of how to interact with and diagnose problems with the components in the run-time packaging.
Installation
------------
Steps to Install
Configuration
-------------
Where are they provided?
What are parameters and values?
Administration
--------------
How to run and manage the component.
Human Interfaces
----------------
Basic info on the interface type, ports/protocols provided over, etc.
|
