Code Review / oom.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
[COMMON] Bump ONAP version
[oom.git] / docs / oom_user_guide.rst
diff --git a/docs/oom_user_guide.rst b/docs/oom_user_guide.rst
index 0835a93..2ff74b5 100644 (file)
--- a/docs/oom_user_guide.rst
+++ b/docs/oom_user_guide.rst
@@ -123,7 +123,7 @@ stable which should be removed to avoid confusion::
 
 To prepare your system for an installation of ONAP, you'll need to::
 
-  > git clone -b jakarta --recurse-submodules -j2 http://gerrit.onap.org/r/oom
+  > git clone -b kohn --recurse-submodules -j2 http://gerrit.onap.org/r/oom
   > cd oom/kubernetes
 
 
@@ -161,12 +161,12 @@ system, and looks for matches::
 
   > helm search repo local
   NAME                    VERSION    DESCRIPTION
-  local/appc              10.0.0     Application Controller
-  local/clamp             10.0.0     ONAP Clamp
-  local/common            10.0.0     Common templates for inclusion in other charts
-  local/onap              10.0.0     Open Network Automation Platform (ONAP)
-  local/robot             10.0.0     A helm Chart for kubernetes-ONAP Robot
-  local/so                10.0.0     ONAP Service Orchestrator
+  local/appc              11.0.0     Application Controller
+  local/clamp             11.0.0     ONAP Clamp
+  local/common            11.0.0     Common templates for inclusion in other charts
+  local/onap              11.0.0     Open Network Automation Platform (ONAP)
+  local/robot             11.0.0     A helm Chart for kubernetes-ONAP Robot
+  local/so                11.0.0     ONAP Service Orchestrator
 
 In any case, setup of the Helm repository is a one time activity.
 
@@ -209,7 +209,7 @@ deployment::
 To install a specific version of a single ONAP component (`so` in this example)
 with the given release name enter::
 
-  > helm deploy so onap/so --version 10.0.0 --set global.masterPassword=password --set global.flavor=unlimited --namespace onap
+  > helm deploy so onap/so --version 11.0.0 --set global.masterPassword=password --set global.flavor=unlimited --namespace onap
 
 .. note::
    The dependent components should be installed for component being installed
@@ -333,7 +333,7 @@ Here is an excerpt of this file:
   dependencies:
   <...>
     - name: so
-      version: ~10.0.0
+      version: ~11.0.0
       repository: '@local'
       condition: so.enabled
   <...>
@@ -404,7 +404,7 @@ corresponds to the private IP as follows::
   portal-app  LoadBalancer   10.43.142.201   10.0.0.4   8989:30215/TCP,8006:30213/TCP,8010:30214/TCP   1d   app=portal-app,release=dev
 
 
-In this example, use the 10.0.0.4 private address as a key find the
+In this example, use the 11.0.0.4 private address as a key find the
 corresponding public address which in this example is 10.12.6.155. If you're
 using OpenStack you'll do the lookup with the horizon GUI or the OpenStack CLI
 for your tenant (openstack server list).  That IP is then used in your
@@ -563,10 +563,10 @@ Below is the example for the same::
 
   > helm list
     NAME                    REVISION        UPDATED                         STATUS          CHART                   APP VERSION     NAMESPACE
-    dev                     1               Wed Oct 14 13:49:52 2020        DEPLOYED        onap-10.0.0             Jakarta          onap
-    dev-cassandra           5               Thu Oct 15 14:45:34 2020        DEPLOYED        cassandra-10.0.0                         onap
-    dev-contrib             1               Wed Oct 14 13:52:53 2020        DEPLOYED        contrib-10.0.0                           onap
-    dev-mariadb-galera      1               Wed Oct 14 13:55:56 2020        DEPLOYED        mariadb-galera-10.0.0                    onap
+    dev                     1               Wed Oct 14 13:49:52 2020        DEPLOYED        onap-11.0.0             Kohn          onap
+    dev-cassandra           5               Thu Oct 15 14:45:34 2020        DEPLOYED        cassandra-11.0.0                         onap
+    dev-contrib             1               Wed Oct 14 13:52:53 2020        DEPLOYED        contrib-11.0.0                           onap
+    dev-mariadb-galera      1               Wed Oct 14 13:55:56 2020        DEPLOYED        mariadb-galera-11.0.0                    onap
 
 Here the Name column shows the RELEASE NAME, In our case we want to try the
 scale operation on cassandra, thus the RELEASE NAME would be dev-cassandra.
