Skip to content

Commit

Permalink
update the doc + bump version to 0.7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
edevosc2c committed Oct 29, 2024
1 parent b64f9ad commit d70db5b
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
3 changes: 3 additions & 0 deletions mviewer/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# 0.7.0

Initial version of the helm chart
2 changes: 1 addition & 1 deletion mviewer/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
20 changes: 9 additions & 11 deletions mviewer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
1 change: 0 additions & 1 deletion mviewer/ci/all-optional-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ elasticsearch:
command: ["/bin/sh", "-c", "echo"]

ingress:
enabled: true
className: "traefik"

mviewerstudio:
Expand Down
2 changes: 1 addition & 1 deletion mviewer/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ elasticsearch:
- ReadWriteOnce

ingress:
enabled: false
enabled: true
className: ""
annotations: {}
# kubernetes.io/ingress.class: nginx
Expand Down

0 comments on commit d70db5b

Please sign in to comment.