mirror of https://github.com/SAP/jenkins-library.git synced 2025-04-27 12:32:19 +02:00

move additional hints into markdown file (#2599 )

These hints are up to now provided as javadoc like comments
at the call method for cloudFoundryDeploy step. At that level
they are not taken into account by the go generator.

Is is not a suitable approach to include this kind of markdown
docu into the long description of the metadata file since this
long description is (also) used by the piper help command when
invoking piper cloudFoundyDeploy --help. At that point in time
markdown like text does not make sense.

2021-02-19 08:44:51 +01:00

1.9 KiB

Raw Blame History

${docGenStepName}

${docGenDescription}

Additional Hints

Deployment can be done

in a standard way
in a zero downtime manner (using a blue-green deployment approach)

!!! note "Deployment supports multiple deployment tools" Currently the following are supported:

* Standard `cf push` and [Bluemix blue-green plugin](https://github.com/bluemixgaragelondon/cf-blue-green-deploy#how-to-use)
* [MTA CF CLI Plugin](https://github.com/cloudfoundry-incubator/multiapps-cli-plugin)

!!! note Due to an incompatible change in the Cloud Foundry CLI, multiple buildpacks are not supported by this step. If your application contains a list of buildpacks instead a single buildpack, this will be automatically re-written by the step when blue-green deployment is used.

!!! note Cloud Foundry supports the deployment of multiple applications using a single manifest file. This option is supported with Piper. In this case define appName: '' since the app name for the individual applications have to be defined via the manifest. You can find details in the Cloud Foundry Documentation

Prerequisites

Cloud Foundry organization, space and deployment user are available
Credentials for deployment have been configured in Jenkins with a dedicated Id

${docGenParameters}

${docGenConfiguration}

${docJenkinsPluginDependencies}

Example

cloudFoundryDeploy(
    script: script,
    deployType: 'blue-green',
    cloudFoundry: [apiEndpoint: 'https://test.server.com', appName:'cfAppName', credentialsId: 'cfCredentialsId', manifest: 'cfManifest', org: 'cfOrg', space: 'cfSpace'],
    deployTool: 'cf_native'
)

1.9 KiB Raw Blame History