Adding/updating Jenkins Pipeline documentation #5720

coreydaley · 2017-10-15T21:12:46Z

Updating the Developers Guide section to include better documentation about
Jenkins Pipelines, how they work, how to create one, etc.

Trello: https://trello.com/c/rBojNLGj/1121-5-better-devguide-pipeline-docs-techdebt

Depends on: openshift/origin#16880

coreydaley · 2017-10-15T21:14:11Z

@bparees @gabemontero ptal

bparees · 2017-10-16T07:13:41Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

+[NOTE]
+====
+If Jenkins auto-provisioning is enabled on your cluster, and you don't need to make any customizations to the
+Jenkins master, you can skip the above step.


link to jenkins autoprovision doc.

Updated in next push

bparees · 2017-10-16T07:14:59Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

+spec:
+  strategy:
+    jenkinsPipelineStrategy:
+      jenkinsfile: ...


the above instructions imply this BuildConfig should be created verbatim, but it's incomplete...

something like "<pipeline content from below>" would be better.

Updated in next push

bparees · 2017-10-16T07:16:35Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

+}
+----
+
+Now we can import the build config into our OpenShift cluster with the following command:


s/import/create/
s/into/in/

updated in next push

bparees · 2017-10-16T07:18:36Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

+pipelines by logging into the web console and navigating to Builds -> Pipelines.
+
+There you should see the sample-nodejs-pipeline that we created, and each stage that we defined in the Jenkinsfile as it is executed.
+The stages will be green with a check mark if they complete successfully or red with an x if they failed.


needs some wrap up paragraph saying what should happen if it all works. (builds the app from X, deploys it, tests it, you now have a running copy of your code at location Y, etc).

description subject to change per my other comments on your other PR about what i think the content of the jenkinsfile should actually be.

bparees · 2017-10-16T07:18:59Z

dev_guide/builds/jenkins_pipeline_builds.adoc

+
+== Overview
+
+


"this section intentionally left blank" ?

bparees · 2017-10-16T07:23:25Z

dev_guide/builds/jenkins_pipeline_builds.adoc

+== OpenShift Jenkins Pipeline Plugin
+
+The https://github.com/openshift/jenkins-client-plugin[OpenShift Jenkins Pipeline Plugin] must be installed
+on your Jenkins slaves so that the OpenShift DSL will be available to process the JenkinsFile for your


not accurate. the plugin only needs to be installed on the master.

updated in next push

bparees · 2017-10-16T07:23:56Z

dev_guide/builds/jenkins_pipeline_builds.adoc

+
+== OpenShift DSL
+
+The OpenShift Jenkins Pipeline Plugin provides a Domain Specific Language (DSL) for communicating with the OpenShift


client plugin.

the pipeline plugin is the legacy plugin that we are deprecating.

updated in next push

bparees · 2017-10-16T07:27:12Z

dev_guide/builds/jenkins_pipeline_builds.adoc

+If this behavior is not desirable (if you would like to use a Jenkins server external to OpenShift, for example),
+you can use the following procedure to disable it.
+
+If you are an unpriviledged user, a Service must be created for OpenShift to use. The service name must


it's not that a service must be created for openshift to use, it's that a service must be created so the autoprovisioning logic will see it and not autoprovision for you.

also i think this doc can stay where it is, you can just link to it.

updated in next push

bparees · 2017-10-16T07:28:42Z

install_config/configuring_pipeline_execution.adoc

@@ -83,4 +83,25 @@ xref:../dev_guide/integrating_external_services.adoc#dev-guide-integrating-exter
 The latter option could also be used to disable autoprovisioning in select
 projects only.

+== OpenShift Pipeline DSL Plugin


client plugin

updated in next push

bparees · 2017-10-16T07:31:59Z

install_config/configuring_pipeline_execution.adoc

+
+[NOTE]
+====
+Are you a developer looking for information about using this plugin?  If so, see xref:../dev_guide/builds/jenkins_pipeline.adoc#jenkins-pipeline-overview[Jenkins Pipeline Builds].


bad link? (jenkins_pipeline_builds.adoc?)

