X-Git-Url: https://gerrit.akraino.org/r/gitweb?a=blobdiff_plain;f=ci%2FREADME.md;h=94fe85a89c460bb22e50bd5fec73f843da3a5dfc;hb=71cde293d4753a07a5da01f410a7c3f94b600ace;hp=5e3e4446457a8d906c87218927f16e6d5b80dea0;hpb=d97c464fe4c7ae16385bf101405a1f1f6a2dcb09;p=icn.git

diff --git a/ci/README.md b/ci/README.md
index 5e3e444..94fe85a 100644
--- a/ci/README.md
+++ b/ci/README.md
@@ -25,17 +25,38 @@ Once the playbook is successful, we can visite the jenkins server at http://<lis
 ## What to do next
 
 1. Add the gerrit ssh key as jenkins credential, so that our jobs can pull code from the gerrit.
-The credential ID field must be `jenkins-ssh`. As this is hard coded in the jobs.
+The credential ID field must be `jenkins-ssh`, as this is hard coded in the jobs. The type should
+be private key. The user name is the gerrit account name.
 2. To push the logs to Akraino Nexus server, we need to create the authentication file for lftools.
-The file path is `/var/lib/jenkins/.netrc` and the content should be one line
-`machine nexus.akraino.org login the_name password the_pass`
+The file should be owned by jenkins user. The file path is `/var/lib/jenkins/.netrc` and
+the content should be one line `machine nexus.akraino.org login the_name password the_pass`
 3. The last step is to deploy our CD jobs by jenkins-job-builder tool.
 
 ```
-git clone "https://gerrit.akraino.org/r/ci-management"
+git clone --recursive "https://gerrit.akraino.org/r/ci-management"
 git clone "https://gerrit.akraino.org/r/icn"
 # create the jjb config file before moving on
 # https://docs.releng.linuxfoundation.org/en/latest/jenkins-sandbox.html
+# To install jenkins-job-builder, run 'pip install jenkins-job-builder' instead of 'apt install',
+# because the verions in apt repo is too old to work for icn
 jenkins-jobs test ci-management/jjb:icn/ci/jjb icn-master-verify
 jenkins-jobs update ci-management/jjb:icn/ci/jjb icn-master-verify
 ```
+
+A sample of jjb config file located at `~/.config/jenkins_jobs/jenkins_jobs.ini`
+```
+[job_builder]
+ignore_cache=True
+keep_descriptions=False
+recursive=True
+retain_anchors=True
+update=jobs
+
+[jenkins]
+user=admin
+password=admin
+url=http://localhost:8080
+```
+
+4. There is [a bug](https://issues.jenkins-ci.org/browse/JENKINS-28466) of jenkins
+which makes some environemtn variables not usable. To fix the bug, we need 'Manage Jenkins' > 'Configure System' > 'click save without any changes'.