[VVP] README added more details on how to use

Change-Id: I732b17181de39afdb99da77eac15b6ac182b0a25
Issue-ID: VVP-78
Signed-off-by: stark, steven <ss820f@att.com>

1 files changed, 26 insertions, 5 deletions

diff --git a/README.md b/README.md
index ec05d39..4f09f95 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,9 @@ Vagrant :      1.9.4
 VirtualBox:    5.1.14
 OS:            OS X 10.13.3
 
+If you are using kubectl version 1.10.0, you will need to change the
+k8s_version to "v1.7.16_coreos.0" in zones/development/inventory/group_vars/bootstrap.yml
+
 ## Installation ##
 
 Add the following line into your local hosts file:
@@ -53,6 +56,12 @@ After the above deploy, it can take around 30 minutes for everything to finish.
 
 To access the ICE dashboard, go to https://10.220.220.12/#/
 
+To access the gitlab dashboard, go to
+http://10.252.0.12/
+
+To access the Jenkins dashbaord, go to 
+http://10.252.0.12:8080
+
 Also recommended to setup port forwarding for port 22 on the coreos box
 
 ## USER GUIDE ##
@@ -64,15 +73,27 @@ To create an account
 - login to your new account
 - Add a public ssh key your profile
 
-Before creating an engagement, you need to configure the jenkins container
+Before creating an engagement, you need to manually configure the jenkins container
 - login as root to the running jenkins container
 $ docker exec -it -u root <jenkins container id> "/bin/sh"
 - add 10.252.0.12 dev-git.vvp.example.com to /etc/hosts
 
+From here, you have two options to setup the Jenkins validation script
+1) If you are running locally and gitlab is not accessible from the internet, 
+you can stop here and once a repo is created in gitlab you can mark it public.
+2) If you need to keep the heat template repos private, you can modify /usr/local/bin/ice-testengine to use authentication
+http://$domain/$repo" master change to http://<administrator username>:<administrator password>@$domain/$repo" master
+- administrator username by default is root. gitlab_admin_password is in the unencrypted vault file.
+
+At this point, users can login to the ICE portal and create engagements.
+
 Once an engagement has been created with your new user, it will create a corresponding project in gitlab.
-- login to gitlab (http://10.252.0.12/) WITH THE ADMIN credentials
-- add your new user to the new project that was created in the previous step
-- in gitlab, authentication via ssh between test-engine and gitlab may not be working. recommended for local builds to set gitlab project to public access. BE AWARE if youre not using a private instance, this could allow anyone to see the uploaded heat templates.
+
+- login to gitlab WITH THE ADMIN credentials
+- You can grab the link that a user will need to clone and upload heat templates. Most likely ssh will not work, only http.
+- In the previous step when you set up the jenkins container,
+If you did not add authentication to the ice-testengine script, you need to mark the repo public.
+BE AWARE if youre not using a private instance, this could allow anyone to see the uploaded heat templates.
 - clone the repo. Cloning may only work over http.
 - add your heat templates and commit them to the repo
 - This will start a jenkins job to validate your templates, and results will be posted to the portal once complete.
@@ -80,7 +101,7 @@ Once an engagement has been created with your new user, it will create a corresp
 Login to the Engagement Manager portal as an administrator
 - move engagement along
 - check heat tempalte validation status
-- apporve, reject, check jenkins logs
+- approve, reject, check jenkins logs, etc...
 
 ```