Introducing a separate changelog (#10)

Co-authored-by: Ingvarr Zhmakin <[email protected]>

charts/document-engine/CHANGELOG.md

@@ -0,0 +1,96 @@
+# Changelog
+
+- [Changelog](#changelog)
+  - [2.7.3](#273)
+    - [Changed](#changed)
+  - [2.7.2](#272)
+    - [Fixed](#fixed)
+  - [2.7.0](#270)
+    - [Changed](#changed-1)
+  - [2.6.2](#262)
+    - [Added](#added)
+    - [Changed](#changed-2)
+  - [2.6.0](#260)
+    - [Added](#added-1)
+  - [2.4.0](#240)
+    - [Added](#added-2)
+  - [2.3.0](#230)
+    - [Added](#added-3)
+  - [2.2.0](#220)
+    - [Added](#added-4)
+  - [2.1.0](#210)
+    - [Changed](#changed-3)
+  - [2.0.0](#200)
+    - [Changed](#changed-4)
+
+## 2.7.3
+
+### Changed
+
+* Moved changes from [README.md](/charts/document-engine/README.md) here.
+
+## 2.7.2
+
+### Fixed
+
+* Installing without license.
+
+## 2.7.0
+
+### Changed
+
+* [Document Engine 1.3.0](https://pspdfkit.com/changelog/document-engine/#1.3.0)
+
+## 2.6.2
+
+### Added
+
+* Added `deploymentAnnotations` (courtesy of [@k11h-de]).
+* Added `pspdfkit.storage.cleanupJob.podAnnotations`.
+
+### Changed
+
+* Updated StatsD Prometheus exporter image tag.
+
+## 2.6.0
+
+### Added
+
+* Added ServiceMonitor for Prometheus Operator (setting `metrics.serviceMonitor.enabled` to `true` should work in most cases).
+* Added PrometheusRule for Prometheus Operator.
+
+## 2.4.0
+
+### Added
+
+* Added support for NetworkPolicy.
+
+## 2.3.0
+
+### Added
+
+* Added a possibility to override backend in Ingress resources, in order to enable special configurations (e.g. AWS Load Balancer Controller).
+
+## 2.2.0
+
+### Added
+
+* Added `pspdfkit.trustConfigMaps`, a map of ConfigMap references for trust certificates
+* Added `pspdfkit.downloaderTrustFileName` for remote file downloader certificates file from `pspdfkit.trustConfigMaps`
+* Added `pspdfkit.storage.postgres.tls.verify` (defaults to `true`) to enable PostgreSQL TLS certificate validation
+* Added `pspdfkit.storage.postgres.tls.trustFileName` to specify the trust certificates file from `pspdfkit.trustConfigMaps` for PostgreSQL connection
+
+## 2.1.0
+
+### Changed
+
+* Value `dashboardIngress` replaced by `extraIngresses` map to accommodate to more complex endpoint scenarios.
+
+## 2.0.0
+
+### Changed
+
+* No more `createSecret` values, condition for creating secret by the chart are moved into definition of the corresponding external secret names.
+* Storage parameters are now expected to fully reside in `Secret` resources
+  * `pspdfkit.storage.postgres.auth`, `pspdfkit.storage.s3.auth`, `pspdfkit.storage.redis.auth` maps were all merged into the corresponding `pspdfkit.storage` higher level maps
+  * Redis secret is now expected to contain (if existsis) all Redis parameters, not only the password

charts/document-engine/Chart.yaml

@@ -3,7 +3,7 @@ name: document-engine
 description: PSPDFKit Document Engine
 icon: data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTAwMCIgaGVpZ2h0PSIxMDAwIiB2aWV3Qm94PSIwIDAgMTAwMCAxMDAwIiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJNMzQyLjU2NyA2NTguNjEyTDMyOS40OTYgNjY1LjkxNUwzMzguNzk5IDY1NC4yODZDMzk5LjMxIDU3OS44NDIgNDMzLjAyNiA0ODcuMjExIDQzNC41MjggMzkxLjI4OEw0MzQuNzYgMzc2LjMxTDQ0MC4xMSAzOTAuMjY1QzQ3NC40MDUgNDc5LjkzMiA1MzcuODc4IDU1NS40NDggNjIwLjMxIDYwNC42NTRMNjMzLjE0OCA2MTIuMzI5TDYxOC4zNTYgNjA5Ljk1N0M1MjMuNTcxIDU5NC43NTYgNDI2LjQyOCA2MTEuODk0IDM0Mi41NjcgNjU4LjYxMloiIGZpbGw9IiMxOTBEOTQiLz4KPHBhdGggZD0iTTU1NC41MTkgNTU2LjM2N0M0NzMuMzk2IDQ0Mi4wMzMgNDg3LjMwNCAzNzYuODY1IDUwOS44NjQgMjg5Ljc4OEM1MzYuNjExIDE4Ni41MjQgNDczLjM1IDg0LjA1MDUgMzYyLjU5NyAxMTQuNDI1QzMxMy41MjMgMTI3LjkxNCAyOTYuMTczIDE2MS4zMTIgMjkwLjAzMyAxODQuNzU2QzI1OS45ODQgMjk3Ljc4OSA0MzguMjMxIDQ2Ni4xNzQgNTU0LjUxOSA1NTYuMzY3WiIgZmlsbD0iIzVFNUNFQiIvPgo8cGF0aCBkPSJNMjE3LjEwMyA2NDQuMTg2QzExNC4zMDQgNjcyLjY1NCA1Ny4xODM1IDc3OC43NTUgMTM4Ljg2NSA4NTkuNDEzQzE3NS4wNTMgODk1LjEzNyAyMTIuNjM4IDg5My40NjIgMjM2LjAzNSA4ODcuMzIyQzM0OC45MjggODU2Ljc2MiA0MDUuNjMgNjE4LjE4NCA0MjUuNjMyIDQ3Mi40MDVDMzY3LjE2MiA1OTkuNjI1IDMwMy45OTQgNjIwLjE4NCAyMTcuMTAzIDY0NC4xODZaIiBmaWxsPSIjNUU1Q0VCIi8+CjxwYXRoIGQ9Ik04NzEuNDggNTgyLjY1MUM3ODguNTQzIDUwMC4xNzkgNTUzLjU5NCA1NzAuMzI0IDQxNy4zNSA2MjUuOTFDNTU2Ljg5NiA2MTIuODM5IDYwNi4zODkgNjU3LjQ0OCA2NzAuNTMzIDcyMC41MjJDNzQ2LjU4NiA3OTUuMzE5IDg2Ni45NjggNzkxLjczNyA4OTYuMDQgNjgwLjY1OUM5MDguNjkyIDYzMS40NDUgODg4LjQ1OCA1OTkuNzIyIDg3MS40OCA1ODIuNjUxWiIgZmlsbD0iIzVFNUNFQiIvPgo8L3N2Zz4K
 type: application
-version: 2.7.2
+version: 2.7.3
 appVersion: "1.3.0"
 
 maintainers:

charts/document-engine/README.md

@@ -1,62 +1,33 @@
 # Document Engine Helm chart
 
 - [Document Engine Helm chart](#document-engine-helm-chart)
+  - [Using this repository](#using-this-repository)
+  - [Installing Document Engine](#installing-document-engine)
   - [Upgrade](#upgrade)
-    - [To 2.7.0](#to-270)
-    - [To 2.6.2](#to-262)
-    - [To 2.6.0](#to-260)
-    - [To 2.4.0](#to-240)
-    - [To 2.3.0](#to-230)
-    - [To 2.2.0](#to-220)
-    - [To 2.1.0](#to-210)
-    - [To 2.0.0](#to-200)
   - [License](#license)
   - [Support, Issues and License Questions](#support-issues-and-license-questions)
 
-[More on Document Engine](https://pspdfkit.com/cloud/document-engine/)
+> [!NOTE] [More on Document Engine](https://pspdfkit.com/cloud/document-engine/)
 
-## Upgrade
-
-### To 2.7.0
-
-* Document Engine 1.3.0
-
-### To 2.6.2
-
-* Added `deploymentAnnotations` (courtesy of @k11h-de).
-* Added `pspdfkit.storage.cleanupJob.podAnnotations`.
-* Updated StatsD Prometheus exporter image tag.
-
-### To 2.6.0
-
-* Added ServiceMonitor for Prometheus Operator (setting `metrics.serviceMonitor.enabled` to `true` should work in most cases).
-* Added PrometheusRule for Prometheus Operator.
+## Using this repository
 
-### To 2.4.0
+```
+helm repo add pspdfkit https://pspdfkit.github.io/helm-charts
+helm repo update
+```
 
-* Added support for NetworkPolicy.
+## Installing Document Engine
 
-### To 2.3.0
+```
+helm upgrade --install --debug --dry-run \
+     pspdfkit/document-engine \
+     -n pspdfkit-services \
+     -f ./document-engine-values.yaml
+```
 
-* Added a possibility to override backend in Ingress resources, in order to enable special configurations (e.g. AWS Load Balancer Controller).
-
-### To 2.2.0
-
-* Added `pspdfkit.trustConfigMaps`, a map of ConfigMap references for trust certificates
-* Added `pspdfkit.downloaderTrustFileName` for remote file downloader certificates file from `pspdfkit.trustConfigMaps`
-* Added `pspdfkit.storage.postgres.tls.verify` (defaults to `true`) to enable PostgreSQL TLS certificate validation
-* Added `pspdfkit.storage.postgres.tls.trustFileName` to specify the trust certificates file from `pspdfkit.trustConfigMaps` for PostgreSQL connection
-
-### To 2.1.0
-
-* Value `dashboardIngress` replaced by `extraIngresses` map to accommodate to more complex endpoint scenarios.
-
-### To 2.0.0
+## Upgrade
 
-* No more `createSecret` values, condition for creating secret by the chart are moved into definition of the corresponding external secret names.
-* Storage parameters are now expected to fully reside in `Secret` resources
-  * `pspdfkit.storage.postgres.auth`, `pspdfkit.storage.s3.auth`, `pspdfkit.storage.redis.auth` maps were all merged into the corresponding `pspdfkit.storage` higher level maps
-  * Redis secret is now expected to contain (if existsis) all Redis parameters, not only the password
+> [!NOTE] Please consult the [changelog](/charts/document-engine/CHANGELOG.md)
 
 ## License