Skip to main content

upgrade (Beta)

This topic describes the options available with the Embedded Cluster upgrade command. For procedural steps, see Perform updates in embedded clusters.

Usage​

sudo ./<app-slug> upgrade --license <path-to-license> [flags]

Flags​

FlagTypeDescription
--config-valuesstringPath to the ConfigValues file for headless upgrades.
--forceStart a new upgrade even if a previous upgrade has not completed. Use this to retry after an upgrade that failed or was interrupted, because the incomplete revision otherwise blocks a new attempt. The upgrade command tells you when this flag is needed. Do not use it to start a second upgrade while one is genuinely still running.
--force-skip-ha-migration-checkSkip checks related to high availability (HA) migration. Use with caution.
--headlessRun the upgrade without the interactive installer UI.
--hostnamestringHostname to use for this node.
--ignore-app-preflightsBypass application preflight check failures. The checks still run. Applies to headless installations only, and does not override a check that the application vendor marked as required with strict: true. See Whether users can bypass a failed check.
--ignore-host-preflightsBypass Embedded Cluster host preflight check failures. The checks still run. Applies to headless installations only. See Whether users can bypass a failed check.
--installer-passwordstringPassword for the installer UI.
--installer-portintDeprecated. Omit this flag. If you pass it, it must match the port that the cluster already uses, or the upgrade fails. The upgrade serves the installer UI on the cluster's API port.
-l, --licensestringPath to the license file.
--registrystringUpdate the customer-managed (BYO) OCI registry address, in the form host[:port][/namespace]. Pass --registry="" to disable BYO and revert to the default registry. Omit the flag to leave the current registry address unchanged. For more information, see Change BYO registry configuration on upgrade.
--registry-usernamestringUpdate the username for the BYO registry. Pass --registry-username="" to clear the value. Omit the flag to leave it unchanged.
--registry-passwordstringUpdate the password for the BYO registry. Pass --registry-password="" to clear the value. Omit the flag to leave it unchanged.
--registry-ca-certstringUpdate the path to a PEM-encoded CA certificate used to verify the BYO registry's TLS certificate. Pass --registry-ca-cert="" to remove the CA certificate and fall back to the host's system trust store. Omit the flag to leave it unchanged.
--registry-tls-certstringUpdate the path to a PEM-encoded client certificate presented to the BYO registry for mTLS authentication. Pass --registry-tls-cert="" to remove it. Omit the flag to leave it unchanged. Use with --registry-tls-key.
--registry-tls-keystringUpdate the path to the PEM-encoded private key that pairs with --registry-tls-cert. Pass --registry-tls-key="" to remove it. Omit the flag to leave it unchanged.
--tls-certstringPath to a TLS certificate file for the installer.
--tls-keystringPath to a TLS private key file for the installer.
-y, --yesAssume yes to prompts.
-h, --helpHelp for upgrade.