Added notice for setting up external jenkins #3452

oatmealraisin · 2017-01-06T18:35:22Z

This is for users interested in using existing Jenkins servers for
the pipeline build strategy.

I have language for putting more detail into the Pipeline page, but it seems that the External Services page is sufficient.

oatmealraisin · 2017-01-09T16:13:00Z

@bparees sorry, forgot to ping you. ptal?

ahardin-rh · 2017-01-09T16:57:27Z

@oatmealraisin Thanks! Is this for 3.4, or does it apply to the current release?

oatmealraisin · 2017-01-09T17:01:03Z

@ahardin-rh It should apply to the current release, but I'll let Ben have the final word on that

bparees · 2017-01-09T17:04:02Z

the technique applies to 3.4 and beyond, since 3.4 is when we introduced autoprovisioning.

ahardin-rh · 2017-01-09T17:12:31Z

install_config/configuring_pipeline_execution.adoc

+
+[IMPORTANT]
+====
+If you're using an external Jenkins server to manage your pipeline, you'll need


s/you're/you are
s/you'll need to create/you must create

bparees · 2017-01-09T17:43:34Z

install_config/configuring_pipeline_execution.adoc

+====
+If you're using an external Jenkins server to manage your pipeline, you'll need
+to create a service for {product-title} to use it.
+xref:../dev_guide/integrating_external_services.adoc#dev-guide-integrating-external-services[Learn more about integrating external services.]


I think we want to say more on this topic. We are trying to communicate two things:

if you want to prevent autoprovisioning from happening, you can do so by creating a properly named service(and make it clear how to determine that name), which will block the autoprovisioning (because the service already exists).

one reason you might want to do (1) is because you already have a jenkins server that you want to use. that server could be running in another project, or external to openshift entirely. either way, you should point the service you create in fulfillment of (1), to that jenkins, using the external service mechanism.

I'm going to absorb the warning above to try not to repeat information, how does that sound?

yes i think it's all related information that can be in a single warning/note block.

oatmealraisin · 2017-01-09T22:04:41Z

@bparees I've updated the language to try and be more clear about why you would manually create a service. However, I didn't explicitly say that you could disable autoprovisioning by creating a Service matching serviceName. My worry is that we'd have to take more language to explain the case where you couldn't edit the autoProvisionEnabled option. Let me know if I should use this language anyways :)

Also, I noticed that this pull was tagged branch/online. I don't think that this document is part of the online docs. The next best section I could find in Builds and Image Streams just points to Configuring Pipeline Execution, which 404s. It doesn't look like that is reflected by the Online documentation, though.

I've made changes to Builds and Image Streams, ptal?

bparees · 2017-01-09T22:31:47Z

My worry is that we'd have to take more language to explain the case where you couldn't edit the autoProvisionEnabled option.

i still think we need to discuss it. there are really two cases and we should mention them both:

you're a user, not a cluster admin
you want auto provisioning in some projects but not others

oatmealraisin · 2017-01-10T14:07:40Z

@bparees I've removed the IMPORTANT tag and expanded on what is said. I mentioned the second case at the end of the article, is that sufficient?

bparees · 2017-01-10T18:12:30Z

architecture/core_concepts/builds_and_image_streams.adoc

+xref:../dev_guide/integrating_external_services.adoc#dev-guide-integrating-external-services[Learn more about integrating external services.]
+endif::[]
+ifndef::openshift-online[]
+For more details on how the Jenkins server is deployed, see 


"For more details on how the Jenkins server is deployed and how to configure or disable the autoprovisioning behavior, see"

bparees · 2017-01-10T18:13:18Z

architecture/core_concepts/builds_and_image_streams.adoc

+server external to {product-title}, for example), create a Service with the
+name `*jenkins*` in your project, and configure it to point to the external
+Jenkins.
+xref:../dev_guide/integrating_external_services.adoc#dev-guide-integrating-external-services[Learn more about integrating external services.]


