Update enterprise readme (#323)

* fix chart name in global readme * add warning to README and NOTES.txt about redis URI change * bump chart version --------- Signed-off-by: Brady Todhunter <[email protected]>
anchore · Dec 15, 2023 · fa576c4 · fa576c4
1 parent a4449f0
commit fa576c4
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ To install a chart, use the `helm install` command and specify the chart name an
 
 ```bash
 RELEASE_NAME="my-release"
-CHART_NAME="anchore/anchore-engine"
+CHART_NAME="anchore/enterprise"
 
 helm install "$RELEASE_NAME" "$CHART_NAME" --values values.yaml
 ```
@@ -39,7 +39,7 @@ It can be useful when developing to install a chart directly from the source cod
 RELEASE_NAME="my-release"
 CHART_PATH="anchore-charts/stable/enterprise"
 
-git clone https://github.com/anchore/anchore-charts-dev.git
+git clone https://github.com/anchore/anchore-charts.git
 cd "$CHART_PATH"
 helm dependency up
 helm install "$RELEASE_NAME" . --values values.yaml

diff --git a/stable/enterprise/Chart.yaml b/stable/enterprise/Chart.yaml
@@ -1,6 +1,6 @@
 apiVersion: v2
 name: enterprise
-version: "2.1.0"
+version: "2.1.1"
 appVersion: "5.1.0"
 kubeVersion: 1.23.x - 1.28.x || 1.23.x-x - 1.28.x-x
 description: |

diff --git a/stable/enterprise/README.md b/stable/enterprise/README.md
@@ -387,7 +387,7 @@ type: Opaque
 stringData:
   # if using TLS to connect to Postgresql you must add the ?ssl=[require|verify-ca|verify-full] parameter to the end of the URI
   ANCHORE_APPDB_URI: postgresql://anchoreengine:anchore-postgres,123@anchore-postgresql:5432/anchore
-  ANCHORE_REDIS_URI: redis://nouser:anchore-redis,123@anchore-ui-redis-master:6379
+  ANCHORE_REDIS_URI: redis://:anchore-redis,123@anchore-ui-redis-master:6379
 
 ---
 apiVersion: v1
@@ -1354,6 +1354,13 @@ For the latest updates and features in Anchore Enterprise, see the official [Rel
 ### V2.1.0
 
 - Deploys Anchore Enterprise v5.1.0. See the [Release Notes](https://docs.anchore.com/current/docs/releasenotes/510/) for more information.
+- The Redis client utilized by the UI has been updated and no longer requires a username to be specified in the URI. The chart configuration has been updated to reflect this change. If you are using secrets generated by the chart, no action is required.
+
+  - :warning: **WARNING:** If you are using existing secrets, you will need to update your ANCHORE_REDIS_URI environment variable to remove the `nouser` username. The UI will not function without this change. For example:
+
+    ```yaml
+    ANCHORE_REDIS_URI: redis://:anchore-redis,123@anchore-ui-redis:6379
+    ```
 
 ### v2.0.0
 

diff --git a/stable/enterprise/templates/NOTES.txt b/stable/enterprise/templates/NOTES.txt
@@ -20,3 +20,14 @@ Initial setup time can be >120sec for postgresql setup and readiness checks to p
 You can check with:
 
     kubectl get pods -l app.kubernetes.io/name={{- template "enterprise.fullname" . -}},app.kubernetes.io/component=api
+
+{{ if and .Values.useExistingSecrets .Release.IsUpgrade (semverCompare "~2.1.0" .Chart.Version) }}
+******************
+
+WARNING: This deployment is utilizing Existing Secrets. Your ANCHORE_REDIS_URI environment variable needs to be updated.
+A username is no longer required, please remove `nouser` from the URI. The UI will not function unless this update is performed.
+
+For more details see the v2.1.0 release notes - https://github.com/anchore/anchore-charts/blob/main/stable/enterprise/README.md#v210
+
+******************
+{{ end }}