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