drop these lines (145-150). in general we try to keep implementation/config details out of the "architecture" section. it's a high level overview of concepts, not a usage guide.

I don't think that the install_config section will show up for online documentation, should we put this blurb somewhere else or leave it out?

bparees · 2017-01-10T18:14:01Z

architecture/core_concepts/builds_and_image_streams.adoc

+Jenkins.
+xref:../dev_guide/integrating_external_services.adoc#dev-guide-integrating-external-services[Learn more about integrating external services.]
+endif::[]
+ifndef::openshift-online[]


why this ifndef?

The document in the link doesn't exist in the online version, and will lead to a 404

edit: I removed them in the latest version

but it sounds like that means online users will have no guidance whatsoever for how to disable autoprovisioning.

bparees · 2017-01-10T18:16:01Z

install_config/configuring_pipeline_execution.adoc

+* If you're a cluster admin, simply set `*autoProvisionEnabled*` to `*false*`.
+  This will disable autoprovisioning across the cluster.
+* If you're an unpriviledged user, a Service must be created for {product-title}
+  to use. The default value of `*serviceName*` is `*jenkins*`. However, this only


"The service name must match the cluster configuration value of serviceName in the jenkinsPipelineConfig. The default value is jenkins."

bparees · 2017-01-10T18:17:11Z

install_config/configuring_pipeline_execution.adoc

+* If you're an unpriviledged user, a Service must be created for {product-title}
+  to use. The default value of `*serviceName*` is `*jenkins*`. However, this only
+  disables autoprovisioning on a project-by-project level.
+xref:../dev_guide/integrating_external_services.adoc#dev-guide-integrating-external-services[Learn more about integrating external services.]


"If you are disabling autoprovisioning because you are running a Jenkins server outside your project, it is recommended to point this new service to your existing Jenkins server. See:"

oatmealraisin · 2017-01-10T19:29:18Z

@bparees I've implemented your requests, ptal?

bparees · 2017-01-10T19:41:48Z

lgtm

oatmealraisin · 2017-01-10T19:46:52Z

@ahardin-rh ptal/merge?

ahardin-rh · 2017-01-10T19:49:46Z

install_config/configuring_pipeline_execution.adoc

+(if you would like to use a Jenkins server external to {product-title}, for
+example), there are a few things you can do, depending on who you are.
+
+* If you're a cluster admin, simply set `*autoProvisionEnabled*` to `*false*`.


s/you're/you are
s/admin/administrator

ahardin-rh · 2017-01-10T19:50:16Z

install_config/configuring_pipeline_execution.adoc

+
+* If you're a cluster admin, simply set `*autoProvisionEnabled*` to `*false*`.
+  This will disable autoprovisioning across the cluster.
+* If you're an unpriviledged user, a Service must be created for {product-title}


s/you're/you are

ahardin-rh · 2017-01-10T19:50:54Z

install_config/configuring_pipeline_execution.adoc

+  to use. The service name must match the cluster configuration value of
+  `*serviceName*` in the `*jenkinsPipelineConfig*`. The default value is
+  `*jenkins*`. If you are disabling autoprovisioning because you are running a
+  Jenkins server outside your project, it is recommended to point this new


it is recommended that you point this new...

ahardin-rh · 2017-01-10T19:52:37Z

@oatmealraisin just a few minor nits from me. Once those are addressed and commits squashed, we should be golden. 🌟 Thanks!

This is for users interested in using existing Jenkins servers for the pipeline build strategy.

oatmealraisin · 2017-01-10T19:58:36Z

@ahardin-rh Done! Merge?

ahardin-rh · 2017-01-10T20:16:21Z

[rev_history]
|xref:../architecture/core_concepts/builds_and_image_streams.adoc#architecture-core-concepts-builds-and-image-streams[Core Concepts -> Builds and Image Streams]
|Added information on how the first time a project defines a build configuration using a Pipeline strategy, {product-title} instantiates a Jenkins server to execute the pipeline.
%
|xref:../install_config/configuring_pipeline_execution.adoc#install-config-configuring-pipeline-execution[Configuring Pipeline Execution]
|Added information about setting up an external Jenkins server.
%

