DX-46221: Deprecate 'local' distStorage option for Helm deployments.

- Deprecates support for 'local' distStorage type for Dremio release 21.0.0 or newer. Change-Id: I2e178aff5a0151d26249db05c6b97430e6404a96
dremio · Mar 18, 2022 · abf8bea · abf8bea
1 parent 47514a4
commit abf8bea
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 3 deletions.
diff --git a/charts/dremio_v2/README.md b/charts/dremio_v2/README.md
@@ -9,6 +9,7 @@ If you are upgrading from the previous Helm chart for Dremio, please see the [Mi
 * Ensure that you have an existing Kubernetes cluster.
 * Ensure that Helm 3 is set up on a local machine.
 * Ensure that a local kubectl is configured to access your Kubernetes cluster.
+* Ensure that you have cloud storage available (required for 21.0.0+), see [here](./docs/Values-Reference.md#diststoragetype) for more details.
 
 ## Procedure
 

diff --git a/charts/dremio_v2/config/dremio.conf b/charts/dremio_v2/config/dremio.conf
@@ -14,6 +14,14 @@
 # limitations under the License.
 #
 
+{{- if (eq $.Values.distStorage.type "local") }}
+  {{- if eq $.Values.imageTag "latest" }}
+  {{- fail "\n\n** ERROR: The 'local' distStorage type is no longer supported in Dremio 21.0.0 or later. Please configure another distStorage provider to deploy Dremio. (Note: 'latest' is presumed to be 21.0.0+.) **\n" -}}
+  {{- else if ge ((semver $.Values.imageTag).Major) 21 }}
+  {{- fail "\n\n** ERROR: The 'local' distStorage type is no longer supported in Dremio 21.0.0 or later. Please configure another distStorage provider to deploy Dremio. **\n" -}}
+  {{- end }}
+{{- end }}
+
 paths: {
   # Local path for dremio to store data.
   local: ${DREMIO_HOME}"/data"

diff --git a/charts/dremio_v2/docs/Values-Reference.md b/charts/dremio_v2/docs/Values-Reference.md
@@ -997,7 +997,9 @@ Type: String
 
 By default, this value is set to `local`.
 
-The valid values for `distStorage.type` are `local` (not recommended), `aws`, `azure`, `azureStorage` or `gcp`. For specific configuration values for each, see the associated sections:
+***Note***: 'local' has been deprecated in Dremio 21.0.0+.
+
+The valid values for `distStorage.type` are `local` (not recommended, not supported in Dremio 21.0.0+), `aws`, `azure`, `azureStorage` or `gcp`. For specific configuration values for each, see the associated sections:
 
 * `aws` (S3): [AWS S3](#aws-s3)
 * `azure` (Azure ADLS Gen 1): [Azure ADLS Gen 1](#azure-adls-gen-1)

diff --git a/charts/dremio_v2/values.yaml b/charts/dremio_v2/values.yaml
@@ -279,9 +279,9 @@ zookeeper:
 # Control where uploaded files are stored for Dremio.
 # For more information, see https://docs.dremio.com/deployment/distributed-storage.html
 distStorage:
-  # The supported distributed storage types are: local, aws, azure, gcp, or azureStorage.
+  # The supported distributed storage types are: local (<21.0.0 only), aws, azure, gcp, or azureStorage.
   #
-  # local: Not recommended for production use. When using local, dist-caching is disabled.
+  # local: (<21.0.0 only) Not recommended for production use. When using local, dist-caching is disabled.
   # aws: AWS S3, additional parameters required, see "aws" section.
   # azure: ADLS Gen 1, additional parameters required, see "azure" section.
   # azureStorage: Azure Storage Gen2, additional paramters required, see "azureStorage" section.