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