diff options
Diffstat (limited to 'docs/content')
| -rw-r--r-- | docs/content/deployment.rst | 13 | ||||
| -rw-r--r-- | docs/content/modeling.rst | 28 |
2 files changed, 37 insertions, 4 deletions
diff --git a/docs/content/deployment.rst b/docs/content/deployment.rst index fd6fd59..0013466 100644 --- a/docs/content/deployment.rst +++ b/docs/content/deployment.rst @@ -2,7 +2,7 @@ .. Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. -.. Copyright (C) 2021 Bell Canada +.. Copyright (C) 2021-2022 Bell Canada .. Modifications Copyright (C) 2021 Nordix Foundation ======================= @@ -127,3 +127,14 @@ For development purposes, CPS Temporal can be ran on any environment using Docker. Refer to `README.md <https://github.com/onap/cps-cps-temporal/blob/master/README.md>`_ and `docker-compose.yml <https://github.com/onap/cps-cps-temporal/blob/master/docker-compose.yml>`_ files for more details. + +Upgrade +======= + +**Cps data-updated-event schema v2** + +Cps data-updated-event schema v2 used in Jakarta is backward compatible with data-updated-event schema v1 used in Istanbul. + +It means that consumers using the schema v2 can process events generated by producers using the schema v2 or v1. + +This implies that cps temporal (consumer) must be upgraded from Istanbul to Jakarta at the same time or before cps core (producer) is upgraded from Istanbul to Jakarta.
\ No newline at end of file diff --git a/docs/content/modeling.rst b/docs/content/modeling.rst index 8871a81..e8c5345 100644 --- a/docs/content/modeling.rst +++ b/docs/content/modeling.rst @@ -2,7 +2,7 @@ .. Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. -.. Copyright (C) 2021 Bell Canada +.. Copyright (C) 2021-2022 Bell Canada ===================== CPS Temporal Modeling @@ -14,19 +14,20 @@ Event Structure Data manipulated by both CPS Core and CPS Temporal to represent a Data Updated Event is a JSON structure that is defined by following Json Schema: -* :download:`cps-data-updated-event-schema.json <../_static/event-schema/cps-data-updated-event-schema-v1.json>` +* :download:`cps-data-updated-event-schema.json <../_static/event-schema/cps-data-updated-event-schema.json>` And following is an example of an event compliant with this schema: .. code:: json { - "schema": "urn:cps:org.onap.cps:data-updated-event-schema:v1", + "schema": "urn:cps:org.onap.cps:data-updated-event-schema:v2", "id": "38aa6cc6-264d-4ede-b534-18f5c1f403ea", "source": "urn:cps:org.onap.cps", "type": "org.onap.cps.data-updated-event", "content": { "observedTimestamp": "2021-06-09T13:00:00.123-0400", + "operation": "UPDATE", "dataspaceName": "my-dataspace", "schemaSetName": "my-schema-set", "anchorName": "my-anchor", @@ -39,3 +40,24 @@ And following is an example of an event compliant with this schema: } } +Event versions +============== + +The following table lists the data-updated-event schema evolution over releases : + + +-----------+------------+-------------------------+---------------------+ + | Version | Release | Compatibility Type | Upgrade First | + | | | (with previous version) | | + +===========+============+=========================+=====================+ + | v1 | Istanbul | n/a | Any order | + +-----------+------------+-------------------------+---------------------+ + | v2 | Jakarta | Backward | Consumer (Temporal) | + +-----------+------------+-------------------------+---------------------+ + +**Compatibility Types** + +Several compatibility types exist when an event schema definition is evolving from one release to the next one: + +- Backward compatibility means that consumers using the new schema can read data produced with the previous schema. +- Forward compatibility means that data produced with a new schema can be read by consumers using the previous schema. +- Full compatibility means that schemas are both backward and forward compatible: old data can be read with the new schema, and new data can also be read with the previous schema.
\ No newline at end of file |