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

     1  metadata:
     2    name: xsDeploy
     3    description: Performs xs deployment
     4    longDescription: |
     5      Performs xs deployment
     6  spec:
     7    inputs:
     8      secrets:
     9        - name: credentialsId
    10          description: Jenkins 'Username with password' credentials ID containing username/password for accessing xs endpoint.
    11          type: jenkins
    12      params:
    13        - name: deployOpts
    14          type: string
    15          description: Additional options appended to the deploy command. Only needed for sophisticated cases. When provided it is the duty of the provider to ensure proper quoting / escaping.
    16          scope:
    17            - PARAMETERS
    18            - STAGES
    19            - STEPS
    20          default:
    21        - name: operationIdLogPattern
    22          type: string
    23          description: Regex pattern for retrieving the ID of the operation from the xs log.
    24          scope:
    25            - PARAMETERS
    26            - STAGES
    27            - STEPS
    28          default: ^.*xs bg-deploy -i (.*) -a.*$
    29          aliases:
    30            - name: deployIdLogPattern
    31        - name: mtaPath
    32          type: string
    33          description: Path to deployable
    34          scope:
    35            - PARAMETERS
    36            - STAGES
    37            - STEPS
    38          mandatory: true
    39          resourceRef:
    40            - name: commonPipelineEnvironment
    41              param: mtaPath
    42        - name: action
    43          type: string
    44          description: Used for finalizing the blue-green deployment.
    45          default: NONE
    46          possibleValues:
    47            - NONE
    48            - Resume
    49            - Abort
    50            - Retry
    51          scope:
    52            - PARAMETERS
    53            - STAGES
    54            - STEPS
    55        - name: mode
    56          type: string
    57          description: "Controls if there is a standard deployment or a blue green deployment. Values: 'DEPLOY', 'BG_DEPLOY'"
    58          default: DEPLOY
    59          possibleValues:
    60            - NONE
    61            - DEPLOY
    62            - BG_DEPLOY
    63          scope:
    64            - PARAMETERS
    65            - STAGES
    66            - STEPS
    67          mandatory: true
    68        - name: operationId
    69          type: string
    70          description: The operation ID. Used in case of bg-deploy in order to resume or abort a previously started deployment.
    71          default:
    72          scope:
    73            - PARAMETERS
    74            - STAGES
    75            - STEPS
    76          resourceRef:
    77            - name: commonPipelineEnvironment
    78              param: operationId
    79        - name: apiUrl
    80          type: string
    81          description: The api url (e.g. https://example.org:12345
    82          scope:
    83            - PARAMETERS
    84            - STAGES
    85            - STEPS
    86          mandatory: true
    87        - name: username
    88          aliases:
    89            - name: user
    90              deprecated: true
    91          type: string
    92          description: Username
    93          scope:
    94            - PARAMETERS
    95            - STAGES
    96            - STEPS
    97          secret: true
    98          mandatory: true
    99          resourceRef:
   100            - name: credentialsId
   101              type: secret
   102              param: username
   103        - name: password
   104          type: string
   105          description: Password
   106          scope:
   107            - PARAMETERS
   108            - STAGES
   109            - STEPS
   110          secret: true
   111          mandatory: true
   112          resourceRef:
   113            - name: credentialsId
   114              type: secret
   115              param: password
   116        - name: org
   117          type: string
   118          description: The org
   119          scope:
   120            - PARAMETERS
   121            - STAGES
   122            - STEPS
   123          mandatory: true
   124        - name: space
   125          type: string
   126          description: The space
   127          scope:
   128            - PARAMETERS
   129            - STAGES
   130            - STEPS
   131          mandatory: true
   132        - name: loginOpts
   133          type: string
   134          description: Additional options appended to the login command. Only needed for sophisticated cases. When provided it is the duty of the provider to ensure proper quoting / escaping.
   135          scope:
   136            - PARAMETERS
   137            - STAGES
   138            - STEPS
   139          mandatory: true
   140        - name: xsSessionFile
   141          type: string
   142          description: The file keeping the xs session.
   143          scope:
   144            - PARAMETERS
   145            - STAGES
   146            - STEPS
   147    outputs:
   148      resources:
   149        - name: commonPipelineEnvironment
   150          type: piperEnvironment
   151          params:
   152            - name: operationId
   153    containers:
   154      - name: xs
   155        image: ppiper/xs-cli