Skip to content

Added notice for setting up external jenkins #3452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 10, 2017
Merged

Added notice for setting up external jenkins #3452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions architecture/core_concepts/builds_and_image_streams.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,14 @@ Pipeline workflows are defined in a Jenkinsfile,
either embedded directly in the build configuration,
or supplied in a Git repository and referenced by the build configuration.

The first time a project defines a build configuration using a Pipeline strategy,
{product-title} instantiates a Jenkins server to execute the pipeline.
Subsequent Pipeline build configurations
in the project share this Jenkins server. For more details on how the Jenkins
server is deployed, see xref:../../install_config/configuring_pipeline_execution.adoc#overview[configuring pipeline execution].
The first time a project defines a build configuration using a Pipeline
strategy, {product-title} instantiates a Jenkins server to execute the
pipeline. Subsequent Pipeline build configurations in the project share this
Jenkins server.

For more details on how the Jenkins server is deployed and how to configure or
disable the autoprovisioning behavior, see
xref:../../install_config/configuring_pipeline_execution.adoc#overview[configuring pipeline execution].

[NOTE]
====
Expand Down
25 changes: 19 additions & 6 deletions install_config/configuring_pipeline_execution.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,25 @@ jenkinsPipelineConfig:
<5> Optional values to pass to the template during instantiation.
====

[IMPORTANT]
====
When a Pipeline build configuration is created,
{product-title} instantiates the `*jenkinsPipelineConfig*` template *only if*
no existing service name in the project matches the `*serviceName*` field.
This means `*serviceName*` must be chosen such that it is unique in the project.
When a Pipeline build configuration is created, {product-title} looks for a
Service matching `*serviceName*`. This means `*serviceName*` must be chosen
such that it is unique in the project. If no Service is found, {product-title}
instantiates the `*jenkinsPipelineConfig*` template. If this is not desirable
(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 are a cluster administrator, simply set `*autoProvisionEnabled*` to `*false*`.
This will disable autoprovisioning across the cluster.
* If you are an unpriviledged user, a Service must be created for {product-title}
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 that you point this new
service to your existing Jenkins server. See:
xref:../dev_guide/integrating_external_services.adoc#dev-guide-integrating-external-services[Integrating External Services]

The latter option could also be used to disable autoprovisioning in select
projects only.
====

// end::installconfig_configuring_pipeline_execution[]