diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sections/installation/AAF_3.1_build.rst | 61 | ||||
| -rw-r--r-- | docs/sections/release-notes.rst | 32 |
2 files changed, 65 insertions, 28 deletions
diff --git a/docs/sections/installation/AAF_3.1_build.rst b/docs/sections/installation/AAF_3.1_build.rst index ec49c72b..750412a6 100644 --- a/docs/sections/installation/AAF_3.1_build.rst +++ b/docs/sections/installation/AAF_3.1_build.rst @@ -38,31 +38,33 @@ Docker Mode After you have successfully run maven, you will need a Cassandra. If you don't have one, here are instructions for a Docker Standalone Cassandra. For a *serious* endeavor, you need a multi-node Cassandra. -From "authz":: +----------------------------- +Existing Cassandra Instance +----------------------------- - $ cd auth/auth-cass/src/main/cql - $ vi config.dat +When AAF modifies or adds a Cassandra Table, it is entered in two places: + - COMPLETE Table Schemes for Startup: authz/auth/auth-cass/cass_init/init.cql + - INCREMENTAL Table Schemes for Existing AAF Setups: authz/auth/auth-cass/cass_init/init<Interface Version>.cql ------------------- -Existing Cassandra ------------------- - -AAF Casablanca has added a table. If you have an existing AAF Cassandra, do the following *ONCE* : - -### If Container Cassandra, add these steps, otherwise, skip -$ docker container cp init2_1.cql aaf_cass:/tmp +### As an example, Assume interface change of "2_10" AND you have an existing Cassandra, add these steps, otherwise, skip +$ docker container cp init2_10.cql aaf_cass:/tmp $ docker exec -it aaf_cass bash (docker) $ cd /tmp ### -$ cqlsh -f 'init2_1.cql' +$ cqlsh -f 'init2_10.cql' -------------------- New Docker Cassandra -------------------- Assuming you are in your src/authz directory:: -$ cd auth/auth-cass/docker -$ bash dinstall.sh +| $ cd auth/auth-cass/docker +| $ bash dinstall.sh + +FOR DEVELOPMENT: +Normally, Cassandra in Containers are NOT published external to Docker for security exposure reasons. HOWEVER, you can do the above as follows and then be able to access the DB while coding, debugging, etc:: + +| $ bash dinstall.sh publish --------------------- AAF Itself @@ -74,21 +76,13 @@ Assuming you are in your src/authz directory:: | ### If you have not done so before (don't overwrite your work!) | $ cp d.props.init d.props -You will need to edit and fill out the information in your d.props file. Here is info to help +Adjust for ACTUAL AAF version if required. -**Local Env info** - These are used to load the /etc/hosts file in the Containers, so AAF is available internally and externally +There are two special scripts created. + - "aaf.sh" - The script that creates and accesses AAF's Configuration information. It uses "d.props" + - "agent.sh" - A script for use by MSs OTHER than AAF (i.e. aai) for creating AAF Configuration. It uses "aaf.props". (note, need to have AAF running to generate Certificates) - =============== ============= - Variable Explanation - =============== ============= - HOSTNAME This must be the EXTERNAL FQDN of your host. Must be in DNS or /etc/hosts - HOST_IP This must be the EXTERNAL IP of your host. Must be accessible from "anywhere" - CASS_HOST If Docker Cass, this is the INTERNAL FQDN/IP. If external Cass, then DNS|/etc/hosts entry - aaf_env This shows up in GUI and certs, to differentiate environments - aaf_register_as As pre-set, it is the same external hostname. - cadi_latitude Use "https://bing.com/maps", if needed, to locate your current Global Coords - cadi_longitude ditto - =============== ============= +In BOTH cases, the scripts will ask for Properties required that are not in the current d.props or ------------------------------ "Bleeding Edge" Source install @@ -100,3 +94,16 @@ AAF can be built, and local Docker Images built with the following:: Otherwise, just let it pull from Nexus +------------------------------ +Other Scripts +------------------------------ +The following will act on ALL possible AAF instances if there are no Params. You can apply to only ONE MS by adding short name i.e. "service" instead of "aaf_service" + - drun.sh - starts up Docker FRESH instances of AAF locally (not K8s) + - dstop.sh - stops Docker instances of AAF locally + - dclean.sh - cleans up containers in Docker so you can do "dbuild.sh" (above) and start fresh + - dstart.sh - starts Docker containers that were previously stopped... Doesn't refresh actual container. + - dbounce.sh - stops and starts in one method + + + + diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst index 497cc9eb..4e6fcbd0 100644 --- a/docs/sections/release-notes.rst +++ b/docs/sections/release-notes.rst @@ -6,10 +6,40 @@ Release Notes ============= +Version: 2.1.13 (Dublin, 3.1.0-ONAP) +--------------------------------------- +:Release Date: 2019-06-06 + +**New Features** + +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. + + - 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 + - AAF has the ability to publish both Public and Internal Private K8s Service information (Locator) + - Greatly Reduced size of Docker Images + - Greatly enhanced startup procedures in K8s, to more cleanly start, with Certificate, Property Generation every time + - Ability to run internally as non-root (fully setup K8s in El Alto) + - Removal of unused classes in Batch + - Large improvement in Batch and methodology, to be used in El Alto + +**Bug Fixes** + - `AAF-797 <https://jira.onap.org/browse/AAF-797>`_ Update IP address for aaf-onap-test.osaaf.org + - `AAF-794 <https://jira.onap.org/browse/AAF-794>`_ Misleading error message in agent.sh + - `AAF-773 <https://jira.onap.org/browse/AAF-773>`_ aaf-cass timing issues + - `AAF-769 <https://jira.onap.org/browse/AAF-769>`_ AAF CSIT not working + - `AAF-727 <https://jira.onap.org/browse/AAF-727>`_ Cert Subject Check confused by Email + - `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 + - `AAF-720 <https://jira.onap.org/browse/AAF-720>`_ Docker Images not passing Signal -1 + - `AAF-645 <https://jira.onap.org/browse/AAF-645>`_ Fix "Null" string for fetching path inside CADI API enforcement filter + - `AAF-522 <https://jira.onap.org/browse/AAF-522>`_ rsa 4096 signing fails with TPM + - `AAF-813 <https://jira.onap.org/browse/AAF-813>`_ Missing Role for dmaap-bc Identity + - `AAF-514 <https://jira.onap.org/browse/AAF-514>`_ TPM Plugin: Remove global structure used for storing session data + - `AAF-785 <https://jira.onap.org/browse/AAF-785>`_ non STAGING version on master + - `AAF-822 <https://jira.onap.org/browse/AAF-822>`_ Startup issues with K8S, Certs Version: 2.1.8 (Casablanca, 3.0.0-ONAP, Casablanca Maintenance Release) ----------------------------------------- +-------------------------------------------------------------------------- Note: AAF did not create new artifacts for Casablanca Maintenance Release. |