changed to unmaintained
[aaf/authz.git] / docs / sections / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright © 2017 AT&T Intellectual Property. All rights reserved.
4 .. _release_notes:
5
6 Release Notes
7 =============
8
9 Version: 2.1.23 (Frankfurt Maintenance, 6.0.0)
10 ----------------------------------
11 :Release Date:  2020-08-17
12
13 Note : there is no new containers for this release as this was fixed by a patch in OOM repo (using Certinitializer to override certificates in container)
14
15 **Bug Fixes**
16     - `AAF-1159 <https://jira.onap.org/browse/AAF-1159>`_ Certificate expired for AAF-SMS
17     - 'AAF-1175 <https://jira.onap.org/browse/AAF-1159>`_ Certificate between CertService client and CertService server has expired
18
19 **Known Issues - solve in Guilin**
20
21     - `AAF-1087 <https://jira.onap.org/browse/AAF-1087>`_ AAF init containers init with exit 0 even if failing
22
23 Version: 2.1.23 (Frankfurt, 6.0.0)
24 ---------------------------------------------
25
26 :Release Date: 2020-06-05
27
28 **New Features**
29 Certificate Management Protocol Version 2 (CMPv2) support was added to retrieve X.509 certificates from servers which supports CMPv2 over HTTP. SDNC as first ONAP component was integrated to enroll certificate from CMPv2 server to protect traffic between SDNC and Network Functions (xNFs).
30 More details about CMPv2 support in ONAP can be found on a dedicated page.
31
32
33 **Bug Fixes**
34         - `AAF-383 <https://jira.onap.org/browse/AAF-383>`_ AAF aaf-sms chart should use nodePortPrefix variable
35         - `AAF-783 <https://jira.onap.org/browse/AAF-783>`_ Consul container is outdated
36     - `AAF-784 <https://jira.onap.org/browse/AAF-784>`_ Vault container is outdated
37     - `AAF-1102 <https://jira.onap.org/browse/AAF-1102>`_ Pods still run as root
38
39 **Known Issues - solve in Guilin**
40     - `AAF-1087 <https://jira.onap.org/browse/AAF-1087>`_ AAF init containers init with exit 0 even if failing
41
42 Version: 2.1.15 (El Alto Maintenance, 5.0.2)
43 --------------------------------------------
44
45 :Release Date: 2020-08-24
46
47 Note : there is no new containers for this release as this was fixed by a patch in OOM repo (mounting replacement certificates through oom)
48
49 **Bug Fixes**
50
51     - `AAF-1159 <https://jira.onap.org/browse/AAF-1159>`_ Certificate expired for AAF-SMS
52
53 Version: 2.1.15 (El Alto, 5.0.1)
54 ---------------------------------------------
55
56 :Release Date: 2019-08-12
57
58 **New Features**
59 El Alto is a consolidation release.  New Features are not Added.  
60 However, for El Alto, ONAP is propagating the AAF Auto-Configuration and Certificate Generation feature from Dublin, see below
61
62 An important change, however, is that the AAF Locator requires internal K8s Apps to use 
63         internal-to-K8s Service URL tags as (example) "onap.org.osaaf.aaf.service:2.1" 
64         external-to-K8s Service URL tags as (example) "org.osaaf.aaf.service.2.1"
65
66         IF you are using previous configurations, you may need to clear the existing directory
67         
68         - Login to your Init Container
69         - cd /opt/app/osaaf/local
70         - CAREFULLY rm *.*, and have it regenerate 
71
72 **Bug Fixes**
73         - `AAF-859 <https://jira.onap.org/browse/AAF-859>`_ Images hardcoded in AAF helm deployment yamls
74
75 **Known Issues - solve in Frankfurt**
76         - `AAF-962 <https://jira.onap.org/browse/AAF-962>`_ AAF Certs could not generate...
77
78 Version: 2.1.13 (Dublin, 4.0.0-ONAP)
79 ---------------------------------------
80
81 :Release Date: 2019-06-06
82
83 **New Features**
84
85 Note: In general, Infrastructure must be accomplished in the release PRIOR to general usage.  This is the case for most of the features included here.
86
87         - AAF has built the required features to automatically generate all Certificates and Configurations real-time.  This will be utilized by ONAP MSs in El Alto
88         - AAF has the ability to publish both Public and Internal Private K8s Service information (Locator)
89         - Greatly Reduced size of Docker Images
90         - Greatly enhanced startup procedures in K8s, to more cleanly start, with Certificate, Property Generation every time
91         - Ability to run internally as non-root (fully setup K8s in El Alto)
92         - Removal of unused classes in Batch
93         - Large improvement in Batch and methodology, to be used in El Alto
94
95 **Bug Fixes**
96         - `AAF-797 <https://jira.onap.org/browse/AAF-797>`_ Update IP address for aaf-onap-test.osaaf.org
97         - `AAF-794 <https://jira.onap.org/browse/AAF-794>`_ Misleading error message in agent.sh
98         - `AAF-773 <https://jira.onap.org/browse/AAF-773>`_ aaf-cass timing issues
99         - `AAF-769 <https://jira.onap.org/browse/AAF-769>`_ AAF CSIT not working
100         - `AAF-727 <https://jira.onap.org/browse/AAF-727>`_ Cert Subject Check confused by Email
101         - `AAF-722 <https://jira.onap.org/browse/AAF-722>`_ aaf continues to be available to aai-resources even though aaf database appears to be down
102         - `AAF-720 <https://jira.onap.org/browse/AAF-720>`_ Docker Images not passing Signal -1
103         - `AAF-645 <https://jira.onap.org/browse/AAF-645>`_ Fix "Null" string for fetching path inside CADI API enforcement filter
104         - `AAF-522 <https://jira.onap.org/browse/AAF-522>`_ rsa 4096 signing fails with TPM
105         - `AAF-813 <https://jira.onap.org/browse/AAF-813>`_ Missing Role for dmaap-bc Identity
106         - `AAF-514 <https://jira.onap.org/browse/AAF-514>`_ TPM Plugin: Remove global structure used for storing session data
107         - `AAF-785 <https://jira.onap.org/browse/AAF-785>`_ non STAGING version on master
108         - `AAF-822 <https://jira.onap.org/browse/AAF-822>`_ Startup issues with K8S, Certs
109
110 **Usage Notes**
111         - AAF Core and SMS elements have consistently started from scratch. The one case where this didn't happen for SMS, 
112                 it was found that incompatible data was left in volume.  Removal of old data for SMS (See SMS notes) should resolve
113         - On the same instance, one AAF Core component had a similar scenario.  A simple bounce of aaf-locator resolved.
114         - Existing Cassandra
115                 - For each release, AAF maintains the authz/auth/auth-cass/cass_init/init.cql which is used to setup Keyspaces from scratch
116                 - Any changes are also done in small CQL files, you MIGHT need authz/auth/auth-cass/cass_init/init2_10.cql for Dublin
117
118
119 Version: 2.1.8 (Casablanca, 3.0.0-ONAP, Casablanca Maintenance Release)
120 --------------------------------------------------------------------------
121
122 Note: AAF did not create new artifacts for Casablanca Maintenance Release.
123
124
125 :Release Date: 2018-11-30
126
127 **New Features**
128
129  - AAF created a local CA and CA Strategy to be utilized for ONAP Test Environments that can instantiated daily, yet have continuity over time and environments. (REAL ONAP instantiations should use their *own* CAs outside of initial tests.)
130  - AAF has auto-creation of configurations and certificates.  This is expected to be done inside an "agent" container, and used by Apps.
131  - AAF stores and creates "Bootstrap Data" for all users of AAF in ONAP.  This simplifies the efforts of ONAP components to organize their Authorizations, and so that various Test Environments can start with correct data every time.
132  - Refactored all of AAF instantiations to use the above, and have consistency between the 5 ways to start AAF.
133  - Ability for CADI Clients to map previous User/Password combinations to current credentials for migration purposes. This is applied to Shiro Plugin as well
134  - CADI Coarse Grain Enforcement Point (Authorize API access). 
135  - Created Backward compatibility features, both for DB (Cassandra) and for API access.
136
137
138 **Bug Fixes**
139         - AAF in OOM was not stable coming out of Beijing.  AAF OOM was refactored using above Container based Configurations.
140         - `AAF-617 <https://jira.onap.org/browse/AAF-617>`_ LOCATE Proxy DELETE not working
141         - `AAF-605 <https://jira.onap.org/browse/AAF-605>`_ DB Stoppage not causing Reset of Connection
142         - `AAF-601 <https://jira.onap.org/browse/AAF-601>`_ Agent "showpass" errors on optional "chal" file, when not exists
143         - `AAF-600 <https://jira.onap.org/browse/AAF-600>`_ Bad Data for APPC in AAF Test Evironment
144         - `AAF-598 <https://jira.onap.org/browse/AAF-598>`_ Inconsistent Startup with truly persistent Cass Data
145         - `AAF-597 <https://jira.onap.org/browse/AAF-597>`_ Please change default appc@appc.onap.org permission
146         - `AAF-592 <https://jira.onap.org/browse/AAF-592>`_ SDNC not able to authenticate with BAth username/password
147         - `AAF-530 <https://jira.onap.org/browse/AAF-530>`_ AAF inside Kubernetes inaccessible for clients from outside
148
149 **Known Issues**
150    N/A
151
152 **Other**
153    - REAL ONAP versus ONAP Test Environment
154      - CA used in ONAP Test Environment should (of course) NOT be used by individual companies in REAL deployments.
155      - Cassandra Instance in Kubernetes ONAP Test environment is a single instance.  REAL deployments should follow global, multi-datacenter deployment strategies per Cassandra recommendations.
156    - AAF team organized all the Identities, all the Credentials, etc, on behalf of ONAP Apps.
157
158 **Security Notes**
159  - AAF has achieved clean scans for everything in authz.git repo
160  - In the cadi.git (used for Adaptors), there is a Shiro adapter.  Shiro itself has security flags, *NOT* the adapter, so understand the security issues of Shiro before use.
161
162  - AAF code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The AAF open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43386201>`_.
163
164
165 **Upgrade Notes**
166   NA
167
168 **Deprecation Notes**
169
170 Version: 2.1.1 (Beijing, 2.0.0-ONAP)
171 --------------------------------------
172
173 :Release Date: 2017-06-05
174
175
176 **New Features:**
177
178  - Service (primary) – All the Authorization information (more on that in a bit)
179  - Locate – how to find ANY OR ALL AAF instances across any geographic distribution
180  - OAuth 2.0 – new component providing Tokens and Introspection (no time to discuss here)
181  - GUI – Tool to view and manage Authorization Information, and create Credentials
182  - Certman – Certificate Manger, create and renew X509 with Fine-Grained Identity
183  - FS – File Server to provide access to distributable elements (like well known certs)
184  - Hello - Test your client access (certs, OAuth 2.0, etc)
185
186 **Bug Fixes**
187    - `AAF-290 <https://jira.onap.org/browse/AAF-290>`_ Fix aaf truststore
188    - `AAF-270 <https://jira.onap.org/browse/AAF-270>`_ AAF fails health check on HEAT deployment
189    - `AAF-286 <https://jira.onap.org/browse/AAF-286>`_ SMS fails health check on OOM deployment
190    - `AAF-273 <https://jira.onap.org/browse/AAF-273>`_ Cassandra pod running over 8G heap - or 10% of ONAP ram (for 135 other pods on 256G 4 node cluster)
191
192    
193 **Known Issues**
194    N/A
195
196 **Other**
197    - REAL ONAP versus ONAP Test Environment
198      - Cassandra Instance in Kubernetes ONAP Test environment is a single instance.  REAL deployments should follow global, multi-datacenter deployment strategies per Cassandra recommendations.
199
200
201 ================
202 Quick Links
203 ================
204         - `AAF project page <https://wiki.onap.org/display/DW/Application+Authorization+Framework+Project>`_
205         - `CII Best Practices Silver Badge information for AAF <https://bestpractices.coreinfrastructure.org/en/projects/2303?criteria_level=1>`_
206         - `CII Best Practices Passing Badge information for AAF <https://bestpractices.coreinfrastructure.org/en/projects/2303?criteria_level=0>`_
207         - `Project Vulnerability Review Table for AAF <https://wiki.onap.org/pages/viewpage.action?pageId=43386201>`_
208
209
210