Add docs on how to update Jenkins

Change-Id: If4b7ab74bc79855eba9da53de444157b86a4ed17
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

diff --git a/docs/conf.py b/docs/conf.py
index 314df01..4e6dc47 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -24,4 +24,5 @@ linkcheck_ignore = [
     'http.*PROJECT_DOMAIN.*',
     'https://gerrit.linuxfoundation.org/infra/releng/docs-conf',
     'https://jenkins.acumos.org.*',
+    'https://jenkins.example.org.*',
 ]

diff --git a/docs/infra/index.rst b/docs/infra/index.rst
index 12787b9..12bbacd 100644 (file)
--- a/docs/infra/index.rst
+++ b/docs/infra/index.rst
@@ -11,4 +11,5 @@ Infrastructure provided to projects.
    :maxdepth: 2
 
    inventory
+   jenkins
    nexus

diff --git a/docs/infra/jenkins.rst b/docs/infra/jenkins.rst
new file mode 100644 (file)
index 0000000..e64c552
--- /dev/null
+++ b/docs/infra/jenkins.rst
@@ -0,0 +1,35 @@
+.. _lfreleng-docs-jenkins:
+
+#######
+Jenkins
+#######
+
+Upgrading Jenkins
+=================
+
+Regular Jenkins maintenance is necessary to ensure security patches are up to
+date.
+
+Follow these steps to update Jenkins:
+
+#. Notify community that maintenance is about to begin
+#. Put Jenkins into Shutdown mode
+   (https://jenkins.example.org/quietDown)
+#. ``yum update -y --exclude=jenkins``
+   (Do this step while waiting for Jobs to clear in shutdown mode.)
+#. ``yum update -y``
+#. Update Jenkins plugins via Manage Jenkins > Manage Plugins
+
+   Ensure that you click "Download now and install after restart" but DO NOT
+   check the "Restart Jenkins when installation is complete and no jobs are
+   running" button.
+
+   .. note::
+
+      We need to ignore the PostBuildScript update as we require
+      version 0.17 until JJB 2.0.3 is available which is capable of managing
+      the latest version of the PostBuildScript plugin.
+
+#. Restart the server itself ``systemctl reboot``
+#. Remove Shutdown mode from Jenkins
+   (https://jenkins.example.org/cancelQuietDown)