diff options
Diffstat (limited to 'docs/content')
| -rw-r--r-- | docs/content/apis.rst | 20 | ||||
| -rw-r--r-- | docs/content/architecture.rst | 13 | ||||
| -rw-r--r-- | docs/content/deployment.rst | 15 | ||||
| -rw-r--r-- | docs/content/design.rst | 11 | ||||
| -rw-r--r-- | docs/content/modeling.rst | 11 | ||||
| -rw-r--r-- | docs/content/overview.rst | 16 | ||||
| -rw-r--r-- | docs/content/release-notes.rst | 38 |
7 files changed, 124 insertions, 0 deletions
diff --git a/docs/content/apis.rst b/docs/content/apis.rst new file mode 100644 index 0000000..c483ea1 --- /dev/null +++ b/docs/content/apis.rst @@ -0,0 +1,20 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. +.. Copyright (C) 2021 Bell Canada + +========================= +CPS Temporal Exposed APIs +========================= + +.. warning:: Draft + +* REST API + + * Specification + * Postman Collection + +* Event Schema + + * Json Schema diff --git a/docs/content/architecture.rst b/docs/content/architecture.rst new file mode 100644 index 0000000..18f4cc3 --- /dev/null +++ b/docs/content/architecture.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. +.. Copyright (C) 2021 Bell Canada + +========================= +CPS Temporal Architecture +========================= + +.. warning:: Draft + +* Subsystem and components architecture diff --git a/docs/content/deployment.rst b/docs/content/deployment.rst new file mode 100644 index 0000000..4734b49 --- /dev/null +++ b/docs/content/deployment.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. +.. Copyright (C) 2021 Bell Canada + +======================= +CPS Temporal Deployment +======================= + +.. warning:: Draft + +* Deployment +* Logging +* Monitoring diff --git a/docs/content/design.rst b/docs/content/design.rst new file mode 100644 index 0000000..167d93d --- /dev/null +++ b/docs/content/design.rst @@ -0,0 +1,11 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. +.. Copyright (C) 2021 Bell Canada + +=================== +CPS Temporal Design +=================== + +.. warning:: Draft diff --git a/docs/content/modeling.rst b/docs/content/modeling.rst new file mode 100644 index 0000000..b8bf91e --- /dev/null +++ b/docs/content/modeling.rst @@ -0,0 +1,11 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. +.. Copyright (C) 2021 Bell Canada + +===================== +CPS Temporal Modeling +===================== + +.. warning:: Draft diff --git a/docs/content/overview.rst b/docs/content/overview.rst new file mode 100644 index 0000000..c4a981e --- /dev/null +++ b/docs/content/overview.rst @@ -0,0 +1,16 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. +.. Copyright (C) 2021 Bell Canada + +===================== +CPS Temporal Overview +===================== + +CPS Temporal is a service component belonging to CPS overall system. + +This service is responsible to provide a time oriented perspective for +operational network data. It provides features to store and retrieve sequences +of configurations or states along with the associated times when they occurred +or have been observed. diff --git a/docs/content/release-notes.rst b/docs/content/release-notes.rst new file mode 100644 index 0000000..b7f680c --- /dev/null +++ b/docs/content/release-notes.rst @@ -0,0 +1,38 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. +.. Copyright (C) 2021 Bell Canada + +========================== +CPS Temporal Release Notes +========================== + +This document contains information about CPS Temporal component releases. + +Following releases are available: + +* `1.0.0`_ (Istanbul) + +Istanbul Releases +================= + +1.0.0 +----- + +.. warning:: Draft + +.. table:: + + ===================== ========================================= + **Release Component** CPS Temporal + **Release Name** Istanbul 1.0.0 + **Release Delivery** Docker Image: ``onap/cps-temporal:1.0.0`` + **Release Date** *To be defined* + ===================== ========================================= + +Added +~~~~~ + +* `CPS-369 <https://jira.onap.org/browse/CPS-369>`__ - Feature to store temporal data corresponding to CPS Core data node updates. +* `CPS-370 <https://jira.onap.org/browse/CPS-370>`__ - Feature to query temporal data from REST API. |