mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-04-13 11:50:43 +02:00
9a60143153
Co-authored-by: Ralf Pannemans <ralf.pannemans@sap.com> Co-authored-by: Philipp Stehle <philipp.stehle@sap.com> Co-authored-by: Pavel Busko <pavel.busko@sap.com> Co-authored-by: Jan von Löwenstein <jan.von.loewenstein@sap.com>
71 lines
2.0 KiB
Markdown
71 lines
2.0 KiB
Markdown
# ${docGenStepName}
|
|
|
|
## ${docGenDescription}
|
|
|
|
see [Examples](#examples)
|
|
|
|
## Prerequisites
|
|
|
|
When pushing to a container registry, you need to maintain the respective credentials in your Jenkins credentials store:
|
|
|
|
`cnbBuild` expects a Docker `config.json` file containing the credential information for registries.
|
|
You can create it like explained in the [protocodeExecuteScan Prerequisites section](https://www.project-piper.io/steps/protecodeExecuteScan/#prerequisites).
|
|
|
|
Please copy this file and upload it to your Jenkins for example<br />
|
|
via _Jenkins_ -> _Credentials_ -> _System_ -> _Global credentials (unrestricted)_ -> _Add Credentials_ ->
|
|
|
|
* Kind: _Secret file_
|
|
* File: upload your `config.json` file
|
|
* ID: specify id which you then use for the configuration of `dockerConfigJsonCredentialsId` (see below)
|
|
|
|
## ${docGenParameters}
|
|
|
|
### Additional hints
|
|
|
|
To run the `cnbBuild` with a different builder, you can specify the `dockerImage` parameter.
|
|
Without specifying it, the step will run with the `paketobuildpacks/builder:full` builder.
|
|
|
|
## ${docGenConfiguration}
|
|
|
|
## ${docJenkinsPluginDependencies}
|
|
|
|
## Examples
|
|
|
|
### Example 1: simple usage
|
|
|
|
```groovy
|
|
cnbBuild(
|
|
script: script,
|
|
dockerConfigJsonCredentialsId: 'DOCKER_REGISTRY_CREDS',
|
|
containerImageName: 'images/example',
|
|
containerImageTag: 'v0.0.1',
|
|
containerImageRegistryUrl: 'gcr.io'
|
|
)
|
|
```
|
|
|
|
### Example 2: User provided builder
|
|
|
|
```groovy
|
|
cnbBuild(
|
|
script: script,
|
|
dockerConfigJsonCredentialsId: 'DOCKER_REGISTRY_CREDS',
|
|
dockerImage: 'paketobuildpacks/builder:base',
|
|
containerImageName: 'images/example',
|
|
containerImageTag: 'v0.0.1',
|
|
containerImageRegistryUrl: 'gcr.io'
|
|
)
|
|
```
|
|
|
|
### Example 3: User provided buildpacks
|
|
|
|
```groovy
|
|
cnbBuild(
|
|
script: script,
|
|
dockerConfigJsonCredentialsId: 'DOCKER_REGISTRY_CREDS',
|
|
containerImageName: 'images/example',
|
|
containerImageTag: 'v0.0.1',
|
|
containerImageRegistryUrl: 'gcr.io',
|
|
buildpacks: ['gcr.io/paketo-buildpacks/nodejs', 'paketo-community/build-plan']
|
|
)
|
|
```
|