diff --git a/charts/kutt/Chart.yaml b/charts/kutt/Chart.yaml index 2b0a51bf..a1f5a66f 100644 --- a/charts/kutt/Chart.yaml +++ b/charts/kutt/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: kutt description: Kutt is a free modern URL shortener. type: application -version: 2.12.0 +version: 3.0.0 appVersion: "v2.7.4" home: https://github.com/christianknell/helm-charts icon: https://www.saashub.com/images/app/service_logos/15/d634f2359578/large.png @@ -18,12 +18,12 @@ dependencies: condition: postgresql.enabled - name: redis repository: https://charts.bitnami.com/bitnami - version: 17.17.1 + version: 18.0.4 condition: redis.enabled annotations: artifacthub.io/changes: | - kind: changed - description: bumped dependency of redis to chart 17.17.1 + description: bumped dependency of redis to chart 18.0.4 artifacthub.io/screenshots: | - title: Simply shorten your link using the Web UI. url: https://d4.alternativeto.net/v9sHosD3RiPblfBOOHZi0gwU1M0pRL6Jn53oiobJi9k/rs:fit:1200:1200:0/g:ce:0:0/YWJzOi8vZGlzdC9zL2t1dHQtaXRfNzY3MjMzX2Z1bGwucG5n.jpg diff --git a/charts/kutt/README.md b/charts/kutt/README.md index a965f5a3..2a180a08 100644 --- a/charts/kutt/README.md +++ b/charts/kutt/README.md @@ -58,11 +58,11 @@ The command removes all the Kubernetes components associated with the chart and | externalPostgresql.auth.username | string | `"kutt"` | Name of the user to use | | externalPostgresql.hostname | string | `""` | Hostname of the PostgreSQL database | | externalPostgresql.port | int | `5432` | Port used to connect to PostgreSQL database | -| externalRedis.auth.enabled | bool | `true` | if authentication should be used with external Redis™ | -| externalRedis.auth.existingSecret | string | `""` | Name of existing secret to use for Redis™ credentials | +| externalRedis.auth.enabled | bool | `true` | if authentication should be used with external Redis™ | +| externalRedis.auth.existingSecret | string | `""` | Name of existing secret to use for Redis™ credentials | | externalRedis.auth.password | string | `""` | Password to use | | externalRedis.auth.userPasswordKey | string | `""` | Key in the secret containing the password | -| externalRedis.hostname | string | `""` | Hostname of Redis™ | +| externalRedis.hostname | string | `""` | Hostname of Redis™ | | externalRedis.port | int | `6379` | Port used to connect to Redis | | extraEnv | list | `[]` | additional environment variables to be added to the pods | | fullnameOverride | string | `""` | String to fully override `"kutt.fullname"` | @@ -110,11 +110,11 @@ The command removes all the Kubernetes components associated with the chart and | postgresql.auth.existingSecret | string | `""` | Name of existing secret to use for PostgreSQL credentials | | postgresql.auth.password | string | `"kutt"` | Password for the custom user to create. Ignored if postgresql.auth.existingSecret is provided | | postgresql.auth.username | string | `"kutt"` | Name for a custom user to create | -| postgresql.enabled | bool | `true` | enable PostgreSQL™ subchart from Bitnami | -| redis.architecture | string | `"standalone"` | Redis® architecture. Allowed values: standalone or replication | +| postgresql.enabled | bool | `true` | enable PostgreSQL™ subchart from Bitnami | +| redis.architecture | string | `"standalone"` | Redis® architecture. Allowed values: standalone or replication | | redis.auth.enabled | bool | `true` | Enable password authentication | -| redis.auth.password | string | `"kutt"` | Redis™ password | -| redis.enabled | bool | `true` | enable Redis™ subchart from Bitnami | +| redis.auth.password | string | `"kutt"` | Redis™ password | +| redis.enabled | bool | `true` | enable Redis™ subchart from Bitnami | | replicaCount | int | `1` | Number of replicas | | resources | object | `{}` | Resource limits and requests for the pods. | | revisionHistoryLimit | int | `10` | The number of old ReplicaSets to retain | @@ -136,6 +136,10 @@ helm install my-release -f values.yaml christianknell/kutt ## Upgrading the Chart +### 3.0.0 + +This major updates the redis subchart to its newest major, 18.0.4. [Here](https://github.com/bitnami/charts/tree/main/bitnami/redis#to-1800) you can find more information about the changes introduced in that version. + ### 2.0.0 This major updates the way you define environment variables. diff --git a/charts/kutt/README.md.gotmpl b/charts/kutt/README.md.gotmpl index 54d94eef..54f20461 100644 --- a/charts/kutt/README.md.gotmpl +++ b/charts/kutt/README.md.gotmpl @@ -53,6 +53,10 @@ helm install my-release -f values.yaml christianknell/kutt ## Upgrading the Chart +### 3.0.0 + +This major updates the redis subchart to its newest major, 18.0.4. [Here](https://github.com/bitnami/charts/tree/main/bitnami/redis#to-1800) you can find more information about the changes introduced in that version. + ### 2.0.0 This major updates the way you define environment variables. diff --git a/development/README.md b/development/README.md index 70b10a3d..1df7298c 100644 --- a/development/README.md +++ b/development/README.md @@ -20,38 +20,14 @@ 1. Make changes to the charts -1. Mount the folder in the [kube-powertools](https://github.com/chgl/kube-powertools) container to easily run linters and checks +1. Bump the version in the changed `Chart.yaml` according to Semantic Versioning (The `ct lint` step will complain if you forget to update the version.) - ```sh - docker run --rm -it -v $PWD/../..:/usr/src/app ghcr.io/chgl/kube-powertools:latest - ``` +1. Update the changes annotation in the `Chart.yaml` -1. Run chart-testing and the `chart-powerlint.sh` script to lint the chart +1. Update the README.md (execute in the root folder of the chart you changed): ```sh - ct lint --config .github/config/chart-testing.yaml && chart-powerlint.sh - ``` - -1. (Optional) View the results of the [polaris audit check](https://github.com/FairwindsOps/polaris) in your browser - - ```sh - $ docker run --rm -it -p 9090:8080 -v $PWD:/usr/src/app ghcr.io/chgl/kube-powertools:latest - bash-5.0: helm template charts/prometheus-pve-exporter/ | polaris dashboard --config .polaris.yaml --audit-path - - ``` - - You can now open your browser at and see the results and recommendations. - -1. Run `generate-docs.sh` to auto-generate an updated README - - ```sh - generate-docs.sh - ``` - -1. Bump the version in the changed Chart.yaml according to SemVer (The `ct lint` step above will complain if you forget to update the version.) - -1. Exit Docker-Container: - ``` - exit + docker run --rm -v $PWD/../..:/root/workspace ghcr.io/chgl/kube-powertools:latest generate-docs.sh ``` 1. Update values.schema.json (requires a [Helm-Plugin](https://github.com/karuppiah7890/helm-schema-gen)): @@ -59,9 +35,4 @@ helm schema-gen values.yaml > values.schema.json ``` -1. Publish Chart to HelmRepository (requires a [Helm-Plugin](https://github.com/chartmuseum/helm-push)): - ``` - export HELM_REPO_USERNAME=${YOUR_USERNAME} - export HELM_REPO_PASSWORD=${YOUR_PASSWORD} - helm cm-push . https://charts.knell.it - ``` +1. Commit your changes to the repository. The CI Pipeline will test your changes and package a new release.