Fix code-blocks formatting, headings and grammar 41/23141/2
authorMatthewHarffy <Matthew.harffy@amdocs.com>
Fri, 10 Nov 2017 17:02:36 +0000 (17:02 +0000)
committerVenkata Harish K Kajur <vk250x@att.com>
Fri, 10 Nov 2017 19:53:00 +0000 (14:53 -0500)
Cleaned up and added code-blocks and headings.

Change-Id: I2f9c4344b6b5d82c2f10d7e2db40225e5176ba9f
Issue-ID: DOC-114
Signed-off-by: MatthewHarffy <Matthew.harffy@amdocs.com>
docs/platform/Getting Started/How_to_AAI_data_snapshot_and_restore_in_ONAP_1_1.rst

index 004a0c9..90ceabc 100644 (file)
@@ -2,45 +2,49 @@
    :depth: 3
 ..
 
-How to A&AI data snapshot and restore in ONAP 1.1
-=================================================
+How to create a snapshot and restore AAI data in ONAP 1.1
+==========================================================
 
-1. Check the containers that are running and get the container name for
-   resources micro service as this container contains both dataSnapshot
-   and restore scripts
+1. Check the containers that are running and get the container name for the resources microservice, as this container contains both the data snapshot and restore scripts.
 
-2. If the deployment was followed properly, then the container name
-   would have been
-   testconfig\_aai-resources.api.simpledemo.openecomp.org\_1
+2. If the deployment was followed properly, then the container name will be:
+
+   .. code-block:: bash
+
+    testconfig\_aai-resources.api.simpledemo.openecomp.org\_1
 
 3. Run the following command to save the current snapshot of your data:
 
+   .. code-block:: bash
+   
     docker exec -u aaiadmin -it
     testconfig\_aai-resources.api.simpledemo.openecomp.org\_1
     /opt/app/aai-resources/bin/dataSnapshot.sh
 
-1. After running that command, you should see the following line in the
-   standard output:
+4. After running that command, you should see the following line in the standard output:
+
+   .. code:: bash
 
     Snapshot written to
     /opt/app/aai-resources/logs/data/dataSnapshots/dataSnapshot.graphSON.201709221713
 
-1. This file dataSnapshot.graphSON.201709221713 can be found in
-   /opt/aai/logroot/AAI-RESOURCES/data/dataSnapshots on the host vm
+The snapshot location
+---------------------
+
+The file dataSnapshot.graphSON.201709221713 can be found in **/opt/aai/logroot/AAI-RESOURCES/data/dataSnapshots** on the host vm.
+
+Restoring data form the snapshot
+--------------------------------
+
+1. To restore the data from the snapshot, run this command:
 
-2. If you want to restore the data from the snapshot, then you would run
-   this command:
+   .. code-block:: bash
 
     docker exec -u aaiadmin -it
     testconfig\_aai-resources.api.simpledemo.openecomp.org\_1
     /opt/app/aai-resources/bin/dataRestoreFromSnapshot.sh
     dataSnapshot.graphSON.201709221713
 
-1. The argument to the dataRestoreFromSnapshot.sh is the dataSnapshot
-   graphson file and it only needs the base name and expects to be found
-   in the host vm /opt/aai/logroot/AAI-RESOURCES/data/dataSnapshots.
+   The argument to the dataRestoreFromSnapshot.sh is the dataSnapshot graphson file and it only needs the base name and expects to be found in the host vm **/opt/aai/logroot/AAI-RESOURCES/data/dataSnapshots**.
 
-2. Once that command is run, you will be given a warning of 5 seconds to
-   quit the process as it will replace whatever you have in your A&AI
-   data with that snapshot and any current data thats not saved into a
-   snapshot will be lost.
+2. Once the command has run, you will be given a warning of 5 seconds to quit the process, as it will replace whatever you have in your AAI data with the snapshot and **any current data that is not saved into a snapshot will be lost**.