From: Jessica Wagantall Date: Tue, 24 Apr 2018 22:15:06 +0000 (-0700) Subject: Add Sandbox vs Prod details X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=5b801d644599382694b93bfbcea046630b42e18f;p=releng%2Fdocs.git Add Sandbox vs Prod details - Add an explanation on Jenkins Sandbox and how it compares to Jenkins Production. - Where to access them. - Limitations. - Move entire section right before Jenkins Sandbox topic. - Add a small correction to the title "Get access to the Sandbox" to make it more specific (corrected to "Get access to the Jenkins Sandbox" Change-Id: I7c06e8666f2591e43891362bcfa0065752779546 Issue-ID: RELENG-547 Signed-off-by: Jessica Wagantall --- diff --git a/docs/jenkins.rst b/docs/jenkins.rst index fc912ba..8567613 100644 --- a/docs/jenkins.rst +++ b/docs/jenkins.rst @@ -99,16 +99,6 @@ the jobs published in Jenkins. This will push the jobs to Gerrit and your jobs will appear in Jenkins once the releng/builder or ci-management teams has reviewed and merged your patch. -Jenkins Production & Jenkins Sandbox -==================================== - -The Jenkins server is the home for all project's Jenkins jobs. All -maintenance and configuration of these jobs happen in JJB through the -ci-management or releng/builder repos. Project contributors can no longer edit the Jenkins jobs -directly on the server. Instead, we encourage them to use the Jenkins Sandbox. - -.. todo:: RELENG-547 - Build Minions ============= @@ -257,6 +247,44 @@ line in the logs that look like:: This line provides the name of the new image we built. +Jenkins Production & Jenkins Sandbox +==================================== + +The Jenkins server is the home for all project's Jenkins jobs. Most of the job +configuration gets managed through code using JJB through the ci-management or +releng/builder repos. + +To access the Jenkins Production URL for any project use: +``https://jenkins.PROJECT_DOMAIN`` + +Similarily, the project's corresponding Jenkins Sandbox URL would be: +``https://jenkins.PROJECT_DOMAIN/sandbox`` + +Any users with an LFID can access the Jenkins Production site, but for Jenkins +Sandbox please request an access. To do so, refer to the section +:ref:`Get access to the Jenkins Sandbox ` + +Project contributors do not edit the Jenkins jobs directly on the Jenkins production +server. Instead, we encourage them to use the Jenkins Sandbox. + +The Jenkins Sandbox has similar configuration to the production instance. +Jenkins Sandbos does not publish artifacts in Nexus or Nexus3 or vote in Gerrit which +makes it a safe environment to test the jobs. Users can edit and trigger the jobs +directly to test the behaviour. + +The Jenkins Sandbox can contain dummy configuration files and dummy credentials in +case it helps take the test further and not fail on the first steps due to the configuration +not being present. Any attempt to actually use the configuration files in order +to make any server comunications will fail. To add dummy configuration files, please +create a new ticket to :ref:`Helpdesk `. + +In such case, merge jobs, push, CLM, Docker or Sonar jobs get tested to some extent due +to this limitation. Once the job template gets merged and becomes available in Jenkins Production, +we can confirm the jobs are actually making server comunications as expected with Nexus-IQ, +Sonar, Gerrit or Nexus. + +The Sandbox has limited amount of Virtual Machine nodes instances +to test compared to production Jenkins. .. _lfdocs-jenkins-sandbox: @@ -266,11 +294,6 @@ Jenkins Sandbox Sandbox Overview ---------------- -The Jenkins Sandbox has similar configuration to the production instance. -It cannot publish artifacts or vote in Gerrit which makes it a safe environment -to test the jobs. The Sandbox has limited amount of Virtual Machine nodes instances -to test compared to production Jenkns. - Facts to keep in mind before working on the Sandbox: - Jobs are automatically deleted every Saturday at 08:00 UTC @@ -280,8 +303,10 @@ Facts to keep in mind before working on the Sandbox: - Sandbox jobs cannot vote on Gerrit - Jenkins nodes have OpenStack configuration similarly to the production instance -Get access to the Sandbox -------------------------- +.. _get-sandbox-access: + +Get access to the Jenkins Sandbox +--------------------------------- The Sandbox provides a testing/experimentation environment used before pushing job templates to the production instance.