Skip to content

Latest commit

 

History

History
367 lines (222 loc) · 9.04 KB

rolling-update-3f5d412.md

File metadata and controls

367 lines (222 loc) · 9.04 KB

rolling-update

The rolling-update command performs update of a Java application without downtime in one go.

Remember:

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.

Tip:

This documentation refers to SAP Business Technology Platform, Neo environment. If you are looking for documentation about other environments, see SAP Business Technology Platform ↗️.

Prerequisites

  • You have at least one application process that is not in use, see your compute unit quota.

  • The command can be used with compatible application changes only.

The rolling-update command performs the following steps:

  1. Deploys a new version of the application.
  2. Starts a new application process.
  3. Disables new connection requests for one of the old application processes.
  4. Waits for the given timeout.
  5. Stops the disabled application process.
  6. Repeats steps 2 to 5 for all remaining old application processes.
neo rolling-update --host <host> --account <subaccount_technical_name> --application <application_name> 
--source <file_location> --user <e-mail_or_user>

Parameters

To list all parameters available for this command, execute neo help rolling-update in the command line.

Required

-a, --account

Subaccount technical name

Type: string (up to 30 characters; lowercase letters and numbers, starting with a letter)

-b, --application

Application name

Type: string (up to 30 characters; lowercase letters and numbers, starting with a letter)

-s, --source

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.

Type: file location

-h, --host

Enter a region host.

Type: URL. For acceptable values, see Regions ↗️.

-p, --password

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.

Type: string

-u, --user

Use your email, SAP ID or user name

Type: string

Optional

--compression

Enable or disable gzip response compression

Default: off

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

--compressible-mime-type

A comma-separated list of MIME types for which compression will be used

Default: text/html, text/xml, text/plain

Condition: applicable if compression is enabled

--compression-min-size

Responses bigger than this value get compressed

Condition: applicable if compression is enabled

--connections

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.

Default: 1

Acceptable values: 1-6

Type: integer

--ev

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.

Type: --ev <KEY1>=<VALUE1> --ev <KEY2>=<VALUE2> , where a key-value pair specifies one environment variable

If you provide a key without any value (--ev <KEY1>=), the --ev parameter is ignored.

For a value that contains spaces, use quotation marks.

-j, --java-version

JRE version

Default: depends on the SDK for SAP BTP, Neo environment

Type: the version number of the JRE 7.

For more information, see Choose JRE Version

--timeout

Timeout before stopping the old application processes (in seconds)

Default: 60 seconds

-V, --vm-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

-z, --size

Compute Unit size:

lite, pro, prem, prem-plus

The compute unit size defines the default memory settings.

For more information, see Compute Units

Default:lite

--runtime-version

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.

Note:

If you choose your runtime version, consider its expiration date and plan updating to a new version regularly.

For more information, see Choose Application Runtime Version

--uri-encoding

Specifies the character encoding used to decode the URI bytes on application request.

Default: ISO-8859-1

For more information, see the encoding sets supported by Java SE 6 and Java SE 7.

Example

neo rolling-update --host us1.hana.ondemand.com --account mysubaccount --application myapp --source samples/deploy_war/example.war 
--user [email protected] --timeout 5

Related Information

deploy

Update Applications with Zero Downtime