Upgrades an existing application replica set to a different release, by default to the latest master build. The master and the replicas of the set are re-deployed with the requested release, one after the other, so that the master and n-1 replicas remain available for reading while a single process is being upgraded, where n is the number of replicas in the set at the time the request is made. Because upgrading re-deploys and restarts the processes, doing so interrupts any race that is being tracked live on the set; see the force parameter below.
| Webservice Type: | POST |
| Output format: | json |
| Mandatory query parameters: |
regionId, region where the replica set is located, e.g., eu-west-1
replicaSetName, name of the replica set; used as the hostname to which the domain name is appended, as well as
for the database and RabbitMQ exchange name
|
| Optional form parameters: |
releaseName, the release name to upgrade to, such as build-202108091125; if not provided, the latest master
build is used by default.
keyName, the name of the SSH key to use; must identify an existing SSH key by that name in the region specified
and will be used to log on to existing and new instances using a root ssh connection. If not specified, the
key used to launch an instance will be used for trying to connect to it, and a private key with matching name
for the respective region will be looked up.
privateKeyEncryptionPassphrase, the pass phrase to decrypt the private key for the key specified by the keyName parameter
replicaReplicationBearerToken, the bearer token the replica set's replicas will use to replicate their master server; defaults to the
bearer token of the user authenticated for this request. Note that this requires the
server processing this request to share the security information from security-service.sapsailing.com, too.
timeoutInMilliseconds, timeout in milliseconds to wait for responses from nodes when analyzing the replica sets
existing in the region; if not specified, waiting will not time out.
force, boolean value defaulting to false. Before upgrading, the replica set is checked for
live content, that is, races that are currently being tracked live. Since upgrading re-deploys and
restarts the master and replica processes, doing so while a race is tracked live would interrupt that live
tracking. If live content is detected and force is false (the default), the upgrade is
aborted and the service responds with HTTP status 409 Conflict and a JSON body describing the
offending replica set, events and races (the body has the same structure as the response of the
live-content service). Set
force to true to bypass this safety check and upgrade the replica set regardless of any
live content, knowingly accepting the disruption of any live tracking.
|
| Request method: | POST |
| Example: | curl -X POST -d 'regionId=eu-west-2' -d 'replicaSetName=mynewevent' -d 'releaseName=build-202112151552' -d 'keyName=Horst' --data-urlencode 'privateKeyEncryptionPassphrase=HorstsSuperSecretPassword' -H 'Authorization: Bearer RwGK+DV38LKjeuDu+Bx87/3blLJHD7Ff+NCLeud9nRQ=' "https://sapsailing.com/sailinglandscape/api/landscape/upgradeapplicationreplicaset" produces output:
{
"status": "OK",
"release": "build-202112151552"
}
|