sap-jenkins-library/documentation/docs/steps/neoDeploy.md

neoDeploy

Description

Deploys an Application to SAP Cloud Platform (SAP CP) using the SAP Cloud Platform Console Client (Neo Java Web SDK).

Before doing this, validates that SAP Cloud Platform Console Client is installed and the version is compatible.

Note that a version is formed by major.minor.patch, and a version is compatible to another version if the minor and patch versions are higher, but the major version is not, e.g. if 3.39.10 is the expected version, 3.39.11 and 3.40.1 would be compatible versions, but 4.0.1 would not be a compatible version.

Prerequisites

• SAP CP account - the account to where the application is deployed.
• SAP CP user for deployment - a user with deployment permissions in the given account.
• Jenkins credentials for deployment - must be configured in Jenkins credentials with a dedicated Id.

• Neo Java Web SDK 3.39.10 or compatible version - can be downloaded from Maven Central. This step is capable of triggering the neo deploy tool provided inside a docker image. We provide docker image ppiper/neo-cli. neo.sh needs to be contained in path, e.g by adding a symbolic link to /usr/local/bin.

• Java 8 or compatible version - needed by the Neo-Java-Web-SDK. Java environment needs to be properly configured (JAVA_HOME, java exectutable contained in path).

Parameters when using MTA deployment method (default - MTA)

parameter	mandatory	default	possible values
script	yes
neo	no
deployMode	yes	'mta'	'mta', 'warParams', 'warPropertiesFile'
neoHome	no
source	no

The parameter neo is a map which contains the following parameters:

parameter	mandatory	default	possible values
account	no
credentialsId	no	'CI_CREDENTIALS_ID'
host	no

Parameters when using WAR file deployment method with .properties file (WAR_PROPERTIESFILE)

parameter	mandatory	default	possible values
script	yes
neo	no
deployMode	yes	'mta'	'mta', 'warParams', 'warPropertiesFile'
neoHome	no
source	no
warAction	yes	'deploy'	'deploy', 'rolling-update'

The parameter neo is a map which contains the following parameters:

parameter	mandatory	default	possible values
credentialsId	no	'CI_CREDENTIALS_ID'
propertiesFile	yes

Parameters when using WAR file deployment method without .properties file - with parameters (WAR_PARAMS)

parameter	mandatory	default	possible values
script	yes
neo	no
deployMode	yes	'mta'	'mta', 'warParams', 'warPropertiesFile'
neoHome	no
source	no
warAction	yes	'deploy'	'deploy', 'rolling-update'

The parameter neo is a map which contains the following parameters:

parameter	mandatory	default	possible values
account	yes
application	yes
credentialsId	no	'CI_CREDENTIALS_ID'
environment
host	yes
runtime	yes
runtimeVersion	yes
size	no	'lite'	'lite', 'pro', 'prem', 'prem-plus'
vmArguments

• script - The common script environment of the Jenkinsfile run. Typically this is passed to this parameter. This allows the function to access the commonPipelineEnvironment for retrieving e.g. configuration parameters.
• deployMode - The deployment mode which should be used. Available options are 'mta' (default), 'warParams' (deploying WAR file and passing all the deployment parameters via the function call) and 'warPropertiesFile' (deploying WAR file and putting all the deployment parameters in a .properties file)
• neoHome - The path to the neo-java-web-sdk tool used for SAP CP deployment. If no parameter is provided, the path is retrieved from the environment variables using the environment variable NEO_HOME. If no parameter and no environment variable is provided, the path is retrieved from the step configuration using the step configuration key neoHome. If the previous configurations are not provided, the tool is expected on the PATH, and if it is not available on the PATH an AbortException is thrown.
• source- The path to the archive for deployment to SAP CP. If not provided mtarFilePath from commom pipeline environment is used instead.
• warAction - Action mode when using WAR file mode. Available options are deploy (default) and rolling-update which performs update of an application without downtime in one go.

The parameters for neo:

• account - The SAP Cloud Platform account to deploy to.
• application - Name of the application you want to manage, configure, or deploy
• credentialsId - The Jenkins credentials containing user and password used for SAP CP deployment.
• environment - Map of environment variables in the form of KEY: VALUE
• host - The SAP Cloud Platform host to deploy to.
• propertiesFile - The path to the .properties file in which all necessary deployment properties for the application are defined.
• runtime - Name of SAP Cloud Platform application runtime
• runtimeVersion - Version of SAP Cloud Platform application runtime
• size - Compute unit (VM) size. Acceptable values: lite, pro, prem, prem-plus.
• vmArguments - String of VM arguments passed to the JVM

The step is prepared for being executed in docker. The corresponding parameters can be applied. See step dockerExecute for details.

Step configuration

The parameter neo including all options can also be specified as a global parameter using the global configuration file.

The following parameters can also be specified as step parameters using the global configuration file:

• dockerImage
• neoHome
• source

Side effects

none

Exceptions

• Exception:
  • If source is not provided.
  • If propertiesFile is not provided (when using 'WAR_PROPERTIESFILE' deployment mode).
  • If application is not provided (when using 'WAR_PARAMS' deployment mode).
  • If runtime is not provided (when using 'WAR_PARAMS' deployment mode).
  • If runtimeVersion is not provided (when using 'WAR_PARAMS' deployment mode).
• AbortException:
  • If neo-java-web-sdk is not installed, or neoHomeis wrong.
• CredentialNotFoundException:
  • If the credentials cannot be resolved.

Example

neoDeploy script: this, source: 'path/to/archiveFile.mtar', neo: [credentialsId: 'my-credentials-id', host: hana.example.org]

Example configuration:

steps:
  <...>
  neoDeploy:
    deployMode: mta
    neo:
      account: <myDeployAccount>
      host: hana.example.org