From d70db5b78dfc70de116d616a4c4caf9d144f9324 Mon Sep 17 00:00:00 2001 From: Emilien Devos <121870973+edevosc2c@users.noreply.github.com> Date: Tue, 29 Oct 2024 18:04:47 +0100 Subject: [PATCH] update the doc + bump version to 0.7.0 --- mviewer/CHANGELOG.md | 3 +++ mviewer/Chart.yaml | 2 +- mviewer/README.md | 20 +++++++++----------- mviewer/ci/all-optional-values.yaml | 1 - mviewer/values.yaml | 2 +- 5 files changed, 14 insertions(+), 14 deletions(-) create mode 100644 mviewer/CHANGELOG.md diff --git a/mviewer/CHANGELOG.md b/mviewer/CHANGELOG.md new file mode 100644 index 0000000..1bf051b --- /dev/null +++ b/mviewer/CHANGELOG.md @@ -0,0 +1,3 @@ +# 0.7.0 + +Initial version of the helm chart \ No newline at end of file diff --git a/mviewer/Chart.yaml b/mviewer/Chart.yaml index 9dd53cb..824e49f 100644 --- a/mviewer/Chart.yaml +++ b/mviewer/Chart.yaml @@ -15,7 +15,7 @@ type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 0.6.0 +version: 0.7.0 # This is the version number of the application being deployed. This version number should be # incremented each time you make changes to the application. Versions are not expected to diff --git a/mviewer/README.md b/mviewer/README.md index b9e4a22..5539928 100644 --- a/mviewer/README.md +++ b/mviewer/README.md @@ -8,40 +8,38 @@ some of the features and/or implementation choices. ## How to create a new chart release 1. Change and push the version in the Chart.yaml 2. Write a changelog in the CHANGELOG.md -3. Execute `git tag 0.X.X` (with the same version as the chart) -4. Execute `git push --tags` # Usage ## Install +WARNING: Change `0.7.0` by the latest version of the helm chart found in https://github.com/mviewer/helm-charts/blob/main/mviewer/Chart.yaml#L18 + ### Quick start -1. Execute these commands for installing the mviewer chart: +1. Execute this command for installing the mviewer chart: ``` - helm repo add mviewer https://charts.mviewer.com - helm repo update - helm install mviewer mviewer/mviewer + helm install mviewer oci://ghcr.io/mviewer/helm-charts/mviewer --version 0.7.0 ``` -4. Go to [https://YOURDOMAIN](https://YOURDOMAIN) +4. Go to [https://YOURDOMAIN/mviewer](https://YOURDOMAIN/mviewer) ### Customized installation 1. Create a new separate 'values' file (or edit the existing one, not recommended). -3. Execute these commands for installing the mviewer chart: +3. Execute this command for installing the mviewer chart: ``` helm repo add mviewer https://charts.mviewer.com helm repo update - helm install -f your-values.yaml mviewer mviewer/mviewer + helm install -f your-values.yaml mviewer oci://ghcr.io/mviewer/helm-charts/mviewer --version 0.7.0 ``` -4. Go to [https://YOURDOMAIN](https://YOURDOMAIN) +4. Go to [https://YOURDOMAIN/mviewer](https://YOURDOMAIN/mviewer) ## Upgrade Apply only for a customized installation. ``` -helm upgrade -f your-values.yaml mviewer mviewer/mviewer +helm upgrade -f your-values.yaml mviewer oci://ghcr.io/mviewer/helm-charts/mviewer --version 0.7.0 ``` \ No newline at end of file diff --git a/mviewer/ci/all-optional-values.yaml b/mviewer/ci/all-optional-values.yaml index b5b36f5..cd1234f 100644 --- a/mviewer/ci/all-optional-values.yaml +++ b/mviewer/ci/all-optional-values.yaml @@ -83,7 +83,6 @@ elasticsearch: command: ["/bin/sh", "-c", "echo"] ingress: - enabled: true className: "traefik" mviewerstudio: diff --git a/mviewer/values.yaml b/mviewer/values.yaml index 40a0257..b5597ef 100644 --- a/mviewer/values.yaml +++ b/mviewer/values.yaml @@ -86,7 +86,7 @@ elasticsearch: - ReadWriteOnce ingress: - enabled: false + enabled: true className: "" annotations: {} # kubernetes.io/ingress.class: nginx