Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 5.14 KB

Migrating-Helm-Chart-Versions.md

File metadata and controls

71 lines (51 loc) · 5.14 KB

Migrating Helm Chart Versions

⚠️ If the contents of your chart's templates directory has been modified, this guide may not cover the changes necessary to maintain your existing setup. As new functionality has been added to the Helm chart, please check whether the new version of the chart allows you to express the same modifications that have been made to your templates directory.

Note: Helm 2 is no longer supported in this Helm chart.

  1. First begin by overriding the values in values.yaml to reflect the original chart's values.

    Tip: As a best practice, we recommend creating a values.local.yaml (or equivalently named file) that stores the values that you wish to override as part of your setup of Dremio. This allows you to quickly update to the latest version of the chart by copying the values.local.yaml across Helm chart updates.

    In the new version of the Dremio Helm chart, changes have been introduced to the values.yaml file that differ from the original Dremio Helm chart. The chart below maps existing values and shows their equivalents in this Helm chart's values.yaml.

Original Value New Value
executor.cloudCache.quota.fs_pct Removed - In the new chart, we now require provisioning a persistent volume for Cloud Cache.
executor.cloudCache.quota.db_pct Removed - In the new chart, we now require provisioning a persistent volume for Cloud Cache.
executor.cloudCache.quota.cache_pct Removed - In the new chart, we now require provisioning a persistent volume for Cloud Cache.
tls.ui.enabled coordinator.ui.tls.enabled
tls.ui.secret coordinator.ui.tls.secret
tls.client.enabled coordinator.client.tls.enabled
tls.client.secret coordinator.client.tls.secret
serviceType service.type
sessionAffinity service.sessionAffinity
internalLoadBalancer service.internalLoadbalancer
imagePullSecrets imagePullSecrets is no longer a string based-value. This is now an array, which can be represented as follows: imagePullSecrets: ["original-value"].
distStorage.aws.accessKey distStorage.aws.credentials.accessKey Note: If using access key and secret for authentication, the value of distStorage.aws.authentication must also be set to accesskeySecret.
distStorage.aws.secret distStorage.aws.credentials.secret Note: If using access key and secret for authentication, the value of distStorage.aws.authentication must also be set to accesskeySecret.
distStorage.azure.applicationId distStorage.azure.credentials.applicationId
distStorage.azure.secret distStorage.azure.credentials.secret
distStorage.azure.oauth2EndPoint distStorage.azure.credentials.oauth2Endpoint Note: The capitalization has changed in this value from EndPoint to Endpoint.
distStorage.azureStorage.accessKey distStorage.azureStorage.credentials.accessKey

  1. This chart introduces the concept of engines. Engines operate as a grouping of executor nodes that can be targeted via queues to handle specific workloads.

    As part of the transition to this Helm chart, to retain the existing persistent volumes used for the executor nodes, ensure that you keep a default engine as provided by the values.yaml. Additionally, set the value of executor.engineOverride.default.volumeClaimName to be dremio-executor-volume.

    For example, you would want to do the following to setup the volumeClaimName:

executor:
  [...]
  engineOverride:
    default:
      volumeClaimName: dremio-executor-volume

  1. With any upgrade, we recommend creating a backup first before performing an upgrade.

    See the Dremio Administration documentation on how to access dremio-admin commands to complete a backup prior to upgrading.

  2. We are now ready to begin upgrading to the new Helm chart. Begin by uninstalling the existing Helm chart for Dremio by using the helm command.

    Note: The data will persist in the persistent volumes through this process.

$ helm uninstall <release-name>

If your original deployment of the Dremio chart was with Helm 2, uninstall the Helm chart for Dremio by using the following command with the Helm 2 binary:

$ helm2 delete --purge <release-name>
  1. Now, invoke helm again to install the new version of the chart:
$ helm install <release-name> dremio_v2 -f values.local.yaml
  1. Done! Verify that the upgrade was successful.