update Release Notes and Doc Issue
[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
6 Release Notes
7 =============
8
9 Version: 2.1.13 (Dublin, 3.1.0-ONAP)
10 ---------------------------------------
11
12 :Release Date: 2019-06-06
13
14 **New Features**
15
16 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.
17
18         - 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
19         - AAF has the ability to publish both Public and Internal Private K8s Service information (Locator)
20         - Greatly Reduced size of Docker Images
21         - Greatly enhanced startup procedures in K8s, to more cleanly start, with Certificate, Property Generation every time
22         - Ability to run internally as non-root (fully setup K8s in El Alto)
23         - Removal of unused classes in Batch
24         - Large improvement in Batch and methodology, to be used in El Alto
25
26 **Bug Fixes**
27         - `AAF-797 <https://jira.onap.org/browse/AAF-797>`_ Update IP address for aaf-onap-test.osaaf.org
28         - `AAF-794 <https://jira.onap.org/browse/AAF-794>`_ Misleading error message in agent.sh
29         - `AAF-773 <https://jira.onap.org/browse/AAF-773>`_ aaf-cass timing issues
30         - `AAF-769 <https://jira.onap.org/browse/AAF-769>`_ AAF CSIT not working
31         - `AAF-727 <https://jira.onap.org/browse/AAF-727>`_ Cert Subject Check confused by Email
32         - `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
33         - `AAF-720 <https://jira.onap.org/browse/AAF-720>`_ Docker Images not passing Signal -1
34         - `AAF-645 <https://jira.onap.org/browse/AAF-645>`_ Fix "Null" string for fetching path inside CADI API enforcement filter
35         - `AAF-522 <https://jira.onap.org/browse/AAF-522>`_ rsa 4096 signing fails with TPM
36         - `AAF-813 <https://jira.onap.org/browse/AAF-813>`_ Missing Role for dmaap-bc Identity
37         - `AAF-514 <https://jira.onap.org/browse/AAF-514>`_ TPM Plugin: Remove global structure used for storing session data
38         - `AAF-785 <https://jira.onap.org/browse/AAF-785>`_ non STAGING version on master
39         - `AAF-822 <https://jira.onap.org/browse/AAF-822>`_ Startup issues with K8S, Certs
40
41 Version: 2.1.8 (Casablanca, 3.0.0-ONAP, Casablanca Maintenance Release)
42 --------------------------------------------------------------------------
43
44 Note: AAF did not create new artifacts for Casablanca Maintenance Release.
45
46
47 :Release Date: 2018-11-30
48
49 **New Features**
50
51  - 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.)
52  - AAF has auto-creation of configurations and certificates.  This is expected to be done inside an "agent" container, and used by Apps.
53  - 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.
54  - Refactored all of AAF instantiations to use the above, and have consistency between the 5 ways to start AAF.
55  - Ability for CADI Clients to map previous User/Password combinations to current credentials for migration purposes. This is applied to Shiro Plugin as well
56  - CADI Coarse Grain Enforcement Point (Authorize API access). 
57  - Created Backward compatibility features, both for DB (Cassandra) and for API access.
58
59
60 **Bug Fixes**
61         - AAF in OOM was not stable coming out of Beijing.  AAF OOM was refactored using above Container based Configurations.
62         - `AAF-617 <https://jira.onap.org/browse/AAF-617>`_ LOCATE Proxy DELETE not working
63         - `AAF-605 <https://jira.onap.org/browse/AAF-605>`_ DB Stoppage not causing Reset of Connection
64         - `AAF-601 <https://jira.onap.org/browse/AAF-601>`_ Agent "showpass" errors on optional "chal" file, when not exists
65         - `AAF-600 <https://jira.onap.org/browse/AAF-600>`_ Bad Data for APPC in AAF Test Evironment
66         - `AAF-598 <https://jira.onap.org/browse/AAF-598>`_ Inconsistent Startup with truly persistent Cass Data
67         - `AAF-597 <https://jira.onap.org/browse/AAF-597>`_ Please change default appc@appc.onap.org permission
68         - `AAF-592 <https://jira.onap.org/browse/AAF-592>`_ SDNC not able to authenticate with BAth username/password
69         - `AAF-530 <https://jira.onap.org/browse/AAF-530>`_ AAF inside Kubernetes inaccessible for clients from outside
70
71 **Known Issues**
72    N/A
73
74 **Other**
75    - REAL ONAP versus ONAP Test Environment
76      - CA used in ONAP Test Environment should (of course) NOT be used by individual companies in REAL deployments.
77      - Cassandra Instance in Kubernetes ONAP Test environment is a single instance.  REAL deployments should follow global, multi-datacenter deployment strategies per Cassandra recommendations.
78    - AAF team organized all the Identities, all the Credentials, etc, on behalf of ONAP Apps.
79
80 **Security Notes**
81  - AAF has achieved clean scans for everything in authz.git repo
82  - 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.
83
84  - 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>`_.
85
86 **Quick Links:**
87         - `AAF project page <https://wiki.onap.org/display/DW/Application+Authorization+Framework+Project>`_
88         - `CII Best Practices Silver Badge information for AAF <https://bestpractices.coreinfrastructure.org/en/projects/2303?criteria_level=1>`_
89         - `CII Best Practices Passing Badge information for AAF <https://bestpractices.coreinfrastructure.org/en/projects/2303?criteria_level=0>`_
90         - `Project Vulnerability Review Table for AAF <https://wiki.onap.org/pages/viewpage.action?pageId=43386201>`_
91
92 **Upgrade Notes**
93   NA
94
95 **Deprecation Notes**
96
97 Version: 2.1.1 (Beijing, 2.0.0-ONAP)
98 --------------------------------------
99
100 :Release Date: 2017-06-05
101
102
103 **New Features:**
104
105  - Service (primary) – All the Authorization information (more on that in a bit)
106  - Locate – how to find ANY OR ALL AAF instances across any geographic distribution
107  - OAuth 2.0 – new component providing Tokens and Introspection (no time to discuss here)
108  - GUI – Tool to view and manage Authorization Information, and create Credentials
109  - Certman – Certificate Manger, create and renew X509 with Fine-Grained Identity
110  - FS – File Server to provide access to distributable elements (like well known certs)
111  - Hello - Test your client access (certs, OAuth 2.0, etc)
112
113 **Bug Fixes**
114    - `AAF-290 <https://jira.onap.org/browse/AAF-290>`_ Fix aaf truststore
115    - `AAF-270 <https://jira.onap.org/browse/AAF-270>`_ AAF fails health check on HEAT deployment
116    - `AAF-286 <https://jira.onap.org/browse/AAF-286>`_ SMS fails health check on OOM deployment
117    - `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)
118
119    
120 **Known Issues**
121    N/A
122
123 **Other**
124    - REAL ONAP versus ONAP Test Environment
125      - Cassandra Instance in Kubernetes ONAP Test environment is a single instance.  REAL deployments should follow global, multi-datacenter deployment strategies per Cassandra recommendations.
126
127
128 **Quick Links:**
129         - `AAF project page <https://wiki.onap.org/display/DW/Application+Authorization+Framework+Project>`_
130         - `CII Best Practices Passing Badge information for AAF <https://bestpractices.coreinfrastructure.org/en/projects/2303?criteria_level=0>`_
131         - `Project Vulnerability Review Table for AAF <https://wiki.onap.org/pages/viewpage.action?pageId=43385140>`_
132