Provides changes for documentation

Change-Id: I1a381fb3de49d006f321d3d5dcd29e5019a5adeb
This commit is contained in:
Irina Povolotskaya 2015-12-18 14:41:18 +03:00
parent a50dd7bb69
commit e858a9268a
4 changed files with 66 additions and 66 deletions

View File

@ -7,6 +7,9 @@ Overview
Components, concept Components, concept
.. image:: pics/Fuel-plugin-CI.png
Jenkins and web server for logs installation Jenkins and web server for logs installation
-------------------------------------------- --------------------------------------------
@ -20,7 +23,7 @@ CI needs the following amount of nodes:
* one for log publication. * one for log publication.
These nodes should be described in ``manifests/site.pp`` with necessary classes: These nodes should be described in ``manifests/site.pp`` with necessary classes::
``class { '::fuel_project::jenkins::slave':}`` ``class { '::fuel_project::jenkins::slave':}``
``class { '::fuel_project::jenkins::master':}`` ``class { '::fuel_project::jenkins::master':}``
``class {::fuel_project::web:}`` ``class {::fuel_project::web:}``
@ -52,13 +55,14 @@ requirements:
Jenkins gerrit plugin configuration Jenkins gerrit plugin configuration
+++++++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++++++
#. The settings looks as follows: #. The settings look as follows:
<pic> .. image:: pics/settings.png
#. It's main gerrit configuration window. You should add a gerrit server. #. It's main gerrit configuration window. You should add a gerrit server.
<pic> .. image:: pics/settings-full.png
#. Vote configuration. #. Vote configuration.
@ -70,55 +74,55 @@ Jenkins plugins installation
----------------------------- -----------------------------
We recommend to install these plugins for Jenkins. We recommend to install these plugins for Jenkins.
Some of them are necessary for CI and other is just useful and make your jenkins experience easier: Some of them are necessary for CI and other is just useful and make your jenkins experience easier:
`AnsiColor <https://wiki.jenkins-ci.org/display/JENKINS/AnsiColor+Plugin>`_ * `AnsiColor <https://wiki.jenkins-ci.org/display/JENKINS/AnsiColor+Plugin>`_
`Ant Plugin <https://wiki.jenkins-ci.org/display/JENKINS/AnsiColor+Plugin>`_ * `Ant Plugin <https://wiki.jenkins-ci.org/display/JENKINS/AnsiColor+Plugin>`_
`build timeout plugin <https://wiki.jenkins-ci.org/display/JENKINS/Build-timeout+Plugin>`_ * `build timeout plugin <https://wiki.jenkins-ci.org/display/JENKINS/Build-timeout+Plugin>`_
`conditional buildstep <https://wiki.jenkins-ci.org/display/JENKINS/Conditional+BuildStep+Plugin>`_ * `conditional buildstep <https://wiki.jenkins-ci.org/display/JENKINS/Conditional+BuildStep+Plugin>`_
`Copy Artifact Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Copy+Artifact+Plugin>`_ * `Copy Artifact Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Copy+Artifact+Plugin>`_
`Credentials Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Credentials+Plugin>`_ * `Credentials Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Credentials+Plugin>`_
`CVS Plug-in <https://wiki.jenkins-ci.org/display/JENKINS/CVS+Plugin>`_ * `CVS Plug-in <https://wiki.jenkins-ci.org/display/JENKINS/CVS+Plugin>`_
`description setter plugin <https://wiki.jenkins-ci.org/display/JENKINS/Description+Setter+Plugin>`_ * `description setter plugin <https://wiki.jenkins-ci.org/display/JENKINS/Description+Setter+Plugin>`_
`Email Extension Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Email-ext+plugin>`_ * `Email Extension Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Email-ext+plugin>`_
`Environment Injector Plugin <https://wiki.jenkins-ci.org/display/JENKINS/EnvInject+Plugin>`_ * `Environment Injector Plugin <https://wiki.jenkins-ci.org/display/JENKINS/EnvInject+Plugin>`_
`External Monitor Job Type Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Monitoring+external+jobs>`_ * `External Monitor Job Type Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Monitoring+external+jobs>`_
`Gerrit Trigger <https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger>`_ * `Gerrit Trigger <https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger>`_
`GIT client plugin <https://wiki.jenkins-ci.org/display/JENKINS/Git+Client+Plugin>`_ * `GIT client plugin <https://wiki.jenkins-ci.org/display/JENKINS/Git+Client+Plugin>`_
`GIT plugin <https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin>`_ * `GIT plugin <https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin>`_
`Groovy <https://wiki.jenkins-ci.org/display/JENKINS/Groovy+plugin>`_ * `Groovy <https://wiki.jenkins-ci.org/display/JENKINS/Groovy+plugin>`_
`Heavy Job Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Heavy+Job+Plugin>`_ * `Heavy Job Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Heavy+Job+Plugin>`_
`HTML Publisher plugin <https://wiki.jenkins-ci.org/display/JENKINS/HTML+Publisher+Plugin>`_ * `HTML Publisher plugin <https://wiki.jenkins-ci.org/display/JENKINS/HTML+Publisher+Plugin>`_
`Javadoc Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Javadoc+Plugin>`_ * `Javadoc Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Javadoc+Plugin>`_
`Job Configuration History Plugin <https://wiki.jenkins-ci.org/display/JENKINS/JobConfigHistory+Plugin>`_ * `Job Configuration History Plugin <https://wiki.jenkins-ci.org/display/JENKINS/JobConfigHistory+Plugin>`_
`JUnit Plugin <https://wiki.jenkins-ci.org/display/JENKINS/JUnit+Plugin>`_ * `JUnit Plugin <https://wiki.jenkins-ci.org/display/JENKINS/JUnit+Plugin>`_
`LDAP Plugin <https://wiki.jenkins-ci.org/display/JENKINS/LDAP+Plugin>`_ * `LDAP Plugin <https://wiki.jenkins-ci.org/display/JENKINS/LDAP+Plugin>`_
`Locale plugin <https://wiki.jenkins-ci.org/display/JENKINS/Locale+Plugin>`_ * `Locale plugin <https://wiki.jenkins-ci.org/display/JENKINS/Locale+Plugin>`_
`Mailer Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Mailer>`_ * `Mailer Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Mailer>`_
`MapDB API Plugin <https://wiki.jenkins-ci.org/display/JENKINS/MapDB+API+Plugin>`_ * `MapDB API Plugin <https://wiki.jenkins-ci.org/display/JENKINS/MapDB+API+Plugin>`_
`Matrix Authorization Strategy Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Matrix+Authorization+Strategy+Plugin>`_ * `Matrix Authorization Strategy Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Matrix+Authorization+Strategy+Plugin>`_
`Matrix Project Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Matrix+Project+Plugin>`_ * `Matrix Project Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Matrix+Project+Plugin>`_
`Maven Integration plugin <https://wiki.jenkins-ci.org/display/JENKINS/Maven+Project+Plugin>`_ * `Maven Integration plugin <https://wiki.jenkins-ci.org/display/JENKINS/Maven+Project+Plugin>`_
`Multijob plugin <https://wiki.jenkins-ci.org/display/JENKINS/Multijob+Plugin>`_ * `Multijob plugin <https://wiki.jenkins-ci.org/display/JENKINS/Multijob+Plugin>`_
`Multiple SCMs plugin <https://wiki.jenkins-ci.org/display/JENKINS/Multiple+SCMs+Plugin>`_ * `Multiple SCMs plugin <https://wiki.jenkins-ci.org/display/JENKINS/Multiple+SCMs+Plugin>`_
`OWASP Markup Formatter Plugin <https://wiki.jenkins-ci.org/display/JENKINS/OWASP+Markup+Formatter+Plugin>`_ * `OWASP Markup Formatter Plugin <https://wiki.jenkins-ci.org/display/JENKINS/OWASP+Markup+Formatter+Plugin>`_
`PAM Authentication plugin <https://wiki.jenkins-ci.org/display/JENKINS/PAM+Authentication+Plugin>`_ * `PAM Authentication plugin <https://wiki.jenkins-ci.org/display/JENKINS/PAM+Authentication+Plugin>`_
`Parameterized Trigger plugin <https://wiki.jenkins-ci.org/display/JENKINS/Parameterized+Trigger+Plugin>`_ * `Parameterized Trigger plugin <https://wiki.jenkins-ci.org/display/JENKINS/Parameterized+Trigger+Plugin>`_
`Publish Over SSH <https://wiki.jenkins-ci.org/display/JENKINS/Publish+Over+SSH+Plugin>`_ * `Publish Over SSH <https://wiki.jenkins-ci.org/display/JENKINS/Publish+Over+SSH+Plugin>`_
`PWauth Security Realm <http://wiki.hudson-ci.org/display/HUDSON/pwauth>`_ * `PWauth Security Realm <http://wiki.hudson-ci.org/display/HUDSON/pwauth>`_
`Run Condition Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Run+Condition+Plugin>`_ * `Run Condition Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Run+Condition+Plugin>`_
`SCM API Plugin <https://wiki.jenkins-ci.org/display/JENKINS/SCM+API+Plugin>`_ * `SCM API Plugin <https://wiki.jenkins-ci.org/display/JENKINS/SCM+API+Plugin>`_
`Script Security Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Script+Security+Plugin>`_ * `Script Security Plugin <https://wiki.jenkins-ci.org/display/JENKINS/Script+Security+Plugin>`_
`Self-Organizing Swarm Plug-in Modules <https://wiki.jenkins-ci.org/display/JENKINS/Swarm+Plugin>`_ * `Self-Organizing Swarm Plug-in Modules <https://wiki.jenkins-ci.org/display/JENKINS/Swarm+Plugin>`_
`Simple Theme Plugin <http://wiki.jenkins-ci.org/display/JENKINS/Simple+Theme+Plugin>`_ * `Simple Theme Plugin <http://wiki.jenkins-ci.org/display/JENKINS/Simple+Theme+Plugin>`_
`SSH Agent Plugin <https://wiki.jenkins-ci.org/display/JENKINS/SSH+Agent+Plugin>`_ * `SSH Agent Plugin <https://wiki.jenkins-ci.org/display/JENKINS/SSH+Agent+Plugin>`_
`SSH Credentials Plugin <https://wiki.jenkins-ci.org/display/JENKINS/SSH+Credentials+Plugin>`_ * `SSH Credentials Plugin <https://wiki.jenkins-ci.org/display/JENKINS/SSH+Credentials+Plugin>`_
`SSH Slaves plugin <http://wiki.jenkins-ci.org/display/JENKINS/SSH+Slaves+plugin>`_ * `SSH Slaves plugin <http://wiki.jenkins-ci.org/display/JENKINS/SSH+Slaves+plugin>`_
`Subversion Plug-in <http://wiki.jenkins-ci.org/display/JENKINS/Subversion+Plugin>`_ * `Subversion Plug-in <http://wiki.jenkins-ci.org/display/JENKINS/Subversion+Plugin>`_
`Throttle Concurrent Builds Plug-in <http://wiki.jenkins-ci.org/display/JENKINS/Throttle+Concurrent+Builds+Plugin>`_ * `Throttle Concurrent Builds Plug-in <http://wiki.jenkins-ci.org/display/JENKINS/Throttle+Concurrent+Builds+Plugin>`_
Timestamper * `Timestamper <https://wiki.jenkins-ci.org/display/JENKINS/Timestamper>`_
`Token Macro Plugin <http://wiki.jenkins-ci.org/display/JENKINS/Token+Macro+Plugin>`_ * `Token Macro Plugin <http://wiki.jenkins-ci.org/display/JENKINS/Token+Macro+Plugin>`_
`Translation Assistance plugin <http://wiki.jenkins-ci.org/display/JENKINS/Translation+Assistance+Plugin>`_ * `Translation Assistance plugin <http://wiki.jenkins-ci.org/display/JENKINS/Translation+Assistance+Plugin>`_
`Windows Slaves Plugin <http://wiki.jenkins-ci.org/display/JENKINS/Windows+Slaves+Plugin>`_ * `Windows Slaves Plugin <http://wiki.jenkins-ci.org/display/JENKINS/Windows+Slaves+Plugin>`_
`Workflow: Step API <https://wiki.jenkins-ci.org/display/JENKINS/Workflow+Plugin>`_ * `Workflow: Step API <https://wiki.jenkins-ci.org/display/JENKINS/Workflow+Plugin>`_
Jenkins jobs installation Jenkins jobs installation
------------------------- -------------------------
@ -188,14 +192,14 @@ You should install the util on jenkins-slave first::
Example of script that use expect for auth on cisco switch and show its configuration:: Example of script that use expect for auth on cisco switch and show its configuration::
spawn ssh "root@$switch_ip" spawn ssh "root@$switch_ip"
set timeout 500 set timeout 500
expect "yes/no" { expect "yes/no" {
send "yes\r" send "yes\r"
expect "*?assword" { send "$switch_pass\r" } expect "*?assword" { send "$switch_pass\r" }
} "*?assword" { send "$switch_pass\r" } } "*?assword" { send "$switch_pass\r" }
expect "# " { send "show run" } expect "# " { send "show run" }
expect "# " { send "exit\r" } expect "# " { send "exit\r" }
Fuel iso updating Fuel iso updating
----------------- -----------------
@ -223,8 +227,4 @@ Steps:
#. Check for errors and delete folder if there is an error. #. Check for errors and delete folder if there is an error.
#. Sync downloaded iso with jenkins slave. You should have necessary users with rsa keys set. #. Sync downloaded iso with jenkins slave. You should have necessary users with rsa keys set.

BIN
pics/Fuel-plugin-CI.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 163 KiB

BIN
pics/settings-full.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

BIN
pics/settings.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB