Type to search.

elastic-cloud-enterprise.sh upgrade command

ECE

Elastic Cloud Enterprise is a self-managed orchestration platform for deploying and managing the Elastic Stack at scale.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

NAME

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

SYNOPSIS

Shell 
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]
[--podman]
[[--]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 Use the built-in admin user.

--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.
--podman
Use this flag when upgrading ECE installations that use Podman as the container runtime instead of Docker.

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

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

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

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