@@ -580,10 +580,10 @@ Below is the example for the same::
 
   > helm search cassandra
     NAME                    CHART VERSION   APP VERSION     DESCRIPTION
-    local/cassandra         10.0.0                          ONAP cassandra
-    local/portal-cassandra  10.0.0                          Portal cassandra
-    local/aaf-cass          10.0.0                          ONAP AAF cassandra
-    local/sdc-cs            10.0.0                          ONAP Service Design and Creation Cassandra
+    local/cassandra         11.0.0                          ONAP cassandra
+    local/portal-cassandra  11.0.0                          Portal cassandra
+    local/aaf-cass          11.0.0                          ONAP AAF cassandra
+    local/sdc-cs            11.0.0                          ONAP Service Design and Creation Cassandra
 
 Here the Name column shows the chart name. As we want to try the scale
 operation for cassandra, thus the corresponding chart name is local/cassandra
@@ -645,7 +645,7 @@ Prior to doing an upgrade, determine of the status of the deployed charts::
 
   > helm list
   NAME REVISION UPDATED                  STATUS    CHART     NAMESPACE
-  so   1        Mon Feb 5 10:05:22 2020  DEPLOYED  so-10.0.0 onap
+  so   1        Mon Feb 5 10:05:22 2020  DEPLOYED  so-11.0.0 onap
 
 When upgrading a cluster a parameter controls the minimum size of the cluster
 during the upgrade while another parameter controls the maximum number of nodes
@@ -668,21 +668,21 @@ sequence of events described in the previous paragraph would be initiated.
 For example, to upgrade a container by changing configuration, specifically an
 environment value::
 
-  > helm upgrade so onap/so --version 8.0.1 --set enableDebug=true
+  > helm upgrade so onap/so --version 11.0.1 --set enableDebug=true
 
 Issuing this command will result in the appropriate container being stopped by
 Kubernetes and replaced with a new container with the new environment value.
 
 To upgrade a component to a new version with a new configuration file enter::
 
-  > helm upgrade so onap/so --version 8.0.1 -f environments/demo.yaml
+  > helm upgrade so onap/so --version 11.0.1 -f environments/demo.yaml
 
 To fetch release history enter::
 
   > helm history so
   REVISION UPDATED                  STATUS     CHART     DESCRIPTION
-  1        Mon Feb 5 10:05:22 2020  SUPERSEDED so-9.0.0  Install complete
-  2        Mon Feb 5 10:10:55 2020  DEPLOYED   so-10.0.0 Upgrade complete
+  1        Mon Jul 5 10:05:22 2022  SUPERSEDED so-11.0.0 Install complete
+  2        Mon Jul 5 10:10:55 2022  DEPLOYED   so-11.0.1 Upgrade complete
 
 Unfortunately, not all upgrades are successful.  In recognition of this the
 lineup of pods within an ONAP deployment is tagged such that an administrator
@@ -704,9 +704,9 @@ For example, to roll-back back to previous system revision enter::
 
   > helm history so
   REVISION UPDATED                  STATUS     CHART     DESCRIPTION
-  1        Mon Feb 5 10:05:22 2020  SUPERSEDED so-9.0.0  Install complete
-  2        Mon Feb 5 10:10:55 2020  SUPERSEDED so-10.0.0 Upgrade complete
-  3        Mon Feb 5 10:14:32 2020  DEPLOYED   so-9.0.0  Rollback to 1
+  1        Mon Jul 5 10:05:22 2022  SUPERSEDED so-11.0.0 Install complete
+  2        Mon Jul 5 10:10:55 2022  SUPERSEDED so-11.0.1 Upgrade complete
+  3        Mon Jul 5 10:14:32 2022  DEPLOYED   so-11.0.0 Rollback to 1
 
 .. note::
 
Introduces the ONAP Platform OOM (ONAP Operations Manager) to efficiently Deploy, Manage, Operate the ONAP platform and its components (e.g. MSO, DCAE, SDC, etc.) and infrastructure (VMs, Containers).