-
Notifications
You must be signed in to change notification settings - Fork 525
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc (jkube-kit/doc) : Update documentation to specify applicable buil…
…d strategy in build configuration options Signed-off-by: Rohan Kumar <[email protected]>
- Loading branch information
1 parent
688191f
commit 9329701
Showing
2 changed files
with
121 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
...ain/asciidoc/inc/build/_openshift_s2i_build_strategy_configuration_entries.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
|*openshiftForcePull* | ||
| While creating a BuildConfig, By default, if the builder image specified in the | ||
build configuration is available locally on the node, that image will be used. | ||
|
||
Using openshiftForcePull will override the local image and refresh it from the registry the image stream points to. | ||
|
||
This field is applicable in case of `s2i` build strategy. | ||
|
||
| *openshiftPullSecret* | ||
| The name to use for naming pullSecret to be created to pull the base image in case pulling from a private registry | ||
which requires authentication for OpenShift. | ||
|
||
The default value for pull registry will be picked from `jkube.docker.pull.registry`/`jkube.docker.registry`. | ||
|
||
This field is applicable in case of `s2i` build strategy. | ||
|
||
| *openshiftPushSecret* | ||
| The name of pushSecret to be used to push the final image in case pushing from a | ||
protected registry which requires authentication. | ||
|
||
This field is applicable in case of `s2i` build strategy. | ||
|
||
| *openshiftBuildOutputKind* | ||
| Allow to specify in which registry to push the container image at the end of the build. | ||
If the output kind is ImageStreamTag, then the image will be pushed to the internal OpenShift registry. | ||
If the output is of type DockerImage, then the name of the output reference will be used as a Docker push specification. | ||
The default value is `ImageStreamTag` | ||
|
||
|
||
This field is applicable in case of `s2i` build strategy. | ||
|
||
| *openshiftS2iBuildNameSuffix* | ||
| The S2I binary builder BuildConfig name suffix appended to the image name to avoid | ||
clashing with the underlying BuildConfig for the Jenkins pipeline | ||
|
||
This field is applicable in case of `s2i` build strategy. | ||
|
||
| *openshiftS2iImageStreamLookupPolicyLocal* | ||
| Allow the ImageStream used in the S2I binary build to be used in standard | ||
Kubernetes resources such as Deployment or StatefulSet. | ||
|
||
This field is applicable in case of `s2i` build strategy. | ||
|
||
| *openshiftBuildRecreateMode* | ||
a| If the build is performed in an OpenShift cluster then this option decides how the OpenShift resource objects | ||
associated with the build should be treated when they already exist: | ||
|
||
* `buildConfig` or `bc` : Only the BuildConfig is recreated | ||
* `imageStream` or `is` : Only the ImageStream is recreated | ||
* `all` : Both, BuildConfig and ImageStream are recreated | ||
* `none` : Neither BuildConfig nor ImageStream is recreated | ||
The default is `none`. If you provide the property without value then `all` is assumed, so everything gets recreated. | ||
|
||
This field is applicable in case of `s2i` build strategy. |