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

     1  metadata:
     2    name: abapEnvironmentPushATCSystemConfig
     3    description: Create/Update ATC System Configuration
     4    longDescription: |
     5      This step is for creating/updating an [ATC](https://help.sap.com/products/BTP/65de2977205c403bbc107264b8eccf4b/657285a09f7148d894c27bb8e17827cf.html?version=Cloud) system configurationon on an SAP BTP, ABAP Environment system.
     6      Please provide either of the following options:
     7  
     8      * The host and credentials the SAP BTP, ABAP Environment system itself. The credentials must be configured for the Communication Scenario [SAP_COM_0763](https://help.sap.com/products/BTP/65de2977205c403bbc107264b8eccf4b/657285a09f7148d894c27bb8e17827cf.html?version=Cloud).
     9      * The Cloud Foundry parameters (API endpoint, organization, space), credentials, the service instance for the ABAP service and the service key for the Communication Scenario SAP_COM_0763.
    10      * Only provide one of those options with the respective credentials. If all values are provided, the direct communication (via host) has priority.
    11  
    12  spec:
    13    inputs:
    14      secrets:
    15        - name: abapCredentialsId
    16          aliases:
    17            - name: cfCredentialsId
    18          description: Jenkins credentials ID containing user and password to authenticate to the SAP BTP, ABAP Environment system or the Cloud Foundry API
    19          type: jenkins
    20      params:
    21        - name: atcSystemConfigFilePath
    22          type: string
    23          description: Path to a JSON file with ATC System Configuration
    24          scope:
    25            - PARAMETERS
    26            - STAGES
    27            - STEPS
    28          mandatory: true
    29        - name: patchIfExisting
    30          type: bool
    31          description: In case an configuration under the given name already exists in the system. Should the step update/patch the existing ATC Systm Configuration from the provided ATC System Configuration file?
    32          scope:
    33            - PARAMETERS
    34            - STAGES
    35            - STEPS
    36          default: true
    37        - name: cfApiEndpoint
    38          type: string
    39          description: Cloud Foundry API endpoint
    40          scope:
    41            - PARAMETERS
    42            - STAGES
    43            - STEPS
    44            - GENERAL
    45          mandatory: false
    46          aliases:
    47            - name: cloudFoundry/apiEndpoint
    48        - name: cfOrg
    49          type: string
    50          description: CF org
    51          scope:
    52            - PARAMETERS
    53            - STAGES
    54            - STEPS
    55            - GENERAL
    56          mandatory: false
    57          aliases:
    58            - name: cloudFoundry/org
    59        - name: cfServiceInstance
    60          type: string
    61          description: Parameter of ServiceInstance Name to delete CloudFoundry Service
    62          scope:
    63            - PARAMETERS
    64            - STAGES
    65            - STEPS
    66            - GENERAL
    67          mandatory: false
    68          aliases:
    69            - name: cloudFoundry/serviceInstance
    70        - name: cfServiceKeyName
    71          type: string
    72          description: Parameter of CloudFoundry Service Key to be created
    73          scope:
    74            - PARAMETERS
    75            - STAGES
    76            - STEPS
    77            - GENERAL
    78          mandatory: false
    79          aliases:
    80            - name: cloudFoundry/serviceKey
    81            - name: cloudFoundry/serviceKeyName
    82            - name: cfServiceKey
    83        - name: cfSpace
    84          type: string
    85          description: CF Space
    86          scope:
    87            - PARAMETERS
    88            - STAGES
    89            - STEPS
    90            - GENERAL
    91          mandatory: false
    92          aliases:
    93            - name: cloudFoundry/space
    94        - name: username
    95          type: string
    96          description: User for either the Cloud Foundry API or the Communication Arrangement for SAP_COM_0763
    97          scope:
    98            - PARAMETERS
    99            - STAGES
   100            - STEPS
   101          mandatory: true
   102          secret: true
   103          resourceRef:
   104            - name: abapCredentialsId
   105              type: secret
   106              param: username
   107        - name: password
   108          type: string
   109          description: Password for either the Cloud Foundry API or the Communication Arrangement for SAP_COM_0763
   110          scope:
   111            - PARAMETERS
   112            - STAGES
   113            - STEPS
   114          mandatory: true
   115          secret: true
   116          resourceRef:
   117            - name: abapCredentialsId
   118              type: secret
   119              param: password
   120        - name: host
   121          type: string
   122          description: Specifies the host address of the SAP SAP BTP, ABAP Environment system
   123          scope:
   124            - PARAMETERS
   125            - STAGES
   126            - STEPS
   127            - GENERAL
   128          mandatory: false
   129  
   130    containers:
   131      - name: cf
   132        image: ppiper/cf-cli:7