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