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