JenkinsCIdocumentations-removedcredentials.docx
1 like•191 views
Jenkins is a tool that supports continuous integration by automatically building code changes and running tests whenever code is committed to the main branch. The document discusses best practices for CI like maintaining a code repository, automating builds, making builds self-testing, and integrating with GitHub. It provides steps to install and configure Jenkins on Ubuntu, including installing plugins, configuring security, and setting up email notifications. Finally, it describes how to configure a sample Rails project in Jenkins to run tests and report results whenever code is pushed to GitHub.
![When unit tests fail or a bug emerges, if developer need to revert the codebase to a
bugfree state without debugging, only a small number of changes are lost (because integration
happens frequently)
Constant availability of a "current" build for testing, demo, or release purposes
Frequent code checkin pushes developers to create modular, less complex
code[citation needed]
With continuous automated testing benefits can include:
Enforces discipline of frequent automated testing
Immediate feedback on systemwide impact of local changes
Metrics generated from automated testing and CI (such as metrics for code coverage,
code complexity, and features complete) focus developers on developing functional, quality
code, and help develop momentum in a team
Installing Jenkins on ubuntu
Installation:
For installation follow below steps:
1. wget q O https://jenkinsci.org/debian/jenkinsci.org.key | sudo aptkey add
2. sudo sh c 'echo deb http://pkg.jenkinsci.org/debian binary/ > /etc/apt/sources.list.d/jenkins.list'
3. sudo aptget update
4. sudo aptget install jenkins
Upgrade:
Once installed like this, you can update to the later version of Jenkins (when it comes out) by
running the following commands:
1. sudo aptget update
2. sudo aptget install jenkins
Configure Jenkins:](https://image.slidesharecdn.com/dcfa044c-d0bf-466b-8590-eaeac732e0f9-160614092640/85/JenkinsCIdocumentations-removedcredentials-docx-2-320.jpg)
JenkinsCIdocumentations-removedcredentials.docx
- 2. When unit tests fail or a bug emerges, if developer need to revert the codebase to a bugfree state without debugging, only a small number of changes are lost (because integration happens frequently) Constant availability of a "current" build for testing, demo, or release purposes Frequent code checkin pushes developers to create modular, less complex code[citation needed] With continuous automated testing benefits can include: Enforces discipline of frequent automated testing Immediate feedback on systemwide impact of local changes Metrics generated from automated testing and CI (such as metrics for code coverage, code complexity, and features complete) focus developers on developing functional, quality code, and help develop momentum in a team Installing Jenkins on ubuntu Installation: For installation follow below steps: 1. wget q O https://jenkinsci.org/debian/jenkinsci.org.key | sudo aptkey add 2. sudo sh c 'echo deb http://pkg.jenkinsci.org/debian binary/ > /etc/apt/sources.list.d/jenkins.list' 3. sudo aptget update 4. sudo aptget install jenkins Upgrade: Once installed like this, you can update to the later version of Jenkins (when it comes out) by running the following commands: 1. sudo aptget update 2. sudo aptget install jenkins Configure Jenkins:
- 3. Next, you need to use the Jenkins web interface to install plugins, configure security and add users. Open your web browser to http://localhost:8080. (If you’re running Jenkins remotely, you should be able to use the server’s domain or IP address.) currently for ip: x.x.x.x credential username: yourUserName pass: yourPassword Install Plugins: From the root page, click “Manage Jenkins” then “Manage Plugins”. From the “Available” tab, check the following plugins: 1. Git 2. GitHub 3. rbenv Or rvm 4. Rake 5. Rcov 6. RubyMetrics plugin 7. Mailer Next, select “Download now and install after restart” Configuration of Global Security part is skipped. You can see details here Security Manage Jenkins: Step 1: Go to yourip:jenkinport/configure (http://x.x.x.x:8080/configure) . You can do it by jenkin home > manage jenkins > configure system Step 2: Home check home directory is /var/lib/jenkins or not . otherwise you have to set all default home configuration to that particular home directory. Email notification 1. go to yourjenkinserver/configure 2. In Email notification block smtp server => smtp.gmail.com 3. select Use SMTP Authentication
- 4. 4. give user name password, select use ssh, smtp port => 465 , chracterset => UTF8 5. select Test configuration by sending test email to check configuration is succesful or not . 6. If fails follow it from above link. 7. Finally under your project settings , In Postbuild Actions in Email notification set up your emails. Configure Global Security 1. Enable security. 2. Security Realm > Jenkins’ own user database > Allow users to sign up 3. Authorization > Anyone can do anything 4. after you sign up > change authorization to Loggedin users can do anything or Matrixbased security or Projectbased Matrix Authorization Strategy as your wish . in Matrixbased security you can set up configuration for a particular user/ group which is created in jenkins ui . N.B. while configuring global security you may have security problem like locking yourself (Hope you have not :) ). but If you , then Disable Security or for your convenience One may accidentally set up security realm / authorization in such a way that you may no longer able to reconfigure Jenkins. When this happens, you can fix this by the following steps: 1. Stop Jenkins (the easiest way to do this is to kill the servlet container.) 2. Go to $JENKINS_HOME in the file system and find config.xml file. 3. Open this file in the editor. 4. Look for the <useSecurity>true</useSecurity> element in this file. 5. Replace true with false 6. Remove the elements authorizationStrategy and securityRealm 7. Start Jenkins When Jenkins comes back, it's in the unsecured mode where everyone gets full access to the system. If this is still not working, trying renaming or deleting config.xml. Configure your project: Next, you need to configure your Rails project. To complete this follow below steps:
- 6. mkdir p rcov bundle install rake db:create RAILS_ENV=test rake db:migrate RAILS_ENV=test rake spec Make sure the database is configured properly. If you need a special database.yml, you can store this in Jenkins’ home directory. OPTIONAL: To make sure you know when a build fails, set up email notifications (under “Add postbuild action”). Configure SMTP on the “Configure System” page, found under “Manage Jenkins”. See the Jenkins wiki for an easy Gmail setup: Or You can follow below step. 8. got to yourjenkinserver/configure 9. In Email notification block smtp server => smtp.gmail.com 10. select Use SMTP Authentication 11. give user name password, select use ssh, smtp port => 465 , chracterset => UTF8 12. select Test configuration by sending test email to check configuration is succesful or not . 13. If fails follow it from above link. 14. Finally under your project settings , In Postbuild Actions in Email notification set up your emails. Postbuild Actions 1. select publlish rcov report 2. set directory => coverage/rcov 3. Also before do this you need to ensure that you have right gem in your gem file: gem 'simplecov', :require => false, :group => :test gem 'simplecovrcov' 4. And also configure your spec/spec_helper.rb like this: require 'simplecov' require 'simplecovrcov' SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter SimpleCov.start 'rails' Try out your build by clicking “Build Now”. GitHub Integration
- 7. Finally, I'll set up the GitHub integration, so that a push triggers a new build in Jenkins. Navigate to “Webhooks & Services” under “Settings” on the GitHub repository page. You’ll need to be a repo admin to do this. Click “Configure services” and select the “Jenkins (GitHub plugin)” option. Enter the address to your Jenkins server followed by /githubwebhook/ (for example http://psdd.t.proxylocal.com/githubwebhook/ or http://x.x.x.x:8080/githubwebhook/ ), check “Active” and update your settings. That’s it. Try it out by pushing a commit to GitHub and verifying that a new build is triggered in Jenkins. HardwareRequirementsForJenkins As for your hardware questions we do not typically recommend best practices or hardware configurations because these vary based off specific customer needs and these are considered consulting questions. Jenkins Enterprise by definition runs exactly the same as OSS Jenkins. Here are some generic guidelines we sent out to a specific customer that has a sizable config: The machine requirements on Jenkins installations differ based on the artifacts generated. Thus, there is no onesize fits all recommendation that we provide. However, here are some guidelines: 1. Everything runs off JENKINS_HOME, so make sure there is enough disk space available and the disk can grow. If you run out of disk space, you will see failures. Some plugins take more space than others (e.g a report generating plugin vs a build plugin). The disk usage plugin helps determine usage. 2. Have a beefy machine for Jenkins master & do not run slaves on the master machine. Every slave has certain memory allocated in the master JVM, so the bigger the RAM for the master, the better it is. We typically hear customers allocate 16G or so. 3. Slaves tend to be run of the mill x86 boxes, typically you want them to have the same OS as the release platforms. For reference, this presentation from Redhat shares their typical memory/machine requirements. As for the HA feature this is simply two (or more) masters sharing the same JENKINS_HOME—you can read more about the plugin here. To Force restart jenkins
- 8. 1. sometimes jenkins goes out of memory exception. sudo service jenkins restart donot work then . to we have to kill the java process manually . 2. sudo netstat lpn | grep :8080 # jenkins run on 8080 port 3. sudo kill 9 pid 4. sudo service jenkins start User id / Password for test purpose user : jenkins password : yourPassword ============== THANK YOU ===============