updated in next push

coreydaley · 2017-10-23T17:35:03Z

@bparees @gabemontero ptal

gabemontero

Generally this is really coming to together.

I've sprinkled in a fair amount of feed back, but a lot of it is posing questions around possible changes vs. more direct call for change. Or changes for future iterations perhaps.

Anyway, take a look and we'll go from there.

gabemontero · 2017-10-23T18:06:19Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

+== The Jenkinsfile
+
+Now that we have created the build config with a jenkinsPipelineStrategy, we need to tell the pipeline what to do.
+We will do this by using an inline Jenkinsfile, since we aren't going to be creating our own git repository for this application.


This is not a call for change, as I believe I understand the pros/cons of switching approaches, and am fine with this safer path, but I thought it at least noteworthy to point out that placing the Jenkinsfile in the repo in question is the "preferred Jenkins way", for lack of a better term, and more than likely the approach our users will take if their dev process uses Jenkins.

Something to monitor moving forward I think.

I will update the doc mentioning that as the preferred way, but thought that the inline jenkinsfile would be better for the example/tutorial

updated in next push

Yep that is what I was assuming the thinking was, and as I tried to convey, I agree, certainly for this initial pass ... if anything else, just leaving some bread crumbs for if/when we revisit.

gabemontero · 2017-10-23T18:16:08Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

+
+== Starting the Pipeline
+
+We can now start the pipeline with the following command:


I'm anticipating the user asking "can I start the pipeline from the Jenkins Console?", which he can of course, and heading off that question with noting that as a footnote type blurb, vs. whether that is a rabbit hole / unnecessary further promotion of Jenkins we want to avoid.

In other words, I'm undecided. @bparees @coreydaley - what do you guys think?

I will update with the three main ways to start it, OpenShift web console, OpenShift CLI, and Jenkins console.

updated in next push

gabemontero · 2017-10-23T18:27:03Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

