REST Implementation for Blue Ocean

What is Blue Ocean?

Blue Ocean rethinks the Jenkins user experience. Designed from the ground up for Jenkins Pipeline and compatible with Freestyle jobs, Blue Ocean reduces clutter and increases clarity for every member of your team through the following key features:

  • Sophisticated visualizations of CD pipelines for fast and intuitive comprehension of software pipeline status.

  • Pipeline editor that makes automating CD pipelines approachable by guiding the user through an intuitive and visual process to create a pipeline.

  • Personalization of the Jenkins UI to suit the role-based needs of each member of the DevOps team.

  • Pinpoint precision when intervention is needed and/or issues arise. The Blue Ocean UI shows where in the pipeline attention is needed, facilitating exception handling and increasing productivity.

  • Native integration for branch and pull requests enables maximum developer productivity when collaborating on code with others in GitHub and Bitbucket.

Note that the Blue Ocean plugin is the only one that you need to install from the Jenkins Update Center.

Blue Ocean status

Blue Ocean will not receive further functionality updates. Blue Ocean will continue to provide easy-to-use Pipeline visualization, but it will not be enhanced further. It will only receive selective updates for significant security issues or functional defects.

Alternative options for Pipeline visualization, such as the Pipeline: Stage View and Pipeline Graph View plugins, are available and offer some of the same functionality. While not complete replacements for Blue Ocean, contributions are encouraged from the community for continued development of these plugins.

The Pipeline syntax snippet generator assists users as they define Pipeline steps with their arguments. It is the preferred tool for Jenkins Pipeline creation, as it provides online help for the Pipeline steps available in your Jenkins controller. It uses the plugins installed on your Jenkins controller to generate the Pipeline syntax. Refer to the Pipeline steps reference page for information on all available Pipeline steps.

Running behind a proxy? Read this

In some cases proxies can rewrite URIs that have encoding in them and break web apps.

  • For apache - please follow this guide very carefully, especially the bit about nocanon

  • For nginx - please see this. Generally if you use proxy_pass directly to the Jenkins port, you are ok, otherwise see this.

    • If you still have problems with some blue ocean URIs, you can use a proxy_pass directive like this:

      if ($request_uri ~* "/blue(/.*)") \{ proxy_pass
      http://YOUR_SERVER_IP:YOUR_JENKINS_PORT/blue$1; break; }

Running Jenkins with BlueOcean on Apache Tomcat? Read this

In case you are using Apache Tomcat to serve Jenkins, you will need to make sure that you have configured Tomcat to use the following parameters:


NOTE: Upgrading to a new version

The best way is update the main "Blue Ocean" plugin - it will then upgrade all the dependent plugins and libraries for you. Do not upgrade just one blue ocean plugin at a time, it works best if they are all kept up to date.

Change log

Release notes are published to GitHub releases