github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/pkg/generator/helper/piper-context-defaults.yaml (about)

     1  metadata:
     2    name: context defaults
     3    description: These default descriptions will be used for the documentation generation of the pipeline steps.
     4    longDescription: |-
     5      These default descriptions will be used for the documentation generation of the pipeline steps for the context defaults.
     6  spec:
     7    inputs:
     8      params:
     9      - name: containerCommand
    10        description: 'Kubernetes only: Allows to specify start command for container created with dockerImage parameter to overwrite Piper default (/usr/bin/tail -f /dev/null).'
    11        type: string
    12        scope:
    13          - PARAMETERS
    14          - GENERAL
    15          - STAGES
    16          - STEPS
    17      - name: containerName
    18        description: Optional configuration in combination with containerMap to define the container where the commands should be executed in.
    19        type: string
    20        scope:
    21          - PARAMETERS
    22          - GENERAL
    23          - STAGES
    24          - STEPS
    25      - name: containerShell
    26        description: Allows to specify the shell to be executed for container with containerName.
    27        type: string
    28        scope:
    29          - PARAMETERS
    30          - GENERAL
    31          - STAGES
    32          - STEPS
    33      - name: dockerEnvVars
    34        description: 'Environment variables to set in the container, e.g. [http_proxy: "proxy:8080"].'
    35        type: map[string]string
    36        scope:
    37          - PARAMETERS
    38          - GENERAL
    39          - STAGES
    40          - STEPS
    41      - name: dockerImage
    42        description: Name of the docker image that should be used. If empty, Docker is not used and the command is executed directly on the Jenkins system.
    43        type: string
    44        scope:
    45          - PARAMETERS
    46          - GENERAL
    47          - STAGES
    48          - STEPS
    49      - name: dockerName
    50        description: 'Kubernetes only: Name of the container launching dockerImage. SideCar only: Name of the container in local network.'
    51        type: string
    52        scope:
    53          - PARAMETERS
    54          - GENERAL
    55          - STAGES
    56          - STEPS
    57      - name: dockerOptions
    58        description: Docker options to be set when starting the container.
    59        type: '[]string'
    60        scope:
    61          - PARAMETERS
    62          - GENERAL
    63          - STAGES
    64          - STEPS
    65      - name: dockerPullImage
    66        description: Set this to 'false' to bypass a docker image pull. Useful during development process. Allows testing of images which are available in the local registry only.
    67        type: bool
    68        scope:
    69          - PARAMETERS
    70          - GENERAL
    71          - STAGES
    72          - STEPS
    73      - name: dockerVolumeBind
    74        description: Volumes that should be mounted into the docker container.
    75        type: map[string]string
    76        scope:
    77          - PARAMETERS
    78          - GENERAL
    79          - STAGES
    80          - STEPS
    81      - name: dockerWorkspace
    82        description: 'Kubernetes only: Specifies a dedicated user home directory for the container which will be passed as value for environment variable `HOME`.'
    83        type: string
    84        scope:
    85          - PARAMETERS
    86          - GENERAL
    87          - STAGES
    88          - STEPS
    89      - name: sidecarCommand
    90        description: Allows to specify a start command for the sidecar container. This parameter is similar to `containerCommand`.
    91        type: string
    92        scope:
    93          - PARAMETERS
    94          - GENERAL
    95          - STAGES
    96          - STEPS
    97      - name: sidecarEnvVars
    98        description: A map of environment variables to set in the sidecar container, similar to `dockerEnvVars`.
    99        type: map[string]string
   100        scope:
   101          - PARAMETERS
   102          - GENERAL
   103          - STAGES
   104          - STEPS
   105      - name: sidecarImage
   106        description: The name of the docker image of the sidecar container. If empty, no sidecar container is started. Similar to  `dockerImage`.
   107        type: string
   108        scope:
   109          - PARAMETERS
   110          - GENERAL
   111          - STAGES
   112          - STEPS
   113      - name: sidecarName
   114        description: Name of the sidecar container. Similar to `dockerName`.
   115        type: string
   116        scope:
   117          - PARAMETERS
   118          - GENERAL
   119          - STAGES
   120          - STEPS
   121      - name: sidecarPullImage
   122        description: Set this to 'false' to bypass a docker image pull. Useful during development process. Allows testing of images which are available in the local registry only.
   123        type: bool
   124        scope:
   125          - PARAMETERS
   126          - GENERAL
   127          - STAGES
   128          - STEPS
   129      - name: sidecarReadyCommand
   130        description: Command executed inside the container which returns exit code 0 when the container is ready to be used.
   131        type: string
   132        scope:
   133          - PARAMETERS
   134          - GENERAL
   135          - STAGES
   136          - STEPS
   137      - name: sidecarOptions
   138        description: Options to be set when starting the sidecar container. Similar to `dockerOptions`.
   139        type: '[]string'
   140        scope:
   141          - PARAMETERS
   142          - GENERAL
   143          - STAGES
   144          - STEPS
   145      - name: sidecarVolumeBind
   146        description: Volumes that should be mounted into the sidecar container. Similar to `dockerVolumeBind`.
   147        type: map[string]string
   148        scope:
   149          - PARAMETERS
   150          - GENERAL
   151          - STAGES
   152          - STEPS
   153      - name: sidecarWorkspace
   154        type: string
   155        scope:
   156          - PARAMETERS
   157          - GENERAL
   158          - STAGES
   159          - STEPS
   160      - name: stashContent
   161        description: Specific stashes that should be considered for the step execution.
   162        type: '[]string'
   163        scope:
   164          - PARAMETERS
   165          - GENERAL
   166          - STAGES
   167          - STEPS