+// timeout in 20 minutes if the pipeline hasn't completed
+timeout(time: 20, unit: 'MINUTES') {
+  // use a nodejs jenkins slave
+  node('nodejs') {


This comment could just as easily have been made in the sample PR (and I may make it there as well) ...I mentioned this briefly in an email exchange I believe, maybe in the card ... but certainly reasonable that it could get lost in the shuffle.

The "declarative pipeline syntax" was introduced earlier this year: https://jenkins.io/doc/book/pipeline/syntax/#declarative-pipeline

We've pulled in the necessary plugins, versions, to leverage it. And we have already received questions as to whether we support, do we have examples, etc.

It could be as simple as duplicating all the good stuff @coreydaley has in this sample within the skeleton of declarative pipeline. Leveraging the pipeline and agent most notably.

Thoughts?

I can update to use the declarative pipeline, i'll update the other pr with the same.

ok cool ... and yeah, just to be clear, by update I was thinking both forms ... but I'm on the fence there .... perhaps if it is the same core example that is redundant

updated in next push to use declarative syntax

let's pick the form we want people to use primarily. if that's declarative, let's just show that...

ok sounds good... declarative "is the future" ... which I believe @coreydaley has ready to push

in lieu of both forms, and with going to declarative, let's put a footnote somewhere that says we also work with the predecessor, which is now referred to as "scripted pipeline"

gabemontero · 2017-10-23T18:31:42Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

+
+== Introduction
+
+Using the Jenkins OpenShift Client Plugin, you can quickly and easily create Jenkins Pipelines utilizing the OpenShift DSL


DSL -> fluent DSL

i.e. let's highlight / tout the "sugary fluent-ness" of the syntax

I don't see a mention of the phrase "fluent DSL" anywhere in the existing OpenShift docs repo, I only see one place where it mentions fluent, and that's in the Jenkins Client Plugin repo

"DSL Plugin is a Jenkins plugin which aims to provide a readable, concise, comprehensive, and fluent ".

If it makes sense I can add some language like that to this section, but I hesitate to update everywhere it says DSL to say "fluent DSL"

updated in next push

technically we didn't do much of anything in the opnshift docs for the client plugin since it was experimental, so in a general sense I would say its this PR that is beefing up the doc to GA status

As I noted later below, yeah, changing DSL to fluent DSL everywhere is probably overboard, but we should highlight in the client plugin intro that is is fluent styled, etc.

Cool deal re: update in next push ... that said, if he has bandwidth, we should solicit @jupierce 's opinion as client plugin creator on whether we should highlight to some degree the "fluent" nature of the plugin ... as I recall, syntax style was one of the original motivators.

gabemontero · 2017-10-23T18:32:50Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

+Now that we have created the build config with a jenkinsPipelineStrategy, we need to tell the pipeline what to do.
+We will do this by using an inline Jenkinsfile, since we aren't going to be creating our own git repository for this application.
+
+Below is the Jenkinsfile content which is written in groovy using the OpenShift DSL.  We will inline


DSL -> fluent DSL

No description provided.

gabemontero · 2017-10-23T18:33:28Z

dev_guide/jenkins_pipeline.adoc

+== Overview
+
+Jenkins Pipelines give you fine-grained control over building, deploying, and promoting your applications on OpenShift.
+Using a combination of the Jenkins Pipeline Build Strategy, Jenkinsfiles, and the OpenShift DSL _(provided by the OpenShift


No description provided.

gabemontero · 2017-10-23T18:33:54Z

dev_guide/jenkins_pipeline.adoc

+== OpenShift Jenkins Client Plugin
+
+The https://github.com/openshift/jenkins-client-plugin[OpenShift Jenkins Client Plugin] must be installed
+on your Jenkins master so that the OpenShift DSL will be available to use within the JenkinsFile for your


fluent DSL

though maybe not every instance of DSL needs to become fluent DSL ... assuming everyone agrees on injecting fluent ....as long as it is emphasized somewhere in the doc, I'm good.

Agreed, see comment at top.

yep ... cool deal

gabemontero · 2017-10-23T18:34:25Z

dev_guide/jenkins_pipeline.adoc

+
+== OpenShift DSL
+
+The OpenShift Jenkins Client Plugin provides a Domain Specific Language (DSL) for communicating with the OpenShift


... fluent-styled Domain Specific Language

updated in next push

gabemontero · 2017-10-23T18:38:39Z

dev_guide/jenkins_pipeline.adoc

+runtimes for specific jobs.
+
+For more detailed information on configuring slave pods using the Kubernets Plugin see https://github.com/jenkinsci/kubernetes-plugin/blob/master/README.md[Kubernetes Plugin README].
+


We should point to the ConfigMap / ImageStream support for dynamically defining slave pods ... should be in the main jenkins image doc

gabemontero · 2017-10-23T18:46:30Z

install_config/configuring_pipeline_execution.adoc

+Are you a developer looking for information about using this plugin?  If so, see xref:../dev_guide/builds/jenkins_pipeline_builds.adoc#jenkins-pipeline-overview[Jenkins Pipeline Builds].
+====
+
+


Some mention of the sync plugin seems appropriate here ....

link to the repo readme

link to detail/pointers in main other_images/jenkins doc

key points / highlights
-- dynamic job/run creation in jenkins
-- dynamic creation of slave pod templates
-- injecting env vars
-- pipeline visualization in openshift web console
-- integration with jenkins git plugin (passes commit info from openshift builds to jenkins git plugin)

Updated in next push

bparees · 2017-10-23T21:08:19Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

+
+[[introduction]]
+
+== Introduction


This is about openshift pipelines first and foremost and the jenkins openshift client plugin secondarily, so the overview should start by talking about openshift pipelines, before jumping into the client plugin.

(you can have an openshift pipeline that doesn't use the client plugin)

Updated in next push

bparees · 2017-10-23T21:11:11Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

+
+Once the pipeline has started you should see the following actions performed within your project:
+
+ * a node.js Jenkins slave pod will be created


even before this, the jenkins server in your project will kick off a job instance.

updated in next push (also fixed the pipeline to spin up a node.js slave pod again, had lost it when switch to the declarative syntax)

bparees · 2017-10-23T21:12:54Z

dev_guide/jenkins_pipeline.adoc

+The https://github.com/openshift/jenkins-client-plugin[OpenShift Jenkins Client Plugin] must be installed
+on your Jenkins master so that the OpenShift DSL will be available to use within the JenkinsFile for your
+application.  This plugin is installed and enabled by default when using the Jenkins (Ephemeral) or Jenkins
+(Persistent) templates.


you can just say it's available by default when using the openshift jenkins image.

updated in next push

bparees · 2017-10-23T21:13:31Z

dev_guide/jenkins_pipeline.adoc

+
+[[the-openshift-dsl]]
+
+== OpenShift DSL


this should be nested one level deeper since it seems like a subsection of the client plugin.

updated in next push

bparees · 2017-10-23T21:16:14Z

dev_guide/jenkins_pipeline.adoc

+[NOTE]
+====
+The optional *jenkinsfilePath* field specifies the name of the file to use, relative to the source *contextDir*.
+If *contextDir* is omitted, it defaults to the root of the repository. If *jenkinsfilePath* is omitted, it defaults to *Jenkinsfile*.


this note contradicts the claim above that one of jenkinsFilepath or jenkinsFile must be specified(specifying neither is in fact ok). Also there are two different capitalization styles being used. jenkinsfilePath looks to be the right form.

Updated in the next push to clarify the wording.

coreydaley · 2017-10-24T02:40:49Z

@gabemontero @bparees ptal
I still need to add the information to cover https://github.com/openshift/openshift-docs/pull/5720/files#r146358420 but I believe that everything else has been addressed.

bparees · 2017-10-24T09:35:58Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

@@ -0,0 +1,219 @@
+[[dev-guide-jenkins-pipeline-builds]]
+= Jenkins Pipeline Builds


we should be calling these openshift pipeline builds. strictly speaking, jenkins is an implementation detail (though one that is a heavily leaked abstraction)

updated in next push

bparees · 2017-10-24T09:37:11Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

+== Introduction
+
+Whether you are creating a simple website or a complex web of microservices, it's quick
+and easy to use Jenkins Pipelines to build, test, deploy, and promote your applications on OpenShift.


easy to use OpenShift Pipelines to build, test.......blah blah. OpenShift Pipelines provide an OpenShift experience around Jenkins Pipelines. (and now you can go talk about jenkins pipelines all you want)

updated in next push

bparees · 2017-10-24T09:41:54Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

+ ** the pipeline will wait until the build has completed to trigger the next stage
+ * a deployment will be started using the *nodejs-mongodb-example* deployment config
+ ** the pipeline will wait until the deployment has completed to trigger the next stage
+ * if the build and deploy are successful, the *nodejs-mongodb-example:latest* image will be tagged as *nodejs-mongodb-example:stage*


i'd divide this list into two sections: things that always happen and things the pipeline specifically is doing.

Things that happen always:

job instance created

slave pod launched to run your pipeline (as long as your pipeline declares a node, so this one kinda muddies the water between a generic "what happens when you run a pipeline" action and "what the specific pipeline makes happen")

pipeline runs on slave

slave is deleted (if one was required for the pipeline)

things this particular pipeline(jenkinsfile) does:

delete resources

create a new set of resources

run an openshift build to produce an app image

wait for build to complete

deploy the new app image

wait for deployment

tag the image

updated in next push

bparees · 2017-10-24T09:42:33Z

dev_guide/jenkins_pipeline.adoc

@@ -0,0 +1,115 @@
+[[dev-guide-jenkins-pipeline]]
+= Jenkins Pipeline


openshift pipelines

updated in next push

bparees · 2017-10-24T09:42:42Z

dev_guide/jenkins_pipeline.adoc

+
+== Overview
+
+Jenkins Pipelines give you fine-grained control over building, deploying, and promoting your applications on OpenShift.


openshift pipelines

updated in next push

bparees · 2017-10-24T09:43:54Z

dev_guide/jenkins_pipeline.adoc

+
+== Jenkins Pipeline Strategy
+
+In order to take advantage of the OpenShift DSL within your project, you will need to utilize the


In order to take advantage of OpenShift Pipelines within your project..... (you may or may not use the openshift DSL, you may not use the client plugin at all).

updated in next push

bparees · 2017-10-24T09:45:35Z

dev_guide/jenkins_pipeline.adoc

+This strategy defaults to using a *Jenkinsfile* at the root of your source repository, but also provides the
+following configuration options:
+
+* an inline jenkinsFile field within your BuildConfig that utilizes the OpenShift DSL using the groovy syntax


again doesn't have to use the openshift dsl. that's recommended, depending what you're doing, but not a requirement. Find a way to distinguish "what an openshift pipeline is in general"(a jenkins pipeline strategy buildconfig+a Jenkins file definition) from "here's a great tool to use when you want to talk to openshift from your jenkinsfile"(use the client plugin + openshift DSL in your Jenkinsfile).

Updated in next push

bparees · 2017-10-24T09:46:47Z

dev_guide/jenkins_pipeline.adoc

+
+== Jenkinsfile
+
+The Jenkinsfile utilizes the standard groovy language syntax along with the OpenShift DSL


again the DSL is basically optional. it's something you can use, it's not something you do use.

updated in next push

coreydaley

@bparees @gabemontero I believe that all feedback has been addressed.

coreydaley · 2017-10-24T14:00:19Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

@@ -0,0 +1,219 @@
+[[dev-guide-jenkins-pipeline-builds]]
+= Jenkins Pipeline Builds


updated in next push

coreydaley · 2017-10-24T14:02:28Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

+== Introduction
+
+Whether you are creating a simple website or a complex web of microservices, it's quick
+and easy to use Jenkins Pipelines to build, test, deploy, and promote your applications on OpenShift.


updated in next push

coreydaley · 2017-10-24T14:03:58Z

dev_guide/jenkins_pipeline.adoc

@@ -0,0 +1,115 @@
+[[dev-guide-jenkins-pipeline]]
+= Jenkins Pipeline


updated in next push

coreydaley · 2017-10-24T14:04:29Z

dev_guide/jenkins_pipeline.adoc

+
+== Overview
+
+Jenkins Pipelines give you fine-grained control over building, deploying, and promoting your applications on OpenShift.


updated in next push

coreydaley · 2017-10-24T14:05:14Z

dev_guide/jenkins_pipeline.adoc

+
+== Jenkins Pipeline Strategy
+
+In order to take advantage of the OpenShift DSL within your project, you will need to utilize the


updated in next push

coreydaley · 2017-10-24T14:09:32Z

dev_guide/jenkins_pipeline.adoc

+
+== Jenkinsfile
+
+The Jenkinsfile utilizes the standard groovy language syntax along with the OpenShift DSL


updated in next push

coreydaley · 2017-10-24T15:18:11Z

dev_guide/app_tutorials/jenkins_pipeline.adoc

+ ** the pipeline will wait until the build has completed to trigger the next stage
+ * a deployment will be started using the *nodejs-mongodb-example* deployment config
+ ** the pipeline will wait until the deployment has completed to trigger the next stage
+ * if the build and deploy are successful, the *nodejs-mongodb-example:latest* image will be tagged as *nodejs-mongodb-example:stage*


updated in next push

coreydaley · 2017-10-24T15:20:16Z

dev_guide/jenkins_pipeline.adoc

+This strategy defaults to using a *Jenkinsfile* at the root of your source repository, but also provides the
+following configuration options:
+
+* an inline jenkinsFile field within your BuildConfig that utilizes the OpenShift DSL using the groovy syntax


Updated in next push

coreydaley · 2017-10-24T16:06:00Z

install_config/configuring_pipeline_execution.adoc

+Are you a developer looking for information about using this plugin?  If so, see xref:../dev_guide/builds/jenkins_pipeline_builds.adoc#jenkins-pipeline-overview[Jenkins Pipeline Builds].
+====
+
+


Updated in next push

gabemontero · 2017-10-24T19:12:25Z

install_config/configuring_pipeline_execution.adoc

+The OpenShift jenkins Sync Plugin provides the following:
+
+ * dynamic job/run creation in Jenkins
+ * dynamic creation of slave pod templates


dynamic creation of slave pod templates from either ImageStreams, ImageStreamTags, or ConfigMaps

updated in next push

gabemontero · 2017-10-24T19:15:41Z

dev_guide/openshift_pipeline.adoc

+
+[[advanced-topics]]
+
+== Advanced Topics


If this was previously discussed I missed it ... but I would move the entire Advanced Topics section to configuring_pipeline_execution

The point of this section is to get this information into the online documentation and into the hands of developers. There is similar information already in the install_config section

ok seems maybe redundant to me then ... or conversely, if we mention this stuff here, we should mention the sync plugin information here as well (it is similar is scope / feel in my opinion)

Thoughts @coreydaley @bparees ?

the install config section isn't available to users reading the online docs (because it's assumed they aren't doing install/config)
https://docs.openshift.com/online/welcome/index.html

(which means referencing that section is also going to be problematic of course. might have to ask @bmcelvee what's best to do here).

But i think the goal of getting this in front of developers (who would not be reading the install/config docs) is a valid one.

The overall goal here is to explain to developers what pipelines are/how they work and reference out to more detailed specifics elsewhere. so mentioning the sync plugin makes sense (w/ a link to either the jenkins image doc that talks more about it).

We can ifdef the content so it only appears in Online docs, reducing the redundancy in our OCP and Origin docs. Would that be a good solution?

Not great imho, I just don't expect developers to read the install /config docs at all unless we point them there. I'm more concerned that for the online docs we're pointing to an invalid link.

Writing the full content here for online and linking it for origin could be an option but that seems painful to maintain.

gabemontero · 2017-10-24T19:17:05Z

Just two minor comments

bparees

i think we'll still want to iterate on this a bit, but if you address my last couple nits here i think we can merge and then follow up.

bparees · 2017-10-26T16:38:26Z

dev_guide/app_tutorials/openshift_pipeline.adoc

+and fluent syntax for rich interactions with an OpenShift API server, allowing for even more fine grained
+control over the build, deployment, and promotion of applications on your OpenShift cluster.
+
+For this example, we are going to create a Jenkins Pipeline that will build, deploy, and verify a Node.js/MongoDB


s/Jenkins Pipeline/OpenShift Pipeline/

Fixed in next push

bparees · 2017-10-26T16:41:24Z

dev_guide/app_tutorials/openshift_pipeline.adoc

+$ oc create -f https://raw.githubusercontent.com/openshift/origin/master/examples/jenkins/pipeline/nodejs-sample-pipeline.yaml
+----
+
+For more information about the OpenShift DSL syntax used here see https://jenkins.io/doc/pipeline/steps/openshift-pipeline/[OpenShift Pipeline Steps].


i don't think this is the right link. that's the legacy plugin. you want to link to the client plugin, right?

Fixed in next push

bparees · 2017-10-26T16:42:28Z

dev_guide/app_tutorials/openshift_pipeline.adoc

+
+ * a job instance is created on the Jenkins server
+ * a slave pod is launched _(if your pipeline requires one)_
+ * the pipeline runs on the slave pod _(or the master if no slave is defined)_


s/defined/required/

fixed in next push

coreydaley · 2017-10-26T17:08:18Z

@bparees ptal, all feedback has been addressed

bparees · 2017-10-26T20:51:46Z

dev_guide/app_tutorials/openshift_pipeline.adoc

+and fluent syntax for rich interactions with an OpenShift API server, allowing for even more fine grained
+control over the build, deployment, and promotion of applications on your OpenShift cluster.
+
+For this example, we are going to create a OpenShift Pipeline that will build, deploy, and verify a Node.js/MongoDB


s/a OpenShift/an OpenShift/

updated in next push

bparees · 2017-10-26T20:52:27Z

one last nit, otherwise lgtm and over to @openshift/team-documentation for final review/merge.

Updating the Developers Guide section to include better documentation about Jenkins Pipelines, how they work, how to create one, etc. Trello: https://trello.com/c/rBojNLGj/1121-5-better-devguide-pipeline-docs-techdebt

coreydaley · 2017-10-27T14:31:18Z

@openshift/team-documentation @bmcelvee ptal

bmcelvee · 2017-10-27T17:12:39Z

Thanks, @coreydaley! This is going into 3.7?

coreydaley · 2017-10-27T17:16:00Z

@bmcelvee yes, the features are already there, it's just updating docs for them.

bparees · 2017-10-27T17:32:37Z

Yes Ben Parees | OpenShift On Oct 27, 2017 19:12, "Brandi McElveen Munilla" <[email protected]> wrote: Thanks, @coreydaley <https://github.com/coreydaley>! This is going into 3.7? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#5720 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AEvl3tvGZ1zw3i01mrO04iZlGj-yLiNdks5swg8KgaJpZM4P55a-> .

…e_example Automatic merge from submit-queue. Adding sample Jenkins Pipeline Adding a sample Jenkins Pipeline in support of documentation updates. Supports: openshift/openshift-docs#5720 Trello: https://trello.com/c/rBojNLGj/1121-5-better-devguide-pipeline-docs-techdebt

coreydaley · 2017-10-27T19:36:02Z

@bmcelvee looks like openshift/origin#16880 merged, so this should be good now

coreydaley · 2017-10-28T13:37:30Z

(5) Better Dev_Guide Pipeline Docs [techdebt]

bmcelvee · 2017-11-02T02:31:04Z

[rev_history]
|xref:../dev_guide/app_tutorials/openshift_pipeline.adoc#dev-guide-openshift-pipeline-builds[OpenShift Pipeline Builds]
|Added section.
%
|xref:../dev_guide/openshift_pipeline.adoc#dev-guide-openshift-pipeline[OpenShift Pipeline]
|Added section.
%
|xref:../install_config/configuring_pipeline_execution.adoc#install-config-configuring-pipeline-execution[Configuring Pipeline Execution]
|Added the xref:../install_config/configuring_pipeline_execution.adoc#install-openshift-jenkins-client-plugin[OpenShift Jenkins Client Plug-in] and xref:../install_config/configuring_pipeline_execution.adoc#openshift-jenkins-sync-plugin[OpenShift Jenkins Sync Plug-in] sections.
%
|xref:../using_images/other_images/jenkins.adoc#using-images-other-images-jenkins[Jenkins]
|Added the xref:../using_images/other_images/jenkins.adoc#memory-requirements[Memory Requirements] section.
%

Updating the Developers Guide section to include better documentation about Jenkins Pipelines, how they work, how to create one, etc. Trello: https://trello.com/c/rBojNLGj/1121-5-better-devguide-pipeline-docs-techdebt (cherry picked from commit 45ff79b) xref:"openshift#5720"

[dedicated-3.5-stage] Adding/updating Jenkins Pipeline documentation #5720

vikram-redhat · 2017-11-03T23:07:00Z

@bmcelvee - Hey Brandi, this shouldn't have gone into dedicated 3.5 or online 3.6 branches. It should have gone into dedicated-3.7-stage and online-3.7-stage branches instead as this is a 3.7 release. I am going to revert these commits from the stage branches. Same applies to your follow up as well: #6083.

Can you pick them to the right branches on Monday?

vikram-redhat · 2017-11-03T23:46:59Z

@bmcelvee - I can't seem to revert the PRs in the stage branches. I have added new commits to just remove them from _topic_map.yml for those branches: #6135 and #6136

coreydaley mentioned this pull request Oct 15, 2017

Adding sample Jenkins Pipeline openshift/origin#16880

Merged

bparees requested changes Oct 16, 2017

View reviewed changes

gabemontero suggested changes Oct 23, 2017

View reviewed changes

bparees reviewed Oct 23, 2017

View reviewed changes

bparees reviewed Oct 24, 2017

View reviewed changes

coreydaley commented Oct 24, 2017

View reviewed changes

gabemontero reviewed Oct 24, 2017

View reviewed changes

bparees self-assigned this Oct 26, 2017

bparees requested changes Oct 26, 2017

View reviewed changes

bparees reviewed Oct 26, 2017

View reviewed changes

bmcelvee self-assigned this Oct 27, 2017

Adding/updating Jenkins Pipeline documentation

45ff79b

Updating the Developers Guide section to include better documentation about Jenkins Pipelines, how they work, how to create one, etc. Trello: https://trello.com/c/rBojNLGj/1121-5-better-devguide-pipeline-docs-techdebt

bmcelvee added the branch/enterprise-3.7 label Oct 27, 2017

bmcelvee added this to the Future Release milestone Oct 27, 2017

bmcelvee added the to_followup label Nov 2, 2017

bmcelvee merged commit 2e65003 into openshift:master Nov 2, 2017

bmcelvee mentioned this pull request Nov 2, 2017

PR5720-Follow-up Minor Edits #6083

Merged

bmcelvee added branch/dedicated branch/online labels Nov 2, 2017

This was referenced Nov 2, 2017

[enterprise-3.7] Adding/updating Jenkins Pipeline documentation #6089

Merged

[dedicated-3.5-stage] Adding/updating Jenkins Pipeline documentation #5720 #6088

Merged

[online-3.6-stage] Adding/updating Jenkins Pipeline documentation #6090

Merged

bmcelvee added a commit that referenced this pull request Nov 2, 2017

Merge pull request #6088 from bmcelvee/dedicated-3.5-stage

51ae387

[dedicated-3.5-stage] Adding/updating Jenkins Pipeline documentation #5720

bmcelvee removed the to_followup label Nov 2, 2017

This was referenced Nov 3, 2017

Removed Pipeline Docs from Dedicated 3.5 #6135

Merged

Removed Pipeline Docs from Online 3.6 #6136

Merged

This was referenced Nov 6, 2017

[dedicated-3.7-stage] Adding/updating Jenkins Pipeline documentation #6144

Merged

[online-3.7-stage] Adding/updating Jenkins Pipeline documentation #6145

Merged

vikram-redhat modified the milestones: Future Release, OCP 3.7 GA Nov 29, 2017


		== OpenShift DSL

		The OpenShift Jenkins Pipeline Plugin provides a Domain Specific Language (DSL) for communicating with the OpenShift


		== Starting the Pipeline

		We can now start the pipeline with the following command:


		== Introduction

		Using the Jenkins OpenShift Client Plugin, you can quickly and easily create Jenkins Pipelines utilizing the OpenShift DSL


		== OpenShift DSL

		The OpenShift Jenkins Client Plugin provides a Domain Specific Language (DSL) for communicating with the OpenShift

		runtimes for specific jobs.

		For more detailed information on configuring slave pods using the Kubernets Plugin see https://github.com/jenkinsci/kubernetes-plugin/blob/master/README.md[Kubernetes Plugin README].

		Are you a developer looking for information about using this plugin? If so, see xref:../dev_guide/builds/jenkins_pipeline_builds.adoc#jenkins-pipeline-overview[Jenkins Pipeline Builds].
		====


		Once the pipeline has started you should see the following actions performed within your project:

		* a node.js Jenkins slave pod will be created

		@@ -0,0 +1,219 @@
		[[dev-guide-jenkins-pipeline-builds]]
		= Jenkins Pipeline Builds

		@@ -0,0 +1,115 @@
		[[dev-guide-jenkins-pipeline]]
		= Jenkins Pipeline


		== Overview

		Jenkins Pipelines give you fine-grained control over building, deploying, and promoting your applications on OpenShift.


		[[introduction]]

		== Introduction


		== Jenkins Pipeline Strategy

		In order to take advantage of the OpenShift DSL within your project, you will need to utilize the


		== Jenkinsfile

		The Jenkinsfile utilizes the standard groovy language syntax along with the OpenShift DSL

Adding/updating Jenkins Pipeline documentation #5720

Adding/updating Jenkins Pipeline documentation #5720

Conversation

coreydaley commented Oct 15, 2017

coreydaley commented Oct 15, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coreydaley commented Oct 23, 2017

gabemontero left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coreydaley commented Oct 24, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bparees Oct 24, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bparees Oct 24, 2017 •

edited

Loading