e36172bb40634e482fd326ec202c6744ba058fcd
[federation.git] / docs / release-notes.rst
1 .. ===============LICENSE_START=======================================================
2 .. Acumos CC-BY-4.0
3 .. ===================================================================================
4 .. Copyright (C) 2017-2020 AT&T Intellectual Property & Tech Mahindra. All rights reserved.
5 .. Modifications Copyright (C) 2020 Nordix Foundation.
6 .. ===================================================================================
7 .. This Acumos documentation file is distributed by AT&T and Tech Mahindra
8 .. under the Creative Commons Attribution 4.0 International License (the "License");
9 .. you may not use this file except in compliance with the License.
10 .. You may obtain a copy of the License at
11 ..
12 .. http://creativecommons.org/licenses/by/4.0
13 ..
14 .. This file is distributed on an "AS IS" BASIS,
15 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 .. See the License for the specific language governing permissions and
17 .. limitations under the License.
18 .. ===============LICENSE_END=========================================================
19
20 ================================
21 Federation Gateway Release Notes
22 ================================
23
24 This server is available as a Docker image in a Docker registry at the Linux Foundation.
25 The image name is "federation-gateway" and the tag is a version string as shown below.
26
27 Version 3.2.2, 2020-03-24
28 -------------------------
29 * Adding support for updating params to deployed model (`ACUMOS-3742 <https://jira.acumos.org/browse/ACUMOS-3742>`_)
30
31 Version 3.2.1, 2020-03-12
32 -------------------------
33 * LicenseAsset support NexusArtifactClient - `ACUMOS-3960 <https://jira.acumos.org/browse/ACUMOS-3960>`_
34
35 Version 3.2.0, 2020-02-17
36 -------------------------
37 * Adding support for model data sending over federation gateway (`ACUMOS-3920 <https://jira.acumos.org/browse/ACUMOS-3920>`_)
38 * Fix solution sourceId !=null (`ACUMOS-4021 <https://jira.acumos.org/browse/ACUMOS-4021>`_)
39
40 Version 3.1.2, 2020-03-12
41 -------------------------
42 * Update dependency version for the common data service client to 3.1.0 (`ACUMOS-3845 <https://jira.acumos.org/browse/ACUMOS-3845>`_)
43 * Bump version to avoid conflict with work on master branch for demeter
44 * Part of the Clio maintenance/point release
45
46 Version 3.1.1, 2020-01-27
47 -------------------------
48 * Update dependency version for the common data service client to 3.1.1 (`ACUMOS-3951 <https://jira.acumos.org/browse/ACUMOS-3951>`_)
49
50 Version 3.1.0, 2019-12-16
51 -------------------------
52 * Update dependency version for the common data service client to 3.1.0 (`ACUMOS-3845 <https://jira.acumos.org/browse/ACUMOS-3845>`_)
53
54 Version 3.0.3, 2020-02-26
55 -------------------------
56 * LicenseAsset support NexusArtifactClient - `ACUMOS-3960 <https://jira.acumos.org/browse/ACUMOS-3960>`_
57
58 Version 3.0.2, 2019-11-04
59 -------------------------
60 * Don't re-tag imported docker images unless the tag is different (`ACUMOS-3670 <https://jira.acumos.org/browse/ACUMOS-3670>`_)
61 * Update dependency versions for the security and license profile validation clients (`ACUMOS-3669 <https://jira.acumos.org/browse/ACUMOS-3669>`_)
62
63 Version 3.0.1, 2019-09-26
64 -------------------------
65 * When a model has been federated, register it with the license manager (`ACUMOS-3484 <https://jira.acumos.org/browse/ACUMOS-3484>`_)
66   * This adds a new required configuration value, "license-manager.url" for the
67     license management service.
68
69 Version 3.0.0, 2019-09-13
70 -------------------------
71 * Upgrade server to Java 11.  Compile client for Java 8 (`ACUMOS-3334 <https://jira.acumos.org/browse/ACUMOS-3334>`_)
72   * Compile and run with Java 11, but keep client library compliance level at Java 8.
73
74 * Add "acumos/" prefix to container image name
75
76 * Update to CDS 3.0.0
77
78 Version 2.3.0, 2019-09-06
79 -------------------------
80 * Portal to show details of federation actions (`ACUMOS-1778 <https://jira.acumos.org/browse/ACUMOS-1778>`_)
81
82 * Run SV license scan when a model has been federated (`ACUMOS-3396 <https://jira.acumos.org/browse/ACUMOS-3396>`_)
83   * This adds a new required configuration value, "verification.url" for the
84     security verification service.
85
86 * Java code upgrade to Java 11 (`ACUMOS-3334 <https://jira.acumos.org/browse/ACUMOS-3334>`_)
87
88 * Update to CDS 2.2.6
89
90 * Fix DI artifact create fail due to Federation use of a stale TCP stream (`ACUMOS-3193 <https://jira.acumos.org/browse/ACUMOS-3193>`_)
91
92 * Federated model DI name to include model name - same as source peer DI name (`ACUMOS-3195 <https://jira.acumos.org/browse/ACUMOS-3195>`_)
93
94 * Publish E5 Federation client library (`ACUMOS-2760 <https://jira.acumos.org/browse/ACUMOS-2760>`_)
95
96   3 new sub-projects are introduced, in addition to the existing "gateway" sub-project.
97   * "acumos-fgw-client-config" contains bean classes used to specify properties
98     of a client's connection to its server, including basic authentication and
99     TLS (SSL) related properties.
100
101   * "acumos-fgw-client-test" contains classes for providing mock responses to
102     a client for testing applications that make calls to a server, as well as
103     dummy key store and trust store files to enable a client to be used to
104     test a server.
105
106   * "acumos-fgw-client" contains implementations of clients for both the
107     external "E5" and private interfaces to the Acumos Federation Gateway
108     as well as bean classes for the JSON wire formats used by those interfaces.
109
110   The existing "gateway" project is modified to use the client subproject when
111   making requests to a peer Acumos instance, when sending or receiving
112   artifacts from the Nexus server, and for creating the rest template used
113   to communicate with CDS.
114
115 * Access to the Swagger API is fixed and now gives responses appropriate to
116   the interface being queried (external "E5" or private).
117
118 * Some configuration is simplified.
119   * The federation.ssl.client-auth configuration parameter is now named
120     federation.client-auth and defaults to WANT, enabling access to the
121     Swagger specification on the external "E5" interface without requiring
122     a client certificate.  Attempts to access the REST API endpoints without
123     providing a client certificate will return a 403 Forbidden error.
124   * The local.ssl.client-auth configuration parameter is now named
125     local.client-auth and defaults to WANT, enabling access to the
126     Swagger specification on the private interface without requiring
127     a client certificate.  Attempts to access the REST API endpoints without
128     providing a client certificate will return a 403 Forbidden error.
129   * The federation.registration.enabled configuration parameter is now named
130     federation.registration-enabled.  It still defaults to False.
131   * The federation.instance configuration parameter no longer needs to be set to
132     "gateway" and no longer has any effect.
133   * The value "local" in the spring.profiles.active configuration parameter no
134     longer has any effect.
135   * The catalog.catalogs-selector configuration parameter no longer has any effect.
136   * The various task.* configuration parameters no longer have any effect.
137   * The cdms.client.page-size configuration parameter no longer has any effect.
138   * The catalog-local.source, catalog-local.catalogs, codes-local.source,
139     peers-local.source, and peer-local.interval configuration parameters no
140     longer have any effect.
141
142 * Documentation is updated to reflect these changes.
143
144 Version 2.2.1, 2019-07-18
145 -------------------------
146 * Fix Boreas branch Jenkins build not working (`ACUMOS-3244 <https://jira.acumos.org/browse/ACUMOS-3244>`_)
147
148 * Fix DI artifact create fail due to Federation use of a stale TCP stream (`ACUMOS-3193 <https://jira.acumos.org/browse/ACUMOS-3193>`_)
149
150 * Federated model DI name to include model name - same as source peer DI name (`ACUMOS-3195 <https://jira.acumos.org/browse/ACUMOS-3195>`_)
151
152 Version 2.2.0, 2019-04-16
153 -------------------------
154 * Increase Spring async task timeout value (spring.mvc.async.request-timeout)
155   to 10 minutes (`ACUMOS-2749 <https://jira.acumos.org/browse/ACUMOS-2749>`_)
156
157   This prevents timeouts during retrieval of large docker image artifacts.
158
159 * Update to CDS 2.2.x with subscription by catalogs (`ACUMOS-2732 <https://jira.acumos.org/browse/ACUMOS-2732>`_)
160
161   This makes changes to the REST api for accessing Federation on both the
162   public and private interfaces:
163
164   * When listing solutions, the optional selector query parameter is replaced
165     by a required catalogId query parameter
166
167   * When getting revision details an optional catalogId query parameter is
168     added, used to retrieve descriptions and documents, from that catalog, for
169     the revision.  If not specified, no descriptions or documents are returned.
170
171   * When getting artifact and document content, the form of the URI is changed
172     to eliminate the unused solution and revision IDs.
173
174   * When getting documents for a revision, the form of the URI is changed
175     to eliminate the unused solution ID and a required catalogID query parameter
176     is added.
177
178   Solution revisions in CDS no longer have access type codes, so the (optional)
179   catalog.default-access-type-code configuration parameter has been removed.
180
181 * Eliminate vulnerabilities and many "code smells" identified by SONAR.
182
183 Version 2.1.2, 2019-03-27
184 -------------------------
185 * Add JUnit test cases to reach 50% or better code coverage (`ACUMOS-2584 <https://jira.acumos.org/browse/ACUMOS-2584>`_)
186 * Add API to list remote catalogs to support subscribing (`ACUMOS-2575 <https://jira.acumos.org/browse/ACUMOS-2575>`_)
187   API to list catalogs is /catalogs
188 * Refactor code to avoid duplication related to implementing listing remote catalogs.
189 * Documentation configuration parameters (`ACUMOS-2661 <https://jira.acumos.org/browse/ACUMOS-2661>`_)
190
191 Version 2.1.1, 2019-03-07
192 -------------------------
193 * Solution picture should be copied (`ACUMOS-2570 <https://jira.acumos.org/browse/ACUMOS-2570>`_)
194
195 Version 2.1.0, 2019-03-05
196 -------------------------
197 * Update to CDS 2.1.2
198
199 Version 2.0.1, 2019-02-26
200 -------------------------
201
202 * Add catalogId field in solution search selector (`ACUMOS-2285 <https://jira.acumos.org/browse/ACUMOS-2285>`_)
203 * Normalize configured Nexus URL to have exactly one trailing slash (`ACUMOS-2554 <https://jira.acumos.org/browse/ACUMOS-2554>`_)
204 * Allow server to run as unprivileged user (`ACUMOS-2551 <https://jira.acumos.org/browse/ACUMOS-2551>`_)
205 * Various problems found with version 2.0.0 (`ACUMOS-2570 <https://jira.acumos.org/browse/ACUMOS-2570>`_)
206   - List dependency on jersey-hk2 for spring-boot
207   - Instant rendered as JSON object rather than seconds since epoch
208   - Seconds since epoch may parse as Integer instead of Long
209
210 Version 2.0.0, 2019-02-20
211 -------------------------
212
213 * Use Boreas log pattern; remove EELF (`ACUMOS-2329 <https://jira.acumos.org/browse/ACUMOS-2329>`_)
214 * Fix repeated update of metadata (`ACUMOS-2399 <https://jira.acumos.org/browse/ACUMOS-2399>`_)
215 * Update to CDS 2.0.7
216
217 Version 1.18.7, 2018-10-30
218 --------------------------
219
220 * Fix the subscription task early cancellation (`ACUMOS-1937 <https://jira.acumos.org/browse/ACUMOS-1937>`_)
221 * Fix the preemptive authentication (`ACUMOS-1952 <https://jira.acumos.org/browse/ACUMOS-1952>`_)
222
223 Version 1.18.6, 2018-10-08
224 --------------------------
225
226 * Fix for the handling of mis-represented content uris (`ACUMOS-1780 <https://jira.acumos.org/browse/ACUMOS-1780>`_)
227 * Adds subscription option directing the handling of error in content retrieval with respect to catalog updates
228
229 Version 1.18.5, 2018-10-02
230 --------------------------
231
232 * Fix for loss of file name prefix/suffix (`ACUMOS-1780 <https://jira.acumos.org/browse/ACUMOS-1780>`_)
233 * Fix for processing of docker artifacts, push to the local registry (`ACUMOS-1781 <https://jira.acumos.org/browse/ACUMOS-1781>`_)
234 * Add peer 'isActive' as controller calls pre-authorization check
235 * Fix the artifact content processing condition in the gateway
236
237 Version 1.18.4, 2018-09-21
238 --------------------------
239
240 * Fix download of large artifacts
241 * Upgrade Spring-Boot to 1.5.16.RELEASE (`ACUMOS-1754 <https://jira.acumos.org/browse/ACUMOS-1754>`_)
242
243 Version 1.18.3, 2018-09-14
244 --------------------------
245
246 * Increase max heap size
247 * configuration changes:
248   new top level docker configuration block::
249
250     "docker": {
251         "host": "tcp://your_host:port",
252         "registryUrl": "your_registry:port",
253         "registryUsername": "docker_username",
254         "registryPassword": "docker_password",
255         "registryEmail": ""
256     }
257
258 Version 1.18.2, 2018-09-13
259 --------------------------
260
261 * Rely on solution detail API for mapping (`ACUMOS-1690 <https://jira.acumos.org/browse/ACUMOS-1690>`_)
262 * Add binary stream to resource http content mapper (`ACUMOS-1690 <https://jira.acumos.org/browse/ACUMOS-1690>`_)
263 * Allow configuration of underlying executor and scheduler
264 * Do not overwrite user during mapping for local solutions
265
266 Version 1.18.1, 2018-09-05
267 --------------------------
268
269 * Simplified catalog solutions lookup
270 * Fix 'self' peer not found (`ACUMOS-1694 <https://jira.acumos.org/browse/ACUMOS-1694>`_)
271 * Fix task scheduler initialization (`ACUMOS-1690 <https://jira.acumos.org/browse/ACUMOS-1690>`_)
272 * Fix solution tag handling
273 * Move solution and revision updates to service interface
274
275 Version 1.18.0, 2018-09-05
276 --------------------------
277
278 * Align with data model changes from CDS 1.18.x
279 * Fix subscription update processing (`ACUMOS-1693 <https://jira.acumos.org/browse/ACUMOS-1693>`_)
280
281 Version 1.17.1, 2018-09-04
282 --------------------------
283
284 * Spread the use of configuration beans (`ACUMOS-1692 <https://jira.acumos.org/browse/ACUMOS-1692>`_)
285
286 Version 1.17.0, 2018-08-14
287 --------------------------
288
289 * Align with data model changes from CDS 1.17.x
290 * Add revision document federation (`ACUMOS-1606 <https://jira.acumos.org/browse/ACUMOS-1606>`_)
291 * Add tag federation (`ACUMOS-1544 <https://jira.acumos.org/browse/ACUMOS-1544>`_)
292 * Fix authorship federation (`ACUMOS-626 <https://jira.acumos.org/browse/ACUMOS-626>`_)
293 * The federation API for access to artifact and document content access have changed
294   to /solutions/{solutionId}/revisions/{revisionId}/artifacts/{artifactId}/content
295   and /solutions/{solutionId}/revisions/{revisionId}/documents/{documentId}/content
296
297 Version 1.16.1, 2018-08-08
298 --------------------------
299
300 * Temporary patch for tag handling during federation procedures
301
302 Version 1.16.0, 2018-08-01
303 --------------------------
304
305 * Aligns with the data model changes from CDS 1.16.x
306 * Minor fixes in order to adhere to project coding standards.
307
308 Version 1.15.1, 2018-07-31
309 --------------------------
310
311 * Fixes catalog solution lookup strategy due to used criteria moving to other entities (solution -> revision)
312 * Fixes some Sonar complaints
313 * Adds more unit tests for CDS based service implementations
314 * Align version numbers with CDS
315
316 Version 1.1.5, 2018-07-12
317 -------------------------
318
319 * Aligns with the data model changes from CDS 1.15 (`ACUMOS-1330 <https://jira.acumos.org/browse/ACUMOS-1330>`_)
320
321 Version 1.1.4.1, 2018-07-11
322 ---------------------------
323
324 * Fix handling of docker images with no tags (`ACUMOS-1015 <https://jira.acumos.org/browse/ACUMOS-1015>`_)
325
326 Version 1.1.4, 2018-06-20
327 -------------------------
328
329 * Fix result size test when retrieving 'self' peer
330 * Fix handling of null solutions filter in the service. Fix the handling of no such item errors in catalog controller.
331
332 Version 1.1.3, 2018-05-10
333 -------------------------
334
335 * Upgrade to CDS 1.14.4
336
337 Version 1.1.2, 2018-04-19
338 -------------------------
339
340 * Revise code for Sonar warnings (`ACUMOS-672 <https://jira.acumos.org/browse/ACUMOS-672>`_)
341
342 Version 1.1.1, 2018-04-13
343 -------------------------
344
345 * Unit tests for local interface
346 * Separate federation and local service interfaces (`ACUMOS-276 <https://jira.acumos.org/browse/ACUMOS-276>`_)
347
348 Version 1.1.0, 2018-03-09
349 -------------------------
350
351 * Separate between federation and local interface with respect to network configuration, authorization and available REST API.
352 * Upgrade to CDS 1.14.0
353
354 Version 1.0.0, 2018-02-12
355 -------------------------
356
357 * Use release (not snapshot) versions of acumos-nexus-client and common-dataservice libraries
358 * Limit JVM memory use via Docker start command
359 * Revise docker projects to deploy images to nexus3.acumos.org
360 * Make aspectjweaver part of runtime
361 * Add dependency copy plugin
362
363 Version 0.2.0, 2017-11-28
364 -------------------------
365
366 * Support to CDS 1.9.0
367 * 2-Way SSL Support
368 * X509 Subject Principal Authentication