A newer version is available. For the latest information, see the
current release documentation.
elastic-cloud-enterprise.sh upgrade
edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.
elastic-cloud-enterprise.sh upgrade
editNAME
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. Theadmin
user created during installation or one of the native users with thePlatform admin
role is sufficient. -
--pass
PASSWORD
-
The password for the
user
specified. -
--secrets
PATH_TO_SECRETS_FILE
-
An alternative to specifying
user
andpass
. Specifies a path to a file with secrets. If not specified, attempts to useHOST_STORAGE_PATH/bootstrap-state/bootstrap-secrets.json
, whereHOST_STORAGE_PATH
is the host storage path used by the Elastic Cloud Enterprise installation.
Example
editUpgrade an existing Elastic Cloud Enterprise installation to the latest version:
bash elastic-cloud-enterprise.sh upgrade --user admin --pass pGX5DwKzVAAIeCIpTwwAkCuJDu0ASdFP33UmYpfogf
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.6.2