diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sections/installation/AAF_6_running.rst | 54 | ||||
| -rw-r--r-- | docs/sections/release-notes.rst | 12 |
2 files changed, 65 insertions, 1 deletions
diff --git a/docs/sections/installation/AAF_6_running.rst b/docs/sections/installation/AAF_6_running.rst new file mode 100644 index 00000000..a57da6d7 --- /dev/null +++ b/docs/sections/installation/AAF_6_running.rst @@ -0,0 +1,54 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright © 2017 AT&T Intellectual Property. All rights reserved. + +Running AAF +========================= + +The default methodology for running AAF for ONAP is to run as on of the ONAP OOM charts. This allows AAF to be starting in the right order, be available, etc for ONAP Components. + +AAF is very effective as Standalone Java processes, Docker or non OOM Helm Charts, because AAF is an infrastructure component used by ONAP. It is not an integral ONAP Component, +which means that it can be run independently in a number way. From someone's home computer to the extreme Scale and Resilency requirements of Class A Enterprises. + +OOM +--- + +Please see OOM Documentation to run AAF with other ONAP Components + +Helm +---- + +Use git to pull down "authz" code set. Build if desired. + + - Ensure Docker and K8s is install (Minikube is very useful for local machines, see internet) + - Ensure Helm is installed an configured (see internet) + - cd authz/auth/helm + - helm --namespace onap -n dublin install aaf + - Control with kubectl (see K8S/Minikub docs) + + - A sample App that generates all its certificates and configurations automatically is available as "aaf-hello + - helm --namespace onap -n hello install aaf-hello + +Docker +------ + +Use git to pull down "authz" code set. See Build info for Docker. + + - cd authz/auth/docker + - if you need Docker Container, cd ../cass/docker + - bash dinstall.sh + - (note: if you add the word "publish", cqlsh is available for your local apps at port 9042) + + - bash dcqlsh.sh (puts you into CQLSH inside Docker) + - docker container exec -it aaf-cass bash -c "cqlsh -k authz --request-timeout=60" + - bash dbash.sh (short cut to get you a Shell in the "cass" container) + + - all the d...sh scripts utilize short-cut names. + - "cass" is actually aaf-cass in Docker, "service" is actually aaf-service in Docker + + - dbuild.sh (builds new Docker Containers, see Build) + - dclean.sh (cleans out Docker Containers, getting ready for a new build) + - drun.sh <blank|shortcut name> (Creates and Starts Container for all or one AAF components) + - dstop.sh <blank|shortcut name> (Stops Container for all or one AAF Components) + - dstart.sh <blank|shortcut name> (Use when container exists for all or one AAF Components) + diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst index 4e6fcbd0..dbe794ff 100644 --- a/docs/sections/release-notes.rst +++ b/docs/sections/release-notes.rst @@ -2,7 +2,6 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright © 2017 AT&T Intellectual Property. All rights reserved. - Release Notes ============= @@ -38,6 +37,15 @@ Note: In general, Infrastructure must be accomplished in the release PRIOR to ge - `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 +**Usage Notes** + - AAF Core and SMS elements have consistently started from scratch. The one case where this didn't happen for SMS, + it was found that incompatible data was left in volume. Removal of old data for SMS (See SMS notes) should resolve + - On the same instance, one AAF Core component had a similar scenario. A simple bounce of aaf-locator resolved. + - Existing Cassandra + - For each release, AAF maintains the authz/auth/auth-cass/cass_init/init.cql which is used to setup Keyspaces from scratch + - Any changes are also done in small CQL files, you MIGHT need authz/auth/auth-cass/cass_init/init2_10.cql for Dublin + + Version: 2.1.8 (Casablanca, 3.0.0-ONAP, Casablanca Maintenance Release) -------------------------------------------------------------------------- @@ -130,3 +138,5 @@ Version: 2.1.1 (Beijing, 2.0.0-ONAP) - `CII Best Practices Passing Badge information for AAF <https://bestpractices.coreinfrastructure.org/en/projects/2303?criteria_level=0>`_ - `Project Vulnerability Review Table for AAF <https://wiki.onap.org/pages/viewpage.action?pageId=43385140>`_ + + |