X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=README.md;h=4c21ec69626b5e80117777d0bc29b6d35dac46e2;hb=07b824c8f9cbfad2bdcf8c4de02cbe0a2583d6f5;hp=ce7d420fb7fc8bde222c3aa771bb8a9079961da8;hpb=851b0b6d0cfe84e986548fd596a9b2f18413fefd;p=releng%2Fglobal-jjb.git

diff --git a/README.md b/README.md
index ce7d420f..4c21ec69 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,72 @@ SILO=releng
 - OpenStack Cloud
 - Timestamps
 
+## Installing global-jjb
+
+global-jjb should be deployed in the ci-management repository's jjb directory as
+a submodule. global-jjb is versioned and tagged in Gerrit so installing,
+upgrading, and rolling back changes should be simple via the Gerrit tag system.
+
+```
+    # Choose a global-jjb version to install
+    GLOBAL_JJB_VERSION=v0.1.0
+
+    # Add the new submodule to ci-management's jjb directory.
+    # Note: Only needs to be performed once per ci-management repo.
+    cd jjb/
+    git submodule add https://gerrit.linuxfoundation.org/infra/releng/global-jjb
+
+    # Checkout the version of global-jjb you wish to deploy.
+    cd global-jjb
+    git checkout $GLOBAL_JJB_VERSION
+
+    # Commit global-jjb version to the ci-management repo.
+    cd ../..
+    git add jjb/global-jjb
+    git commit -sm "Install global-jjb $GLOBAL_JJB_VERSION"
+
+    # Push the patch to ci-management for review
+    git review
+```
+
+## Parameters stored in defaults.yaml
+
+There are a few project specific parameters that should be stored in the
+ci-management repo's defaults.yaml file.
+
+**gerrit-server-name**: The name of the Gerrit Server as defined in Gerrit
+Trigger global configuration.
+
+**jenkins-ssh-credential**: The name of the Jenkins Credential to use for ssh
+connections.
+
+If you are using GitHub then there are two more parameters which
+will need to be placed in the defaults.yaml
+
+**github-url**: The URL of GitHub. (Default: https://github.com)
+
+**github-org**: The name of the GitHub organization.
+
+defaults.yaml:
+
+```
+- defaults:
+    name: global
+
+    # lf-infra defaults
+    jenkins-ssh-credential: opendaylight-jenkins-ssh
+    gerrit-server-name: OpenDaylight
+    github-org: lfit
+```
+
+## Config File Management
+
+### Logs
+
+The logs account requires a Maven Settings file created called
+**jenkins-log-archives-settings** with a server ID of **logs** containing the
+credentials for the logs user in Nexus.
+
 ## Deploying ci-jobs
 
 The CI job group contains multiple jobs that should be deployed in all LF
@@ -42,6 +108,8 @@ Jenkins infra. The minimal configuration needed to deploy the ci-management
 jobs is as follows which deploys the **{project-name}-ci-jobs** job group as
 defined in **lf-ci-jobs.yaml**.
 
+ci-management.yaml:
+
 ```
 - project:
     name: ci-jobs
@@ -64,3 +132,18 @@ Optional parameters:
 
 **branch**: is the git branch to build from.
 **jjb-version**: is the version of JJB to install in the build minion.
+
+## Archiving logs in Jobs
+
+There are 2 ways supported for archiving log information:
+
+1) Job creates $WORKSPACE/archives directory and places logs there
+
+In this method the entire archives directory will be pushed to the log server
+in the same structure as configured in the archives directory.
+
+2) Via job variable ARCHIVE_ARTIFACTS using globstar patterns.
+
+In this method a job can define a globstar for example ``**/*.log`` which then
+causes the archive script to do a globstar search for that pattern and archives
+any files it finds matching.