Upgrade the Data Lake manually

You can initiate a Data Lake upgrade with the CDP CLI. Using the same CLI command, you can also search for and validate available images to upgrade to, and generate JSON templates for specific upgrade scenarios.

Run the cdp datalake upgrade-datalake command. The command has the following options:
cdp datalake upgrade-datalake
          --datalake-name <value>
          [--image-id <value>]
          [--runtime <value>]
          [--lock-components | --no-lock-components]
          [--dry-run | --no-dry-run]
          [--show-available-images | --no-show-available-images]
          [--show-available-image-per-runtime | --no-show-available-image-per-runtime]
          [--cli-input-json <value>]
          [--generate-cli-skeleton]
Option Description
--datalake-name (string) Required. The name or CRN of the Data Lake to upgrade.
--image-id (string) The ID of an image to upgrade to.
--runtime (string) The Runtime version to upgrade to. When you specify the Runtime version, the upgrade uses the latest image ID of the given Runtime version from the same image catalog used for Data Lake creation.
--lock-components | --no-lock-components (boolean) Use --lock components to perform an OS upgrade only.
--dry-run | --no-dry-run (boolean) Checks the eligibility of an image to upgrade. Can be used in conjunction with any other parameter, returning the available image (with respect to image Id, Runtime or lock-components set) without performing any actions.
--show-available-images | --no-show-available-images (boolean) Returns the list of images that are eligible to upgrade to.
--show-available-image-per-runtime | --no-show-available-image-per-runtime (boolean) Returns the latest image that is eligible to upgrade to, for each Runtime version with at least one available upgrade candidate.
--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.
--generate-cli-skeleton (boolean) Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

When you run the cdp datalake upgrade-datalake command to initiate an upgrade, you have one of three options:

  1. Specify one of either --image-id, --runtime, or -lockComponents which makes an explicit choice of the exact image, Runtime (latest OS), or latest OS (same Runtime) for upgrade.
  2. Specify both --image-id and --lockComponents,which specifies an image and ensures the image represents an OS only upgrade.
  3. Specify none of the --image-id, --runtime, or --lockComponents parameters, which initiates a Runtime/CM upgrade to the latest compatible version and OS image.
Outside of upgrade, you can use the following options:
  • --show-available-images/--no-show-available-images
  • --show-available-images-per-runtime/--no-show-available-images-per-run time
  • --dry-run