Deploying an application publishes it to SAP BTP. Use the optional parameters to make some specific configurations of the deployed application.
SAP Business Technology Platform, Neo environment will sunset on December 31, 2028, subject to terms of customer or partner contracts.
For more information, see SAP Note 3351844.
This documentation refers to SAP Business Technology Platform, Neo environment. If you are looking for documentation about other environments, see SAP Business Technology Platform
↗️ .
neo deploy --host <host> --account <subaccount_technical_name> --application <application_name>
--source <file_location> --user <e-mail_or_user>
To list all parameters available for this command, execute neo help deploy in the command line.
|
Required |
|
|---|---|
|
|
Subaccount technical name
|
|
|
Application name
|
|
|
A comma-separated list of file locations, pointing to WAR files, or folders containing them
If you want to deploy more than one application on one and the same application process, put all WAR files in the same folder and execute the deployment with this source, or specify them as a comma-separated list.
|
|
|
Enter a region host.
To deploy an application in more than one region, execute the deploy separately for each region host. |
|
|
To protect your password, enter it only when prompted by the console client and not explicitly as a parameter in the properties file or the command line.
|
|
|
Use your email, SAP ID, or username.
|
|
Optional |
|
|---|---|
|
Command-specific parameters |
|
|
|
The number of connections used to deploy an application. Use it to speed up deployment of application archives bigger than 5 MB in slow networks. Choose the optimal number of connections depending on the overall network speed to the cloud.
|
|
|
Deploys only the changes between the provided source and the deployed content. New content will be added; missing content will be deleted. Recommended for development use to speed up the deployment.
|
|
|
Environment variables for configuring the environment in which the application runs.
Sets one environment variable by removing the previously set value; can be used multiple times in one execution.
If you provide a key without any value (--ev <KEY1>=), the For a value that contains spaces, use quotation marks. |
|
|
Java/JRE major version number.
Each runtime has its own set of supported Java/JRE versions. See Application Runtime Container.
For more information, see Choose JRE Version. |
|
|
Minimum number of application processes, on which the application can be started
|
|
|
Maximum number of application processes, on which the application can be started
|
|
|
Java Virtual Machine arguments System properties (-D<name>=<value>) separated with space that will be used when starting the application process. Memory settings of your compute units. You can set the following memory parameters: -Xms, -Xmx, -XX:PermSize, -XX:MaxPermSize. We recommend that you use the default memory settings. Change them only if necessary and note that this may impact the application performance or its ability to start. For more information, see Configure VM Arguments. |
|
|
Compute unit size
For more information, see Compute Units. |
|
|
Application runtime Use the parameter if you want to choose an application runtime container different from the one coming with your SDK. To view all available runtime containers, use list-runtimes. For more information, see Application Runtime Container. If you specify
|
|
|
The runtime version on which the application will be started and will run on the same version after a restart. Otherwise, by default, the application is started on the latest minor version (of the same major version) which is backward compatible and includes the latest corrections (including security patches), enhancements, and updates. Note that choosing this option does not affect already started application processes. You can view the recommended versions by executing the list-runtime-versions command. This is a mapping between the runtime and the respective version:
For more information, see Choose Application Runtime Version. |
|
Tomcat connector attributes |
|
|
|
Enable or disable gzip response compression
Possible values: on (allow compression), off(disable compression), force (forces compression for all responses) or aninteger (which enables compression and specifies the compression-min-size value in bytes). For more information, see Enable and Configure Gzip Response Compression |
|
|
A comma separated list of MIME types for which compression is used
|
|
|
Responses bigger than this value get compressed
|
|
|
Defines the number of milliseconds to wait for the request URI line to be presented after accepting a connection.
|
|
|
Specifies the maximum number of simultaneous requests that can be handled
|
|
|
Specifies the character encoding used to decode the URI bytes on application request
For more information, see the encoding sets supported by Java SE 6 and Java SE 7. |
Here are examples of some additional configurations. If your application is already started, stop it and start it again for the changes to take effect.
You can deploy an application on a host different from the default one by specifying the host parameter. For example, to use the region (host) located in the United States, execute:
neo deploy --host us1.hana.ondemand.com --account mysubaccount --application myapp --source samples/deploy_war/example.war
--user [email protected]
Choose compute unit size
To specify the compute unit size on which you want the application to run, use the --size parameter with one of the following values:
- lite - Lite Edition
- pro - Professional edition
- prem - Premium edition
- prem-plus - Premium Plus edition
Available sizes depend on your subaccount type and what options you have purchased. For trial accounts, only the Lite edition is available.
For more information, see Compute Units.
For example, if you have an enterprise account and have purchased a package with Premium edition compute units, then you can run your application on a Premium compute unit size, by executing the following command:
neo deploy --size prem myapp.properties
Set the context root of an application
When deploying an application, name the WAR file with the desired context root.
For example, if you want to deploy your WAR in context root "/hello" then rename your WAR to hello.war.
If you want to deploy it in the "/" context root then rename your WAR to ROOT.war.
The context root is case-sensitive.
Specify character encoding
Using the–uri-encoding parameter, you can define the character encoding that will be used to decode the URI bytes on application request. For example, to use the UTF-8 encoding that can represent every character in the Unicode character set, execute
neo deploy --uri-encoding UTF-8 myapp.properties
Related Information
Console Client for the Neo Environment
Choose Application Runtime Version
Enable and Configure Gzip Response Compression
Deploying and Updating Java Applications