Adding clarifications regarding slicing (diagram), VIM management network, and other details.

magma/README.md

@@ -2,18 +2,27 @@
 
 ## Diagram
 
-![osm9hackfest_diagram](/uploads/9d9d85dc23d87ae30de57115b413388b/Screen_Shot_2020-05-23_at_17.27.58.png)
+![magma_slice](/uploads/76612f8c01faf8458adf568ac1e7f92a/magma_slice.png)
+
+## Sandbox
+
+A sandbox ready for testing is available, please check the osm9-hackfest9 Slack channel for passwords.
+- OSM Instance at: hackfest@172.21.248.19 (~/osm-packages/magma is synced with this repo), which has a PNF and the required "sgi" network already shared.
+- K8sCluster at: hackfest@172.21.248.18
+- OpenStack tenant at: http://172.21.247.1 ("hackfest" user/tenant)
+
+Request your own user to run advanced tests.
 
 ## Preparation
 
 This example requires a PNF, emulated with a VyOS router (image [here](http://osm-download.etsi.org/ftp/osm-6.0-six/7th-hackfest/images/vyos-1.1.7-cloudinit.qcow2.tgz)), connected to a shared management network (osm-ext in this example) and to a shared internal "sgi" network where the Slice will be placed.
 
-**Important note**: a sandbox ready for testing is available at hackfest@172.21.248.19 (~/osm-packages/magma is synced with this repo), which has a PNF and the required "sgi" network already shared.
-
-1. If you just cloned the repo, make sure you run `git submodule update --init` under every "charms" folder.
+1. If you just cloned the repo, make sure you run `git submodule update --init` under the osm-packages folder.
+1. Make sure you add a VIM that has a default management network, for example: `osm vim-create ... --config='{management_network_name: <vim mgmt-net name>}'`
 1. Add the PDU with the yaml file (emulated by a VyOS VM in this environment). You can do it with `osm pdu-create --descriptor_file pdu.yaml` (editing at least the VIM ID first)
+1. Add your K8s Cluster to the VIM.
 1. Upload the packages to OSM, the "build_slice.sh" file contain some useful commands, from building to launching.
-1. Make sure you got the images for AGW and srsLTE emulator, available at ETSI VIM or at the hackfest@172.21.248.19 home directory.
+1. Make sure you got the images for AGW and srsLTE emulator available at ETSI VIM or at the hackfest@172.21.248.19 home directory.
 
 ## Launching the Slice
 
@@ -68,7 +77,7 @@ A second slice, reusing the same Orc8r, can be launched at different VIM. The pr
 1. Copy the files to the placement folder at PLA:
    `docker cp vnf_price_list.yaml $(docker ps -qf name=osm_pla):/placement/.`
    `docker cp pil_price_list.yaml $(docker ps -qf name=osm_pla):/placement/.`
-1. Uncomment the placement-engine line and launch as usual! you should see the second slice being instantiated in the second VIM.
+1. Uncomment the placement-engine line and launch as usual! you should see the second slice being instantiated in the second VIM (WIP: Failing due to "NoWimConnectedToDatacenters" error)
 
 ### Metrics collection
 
@@ -76,6 +85,7 @@ VIM-level metrics are being collected by default, they can be observed at the Gr
 
 ## Pending additions
 
+- Fix placement and test multi-tenancy
 - Navigating from a desktop browser (VNC not working properly)
 - Automatic and manual scaling
 - KNF Primitives (via additional Webhost NS that will be added)