Skip to content

Commit a63cb11

Browse files
committed
DX-49550: Clarify image tag usage documentation.
- Clarify documentation to provide recommended image tag usage. Change-Id: Iaad12fee063f252dc0bec5e08a1ed5b95b1b431b
1 parent e2d2854 commit a63cb11

File tree

3 files changed

+12
-4
lines changed

3 files changed

+12
-4
lines changed

charts/dremio_v2/docs/Values-Reference.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ Type: String
2222

2323
By default, the value is set to `latest`.
2424

25-
It is **strongly** recommended to pin the version of Dremio that we are deploying by setting the `imageTag` to a precise version and not leave the value as latest. Since Dremio versions are not backwards compatible, leaving it as latest may automatically upgrade dremio during pod creation.
25+
The `imageTag` refers to the tag/version of the container image for Dremio.
26+
27+
***Note***: It is **strongly** recommended to pin the version of Dremio that we are deploying by setting the `imageTag` to a precise version and not leave the value as latest. If you are directly consuming Dremio's images from Docker Hub, when specifying which version to use, it is recommended to use the full version tag in the form `X.Y.Z` (i.e. `21.1.0`), as image tags in the form `X.Y` (i.e. `21.1`) are continually updated with the latest patch version released. Since Dremio versions are not backwards compatible, leaving it as latest or in the form `X.Y` may automatically upgrade Dremio during pod creation.
2628

2729
#### `imagePullSecrets`
2830

charts/dremio_v2/docs/setup/Important-Setup-Considerations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
As part of setting up a Dremio cluster on Kubernetes, there are a number of important considerations that we recommend you review before deploying your cluster. Some of these values have an impact on the performance of your cluster and should be adjusted to your needs.
44

5-
* `imageTag`: As part of setup, this value should be updated to reference the exact version of Dremio you wish to deploy, i.e. `4.7.0`.
5+
* `imageTag`: As part of setup, this value should be updated to reference the exact version of Dremio you wish to deploy, i.e. `4.7.0`. If you are directly consuming Dremio's images from Docker Hub, when specifying which version to use, it is recommended to use the full version tag in the form `X.Y.Z` (i.e. `21.1.0`), as image tags in the form `X.Y` (i.e. `21.1`) are continually updated with the latest patch version released.
66
* `distStorage.type`: By default, the `distStorage.type` is set to `local`. This **must** be changed prior to production use. We do not recommend users use local distributed storage as part of a production setup.
77
* `volumeSize` and `storageClass`: The size and type of volume used for Dremio has a direct impact on performance. In most Kubernetes providers, volume size has a direct impact on the performance in IOPS and read/write speeds. It is important to check your Kubernetes provider to determine how volume size impacts the performance of your disk.
88
* `executor.cloudCache.storageClass`: Dremio C3 was designed to be used with performant NVMe storage. By default, the chart utilizes the default storage class that is configured on the Kubernetes cluster. For the major Kubernetes providers, NVMe storage is often available on appropriately sized nodes. We recommend utilizing a local storage provisioner to unlock the benefits of NVMe storage available on the physical Kubernetes nodes. For more information, see the [Kubernetes Special Interest Group for Local Static Provisioner](https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner).

charts/dremio_v2/values.yaml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,15 @@
22
#
33
# It is *highly* recommended to update the version tag to
44
# the version that you are using. This will ensure that all
5-
# the pods are using the same version of the software.
5+
# the pods are using the same version of the software. If
6+
# you are directly consuming Dremio's images from Docker Hub,
7+
# when specifying which version to use, it is best to use the
8+
# full version tag in the form X.Y.Z (i.e. 21.1.0), as image
9+
# tags in the form X.Y (i.e. 21.1) are updated with the latest
10+
# patch version released.
611
#
7-
# Using latest will cause Dremio to potentially upgrade versions
12+
# Using the image tag latest or in the form X.Y
13+
# will potentially cause Dremio to upgrade versions
814
# automatically during redeployments and may negatively impact
915
# the cluster.
1016
image: dremio/dremio-oss

0 commit comments

Comments
 (0)