Merge "Add jenkins jobs for automatic reporting dashboard deployment"

[releng.git] / prototypes / xci / README.rst

diff --git a/prototypes/xci/README.rst b/prototypes/xci/README.rst
index 8318cdb..ecb8e19 100644 (file)
--- a/prototypes/xci/README.rst
+++ b/prototypes/xci/README.rst
@@ -113,11 +113,17 @@ change into directory where the sandbox script is located
 
 execute sandbox script
 
-    sudo -E ./xci-deploy.sh
+    ./xci-deploy.sh
 
 Issuing above command will start aio sandbox deployment and the sandbox
 should be ready between 1,5 and 2 hours depending on the host machine.
 
+Please remember that the user executing the XCI script will need to
+have an ssh key available, and stored in $HOME/.ssh directory.
+You can generate one by executing
+
+    ssh-keygen -t rsa
+
 Advanced Usage
 --------------
 
@@ -148,13 +154,7 @@ set where the logs should be stored
 
 execute sandbox script
 
-    sudo -E ./xci-deploy.sh
-
-Warning::
-
-    Please encure you always execute the sandbox script using **sudo -E**
-    in order to make the environment variables you set available to the
-    sandbox script or you end up with the default settings.
+    ./xci-deploy.sh
 
 ===============
 User Variables
@@ -185,6 +185,25 @@ continuously chasing the HEAD of corresponding branches.
 Once a working version is identified, the versions of the upstream components
 are then bumped in releng repo.
 
+==================
+XCI developer tips
+==================
+
+It is possible to run XCI in development mode, in order to test the
+latest changes. When deploying on this mode, the script will use the working
+directories for releng/bifrost/OSA, instead of cloning the whole repositories
+on each run.
+To enable it, you need to export the different DEV_PATH vars:
+
+- export OPNFV_RELENG_DEV_PATH=/opt/releng/
+- export OPENSTACK_BIFROST_DEV_PATH=/opt/bifrost/
+- export OPENSTACK_OSA_DEV_PATH=/opt/openstack-ansible/
+
+Please note the trailing slahses.
+
+This will cause the deployment to pick the development copies stored at the
+specified directories, and use them instead of cloning those on every run.
+
 ===========================================
 Limitations, Known Issues, and Improvements
 ===========================================