elastic-cloud-enterprise.sh upgrade command

ECE

NAME

bash elastic-cloud-enterprise.sh upgrade — Upgrade an existing Elastic Cloud Enterprise installation to a new version.

SYNOPSIS

bash elastic-cloud-enterprise.sh upgrade
[--host-docker-host "PATH_NAME/docker.sock"]
[--docker-registry REGISTRY] [--ece-docker-repository REPOSITORY]
[--overwrite-existing-image] [--cloud-enterprise-version VERSION_NAME]
[--debug] [--timeout-factor NUMBER]
[--user USER_NAME] [--pass PASSWORD]
[--secrets PATH_TO_SECRETS_FILE]
[[--]help]

REQUIRED PRIVILEGES

To run this script, a user must be part of the docker group. The host that you run this script on must be the first host that you installed Elastic Cloud Enterprise on or a host that holds the director role.

DESCRIPTION

Upgrades an existing Elastic Cloud installation to a newer version.

PARAMETERS

--host-docker-host /PATH_NAME/docker.sock

Specifies the location of the Docker socket used to communicate with the Docker daemon. Defaults to /var/run/docker.sock.

--docker-registry REGISTRY

Specifies the Docker registry from where Elastic Cloud Enterprise assets are retrieved during installation. Defaults to docker.elastic.co.

--ece-docker-repository REPOSITORY

Specifies the docker repository prefix for Elastic Cloud Enterprise docker image. Defaults to cloud-enterprise

--overwrite-existing-image

Overwrites any existing local image when retrieving the Elastic Cloud Enterprise image from the repository. Defaults to false.

--cloud-enterprise-version VERSION_NAME

Specifies the version of Elastic Cloud Enterprise to install. Defaults to :version:.

--debug

If specified, outputs debugging information.

--timeout-factor NUMBER

If specified, increases all timeout values used during installation by multiplying with this number. Defaults to 1.0.

--user USER_NAME

A user with the Platform admin role. The admin user created during installation or one of the native users with the Platform admin role is sufficient.

--pass PASSWORD

The password for the user specified.

--secrets PATH_TO_SECRETS_FILE

An alternative to specifying user and pass. Specifies a path to a file with secrets. If not specified, attempts to use HOST_STORAGE_PATH/bootstrap-state/bootstrap-secrets.json, where HOST_STORAGE_PATH is the host storage path used by the Elastic Cloud Enterprise installation.

Upgrade an existing Elastic Cloud Enterprise installation to the latest version:

bash elastic-cloud-enterprise.sh upgrade --user admin --pass pGX5DwKzVAAIeCIpTwwAkCuJDu0ASdFP33UmYpfogfF

Upgrade an existing Elastic Cloud Enterprise installation to a specific version:

bash elastic-cloud-enterprise.sh upgrade --user admin --pass pGX5DwKzVAAIeCIpTwwAkCuJDu0ASdFP33UmYpfogf --cloud-enterprise-version 3.8.1