github.com/jaylevin/jenkins-library@v1.230.4/resources/metadata/containerSaveImage.yaml (about)

     1  metadata:
     2    name: containerSaveImage
     3    description: Saves a container image as a tar file
     4    longDescription: |-
     5      This step allows you to save a container image, for example a Docker image into a tar file.
     6  
     7      It can be used no matter if a Docker daemon is available or not. It will also work inside a Kubernetes cluster without access to a daemon.
     8  spec:
     9    inputs:
    10      secrets:
    11        - name: dockerConfigJsonCredentialsId
    12          description: Jenkins 'Secret file' credentials ID containing Docker config.json (with registry credential(s)). You can find more details about the Docker credentials in the [Docker documentation](https://docs.docker.com/engine/reference/commandline/login/).
    13          type: jenkins
    14          aliases:
    15            - name: dockerCredentialsId
    16              deprecated: true
    17      params:
    18        - name: containerRegistryUrl
    19          aliases:
    20            - name: dockerRegistryUrl
    21          type: string
    22          description: "For `buildTool: docker`: Url of the container registry - typically provided by the CI/CD environment."
    23          mandatory: true
    24          resourceRef:
    25            - name: commonPipelineEnvironment
    26              param: container/registryUrl
    27          scope:
    28            - GENERAL
    29            - PARAMETERS
    30            - STAGES
    31            - STEPS
    32        - name: containerImage
    33          aliases:
    34            - name: dockerImage
    35            - name: scanImage
    36          type: string
    37          description: Container image to be saved.
    38          mandatory: true
    39          resourceRef:
    40            - name: commonPipelineEnvironment
    41              param: container/imageNameTag
    42          scope:
    43            - GENERAL
    44            - PARAMETERS
    45            - STAGES
    46            - STEPS
    47        - name: containerRegistryPassword
    48          description: "For `buildTool: docker`: Password for container registry access - typically provided by the CI/CD environment."
    49          type: string
    50          scope:
    51            - PARAMETERS
    52            - STAGES
    53            - STEPS
    54          secret: true
    55          resourceRef:
    56            - name: commonPipelineEnvironment
    57              param: container/repositoryPassword
    58            - name: commonPipelineEnvironment
    59              param: custom/repositoryPassword
    60        - name: containerRegistryUser
    61          description: "For `buildTool: docker`: Username for container registry access - typically provided by the CI/CD environment."
    62          type: string
    63          scope:
    64            - PARAMETERS
    65            - STAGES
    66            - STEPS
    67          secret: true
    68          resourceRef:
    69            - name: commonPipelineEnvironment
    70              param: container/repositoryUsername
    71            - name: commonPipelineEnvironment
    72              param: custom/repositoryUsername
    73        - name: filePath
    74          type: string
    75          description: The path to the file to which the image should be saved.
    76          scope:
    77            - PARAMETERS
    78            - STAGES
    79            - STEPS
    80        - name: dockerConfigJSON
    81          type: string
    82          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/).
    83          scope:
    84            - PARAMETERS
    85            - STAGES
    86            - STEPS
    87          secret: true
    88          resourceRef:
    89            - name: commonPipelineEnvironment
    90              param: custom/dockerConfigJSON
    91            - name: dockerConfigJsonCredentialsId
    92              type: secret
    93            - type: vaultSecretFile
    94              name: dockerConfigFileVaultSecretName
    95              default: docker-config
    96        - name: imageFormat
    97          type: string
    98          description: Format of the image when saving the docker image locally.
    99          scope:
   100            - PARAMETERS
   101            - STAGES
   102            - STEPS
   103          default: legacy
   104          possibleValues:
   105            - tarball
   106            - oci
   107            - legacy