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

${docGenStepName}

${docGenDescription}

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).

${docGenParameters}

${docGenConfiguration}

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