mirror of https://github.com/SAP/jenkins-library.git synced 2025-07-05 00:59:01 +02:00

Files

Daniel Mieg fa75c1ce1c Improve documentation for cloudFoundryCreateServiceKey (#1059 )

* Improve documentation for cfCreateServiceKey
* Add service instance to prerequisites

2019-12-16 20:44:15 +00:00

887 B

Raw Blame History

${docGenStepName}

${docGenDescription}

Prerequisites

Cloud Foundry API endpoint, organization, space, user and service instance are available
Credentials have been configured in Jenkins with a dedicated Id

${docGenParameters}

${docGenConfiguration}

${docJenkinsPluginDependencies}

Example

The following example creates a service key named "myServiceKey" for the service instance "myServiceInstance" in the provided cloud foundry organization and space. For the service key creation, the serviceKeyConfig is used.

cloudFoundryCreateServiceKey(
  script: this,
  cloudFoundry: [
      apiEndpoint: 'https://test.server.com',
      credentialsId: 'cfCredentialsId',
      org: 'cfOrg',
      space: 'cfSpace',
      serviceInstance: 'myServiceInstance',
      serviceKey: 'myServiceKey',
      serviceKeyConfig: '{ \"key\" : \"value\" }'
  ])

887 B Raw Blame History