Executes a [Kaniko](https://github.com/GoogleContainerTools/kaniko) build for creating a Docker container.
### Building multiple container images
The step allows you to build multiple container images with one run.
This is suitable in case you need to create multiple images for one microservice, e.g. for testing.
All images will get the same "root" name and the same versioning.<br />
**Thus,this is not suitable to be used for a monorepo approach!** For monorepos you need to use a build tool natively capable to take care for monorepos
or implement a custom logic and for example execute this `kanikoExecute` step multiple times in your custom pipeline.
description:Jenkins 'Secret file' credentials ID containing Docker config.json (with registry credential(s)). You can create it like explained in the [protocodeExecuteScan Prerequisites section](https://www.project-piper.io/steps/protecodeExecuteScan/#prerequisites).
description:Build settings info is typically filled by the step automatically to create information about the build settings that were used during the mta build. This information is typically used for compliance related processes.
description:Deprected, please use buildOptions. Defines the build options for the [kaniko](https://github.com/GoogleContainerTools/kaniko) build.
scope:
- PARAMETERS
- STAGES
- STEPS
- name:containerImage
aliases:
- name:containerImageNameAndTag
deprecated:true
type:string
description:Defines the full name of the Docker image to be created including registry, image name and tag like `my.docker.registry/path/myImageName:myTag`. If left empty, image will not be pushed.
description:Defines if multiple containers should be build. Dockerfiles are used using the pattern **/Dockerfile*. Excludes can be defined via [`containerMultiImageBuildExcludes`](#containermultiimagebuildexscludes).
scope:
- GENERAL
- PARAMETERS
- STAGES
- STEPS
- name:containerMultiImageBuildExcludes
type:'[]string'
description:Defines a list of Dockerfile paths to exclude from the build when using [`containerMultiImageBuild`](#containermultiimagebuild).
scope:
- GENERAL
- PARAMETERS
- STAGES
- STEPS
- name:containerMultiImageBuildTrimDir
type:'string'
description:Defines a trailing directory part which should not be considered in the final image name.
description:Defines the command to prepare the Kaniko container. By default the contained credentials are removed in order to allow anonymous access to container registries.
description:Username of the Container registry where the image should be pushed to - which will updated in a docker config json file. If a docker config json file is provided via parameter `dockerConfigJSON` , then the existing file will be enhanced
scope:
- GENERAL
- PARAMETERS
- STAGES
- STEPS
resourceRef:
- name:commonPipelineEnvironment
param:container/repositoryUsername
- name:containerRegistryPassword
aliases:
- name:dockerRegistryPassword
type:string
description:Password of the Container registry where the image should be pushed to - which will updated in a docker config json file. If a docker config json file is provided via parameter `dockerConfigJSON` , then the existing file will be enhanced
description:List containing download links of custom TLS certificates. This is required to ensure trusted connections to registries with custom certificates.
scope:
- PARAMETERS
- STAGES
- STEPS
- name:dockerConfigJSON
type:string
description:Path to the file `.docker/config.json` - this is typically provided by your CI/CD system. You can find more details about the Docker credentials in the [Docker documentation](https://docs.docker.com/engine/reference/commandline/login/).