bparees added branch/enterprise-3.4 branch/enterprise-3.5 branch/online labels Jan 9, 2017

ahardin-rh added this to the Future Release milestone Jan 9, 2017

ahardin-rh added to_followup and removed branch/enterprise-3.5 to_followup labels Jan 9, 2017

ahardin-rh reviewed Jan 9, 2017

View reviewed changes

bparees requested changes Jan 9, 2017

View reviewed changes

bparees requested changes Jan 10, 2017

View reviewed changes

bparees added the branch/enterprise-3.5 label Jan 10, 2017

ahardin-rh reviewed Jan 10, 2017

View reviewed changes

Added notice for setting up external jenkins

53b8d9f

This is for users interested in using existing Jenkins servers for the pipeline build strategy.

ahardin-rh removed the branch/enterprise-3.5 label Jan 10, 2017

ahardin-rh merged commit 0c45c40 into openshift:master Jan 10, 2017

vikram-redhat modified the milestones: Future Release, Staging, OCP 3.4 GA Jan 16, 2017

adellape added the branch/dedicated label Jan 18, 2017

adellape mentioned this pull request Jan 18, 2017

Sync topic_map title, fix stray block + typo #3525

Merged

adellape modified the milestones: OCP 3.4 GA, Staging, Temp Feb 1, 2017

vikram-redhat modified the milestones: OCP 3.4 GA, Dedicated-Staging Mar 31, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added notice for setting up external jenkins #3452

Added notice for setting up external jenkins #3452

oatmealraisin commented Jan 6, 2017 •

edited

Loading

oatmealraisin commented Jan 9, 2017

ahardin-rh commented Jan 9, 2017

oatmealraisin commented Jan 9, 2017 •

edited

Loading

bparees commented Jan 9, 2017

ahardin-rh Jan 9, 2017

bparees Jan 9, 2017

oatmealraisin Jan 9, 2017

bparees Jan 9, 2017

oatmealraisin commented Jan 9, 2017

bparees commented Jan 9, 2017

oatmealraisin commented Jan 10, 2017

bparees Jan 10, 2017

bparees Jan 10, 2017

oatmealraisin Jan 10, 2017

bparees Jan 10, 2017

oatmealraisin Jan 10, 2017 •

edited

Loading

bparees Jan 10, 2017

bparees Jan 10, 2017

bparees Jan 10, 2017

bparees Jan 10, 2017

oatmealraisin commented Jan 10, 2017

bparees commented Jan 10, 2017

oatmealraisin commented Jan 10, 2017

ahardin-rh Jan 10, 2017

ahardin-rh Jan 10, 2017

ahardin-rh Jan 10, 2017

ahardin-rh commented Jan 10, 2017

oatmealraisin commented Jan 10, 2017

ahardin-rh commented Jan 10, 2017

Added notice for setting up external jenkins #3452

Added notice for setting up external jenkins #3452

Conversation

oatmealraisin commented Jan 6, 2017 • edited Loading

oatmealraisin commented Jan 9, 2017

ahardin-rh commented Jan 9, 2017

oatmealraisin commented Jan 9, 2017 • edited Loading

bparees commented Jan 9, 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

oatmealraisin commented Jan 9, 2017

bparees commented Jan 9, 2017

oatmealraisin commented Jan 10, 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

oatmealraisin Jan 10, 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

Choose a reason for hiding this comment

oatmealraisin commented Jan 10, 2017

bparees commented Jan 10, 2017

oatmealraisin commented Jan 10, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahardin-rh commented Jan 10, 2017

oatmealraisin commented Jan 10, 2017

ahardin-rh commented Jan 10, 2017

oatmealraisin commented Jan 6, 2017 •

edited

Loading

oatmealraisin commented Jan 9, 2017 •

edited

Loading

oatmealraisin Jan 10, 2017 •

edited

Loading