Updated chart readme and bump IN version (#323)

* Updated README.md

* Bump chart version

* Fix trailing slash in APP_URL

* Bump IN version

charts/invoiceninja/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: invoiceninja
-description: A Helm chart to install Invoiceninja
+description: A Helm chart to install Invoice Ninja
 # A chart can be either an 'application' or a 'library' chart.
 #
 # Application charts are a collection of templates that can be packaged into versioned archives
@@ -13,14 +13,14 @@ 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.3.1
+version: 0.3.2
 # 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
 # follow Semantic Versioning. They should reflect the version the application is using.
-appVersion: 5.1.35
+appVersion: 5.1.41
 keywords:
   - invoiceninja
-home: https://github.com/lwj5/invoiceninja-chart
+home: https://invoiceninja.github.io/dockerfiles
 sources:
   - https://github.com/invoiceninja/invoiceninja
   - https://github.com/invoiceninja/dockerfiles

charts/invoiceninja/README.md

@@ -1,9 +1,9 @@
-# Invoiceninja
+# Invoice Ninja Helm Chart
 
-This helm chart installs a Invoiceninja and its dependencies into a running
+This helm chart installs a Invoice Ninja and its dependencies into a running
 Kubernetes cluster.
 
-The chart installs the [Invoiceninja](https://hub.docker.com/r/invoiceninja/invoiceninja) docker image.
+The chart installs the [Invoice Ninja](https://hub.docker.com/r/invoiceninja/invoiceninja) docker image.
 
 Please read [Upgrading](#upgrading) section before upgrading MAJOR versions.
 
@@ -24,7 +24,7 @@ helm repo add invoiceninja https://invoiceninja.github.io/dockerfiles
 helm install invoiceninja invoiceninja/invoiceninja
 ```
 
-The command deploys Invoiceninja on the Kubernetes cluster in the default namespace. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
+The command deploys Invoice Ninja on the Kubernetes cluster in the default namespace. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
 
 > **Tip**: List all releases using `helm list`
 
@@ -40,13 +40,13 @@ The command removes all the Kubernetes components associated with the chart and
 
 ## Parameters
 
-The following table lists the configurable parameters of the Invoiceninja chart and their default values.
+The following table lists the configurable parameters of the Invoice Ninja chart and their default values.
 
-> NOTE: You MUST set any values that default to random or risk losing access after an upgrade. See how [here](https://github.com/lwj5/dockerfiles/tree/redis-pw/charts/invoiceninja#installing-with-arguments)
+> NOTE: You MUST set any values that default to random or risk losing access after an upgrade. See how [here](#installing-with-arguments)
 
 ### Global Configuration
 
-The following table shows the configuration options for the Invoiceninja helm chart:
+The following table shows the configuration options for the Invoice Ninja helm chart:
 
 ### Global parameters
 
@@ -68,40 +68,40 @@ The following table shows the configuration options for the Invoiceninja helm ch
 | `kubeVersion`       | Force target Kubernetes version (using Helm capabilities if not set) | `nil`                          |
 | `extraDeploy`       | Array of extra objects to deploy with the release                    | `[]` (evaluated as a template) |
 
-### Invoiceninja parameters
+### Invoice Ninja parameters
 
-| Parameter            | Description                                                     | Default                                                 |
+| Parameter            | Description                                                      | Default                                                 |
-| -------------------- | --------------------------------------------------------------- | ------------------------------------------------------- |
+| -------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
-| `image.registry`     | Invoiceninja image registry                                     | `docker.io`                                             |
+| `image.registry`     | Invoice Ninja image registry                                     | `docker.io`                                             |
-| `image.repository`   | Invoiceninja image name                                         | `invoiceninja/invoiceninja`                             |
+| `image.repository`   | Invoice Ninja image name                                         | `invoiceninja/invoiceninja`                             |
-| `image.tag`          | Invoiceninja image tag                                          | Check `values.yaml` file                                |
+| `image.tag`          | Invoice Ninja image tag                                          | Check `values.yaml` file                                |
-| `image.pullPolicy`   | Invoiceninja image pull policy                                  | `IfNotPresent`                                          |
+| `image.pullPolicy`   | Invoice Ninja image pull policy                                  | `IfNotPresent`                                          |
-| `image.pullSecrets`  | Specify docker-registry secret names as an array                | `[]` (does not add image pull secrets to deployed pods) |
+| `image.pullSecrets`  | Specify docker-registry secret names as an array                 | `[]` (does not add image pull secrets to deployed pods) |
-| `image.debug`        | Specify if debug logs should be enabled                         | `false`                                                 |
+| `image.debug`        | Specify if debug logs should be enabled                          | `false`                                                 |
-| `serviceAccountName` | Name of a service account for the Invoiceninja pods             | `default`                                               |
+| `serviceAccountName` | Name of a service account for the Invoice Ninja pods             | `default`                                               |
-| `debug`              | Turn on debug mode on Invoiceninja                              | `false`                                                 |
+| `debug`              | Turn on debug mode on Invoice Ninja                              | `false`                                                 |
-| `appKey`             | Laravel Application Key                                         | _random 32 character alphanumeric string_               |
+| `appKey`             | Laravel Application Key                                          | _random 32 character alphanumeric string_               |
-| `logChannel`         | Name of log channel to use                                      | `nil`                                                   |
+| `logChannel`         | Name of log channel to use                                       | `nil`                                                   |
-| `broadcastDriver`    | Name of broadcast driver to use                                 | `nil`                                                   |
+| `broadcastDriver`    | Name of broadcast driver to use                                  | `nil`                                                   |
-| `cacheDriver`        | Name of cache driver to use                                     | `nil`                                                   |
+| `cacheDriver`        | Name of cache driver to use                                      | `nil`                                                   |
-| `sessionDriver`      | Name of session driver to use                                   | `nil`                                                   |
+| `sessionDriver`      | Name of session driver to use                                    | `nil`                                                   |
-| `queueConnection`    | Name of queue connection to use                                 | `nil`                                                   |
+| `queueConnection`    | Name of queue connection to use                                  | `nil`                                                   |
-| `snappdf`            | Use snappdf instead of Phantom JS PDF generation                | `true`                                                  |
+| `snappdf`            | Use snappdf instead of Phantom JS PDF generation                 | `true`                                                  |
-| `extraEnvVars`       | Extra environment variables to be set on Invoiceninja container | `{}`                                                    |
+| `extraEnvVars`       | Extra environment variables to be set on Invoice Ninja container | `{}`                                                    |
-| `extraEnvVarsCM`     | Name of existing ConfigMap containing extra env vars            | `nil`                                                   |
+| `extraEnvVarsCM`     | Name of existing ConfigMap containing extra env vars             | `nil`                                                   |
-| `extraEnvVarsSecret` | Name of existing Secret containing extra env vars               | `nil`                                                   |
+| `extraEnvVarsSecret` | Name of existing Secret containing extra env vars                | `nil`                                                   |
 
-### Invoiceninja deployment parameters
+### Invoice Ninja deployment parameters
 
 | Parameter                   | Description                                                                               | Default                        |
 | --------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------ |
-| `replicaCount`              | Number of Invoiceninja Pods to run                                                        | `1`                            |
+| `replicaCount`              | Number of Invoice Ninja Pods to run                                                       | `1`                            |
 | `containerPorts.fastcgi`    | FastCGI port to expose at container level                                                 | `9000`                         |
-| `podSecurityContext`        | Invoiceninja pods' Security Context                                                       | Check `values.yaml` file       |
+| `podSecurityContext`        | Invoice Ninja pods' Security Context                                                      | Check `values.yaml` file       |
-| `containerSecurityContext`  | Invoiceninja containers' Security Context                                                 | Check `values.yaml` file       |
+| `containerSecurityContext`  | Invoice Ninja containers' Security Context                                                | Check `values.yaml` file       |
-| `resources`                 | The resources for the Invoiceninja container                                              | `{}`                           |
+| `resources`                 | The resources for the Invoice Ninja container                                             | `{}`                           |
-| `livenessProbe`             | Liveness probe configuration for Invoiceninja                                             | Check `values.yaml` file       |
+| `livenessProbe`             | Liveness probe configuration for Invoice Ninja                                            | Check `values.yaml` file       |
-| `readinessProbe`            | Readiness probe configuration for Invoiceninja                                            | Check `values.yaml` file       |
+| `readinessProbe`            | Readiness probe configuration for Invoice Ninja                                           | Check `values.yaml` file       |
 | `updateStrategy`            | Set up update strategy                                                                    | `RollingUpdate`                |
 | `podAntiAffinityPreset`     | Pod anti-affinity preset. Ignored if `affinity` is set. Allowed values: `soft` or `hard`  | `soft`                         |
 | `nodeAffinityPreset.type`   | Node affinity preset type. Ignored if `affinity` is set. Allowed values: `soft` or `hard` | `""`                           |
@@ -110,8 +110,8 @@ The following table shows the configuration options for the Invoiceninja helm ch
 | `affinity`                  | Affinity for pod assignment                                                               | `{}` (evaluated as a template) |
 | `nodeSelector`              | Node labels for pod assignment                                                            | `{}` (evaluated as a template) |
 | `tolerations`               | Tolerations for pod assignment                                                            | `[]` (evaluated as a template) |
-| `podLabels`                 | Extra labels for Invoiceninja pods                                                        | `{}`                           |
+| `podLabels`                 | Extra labels for Invoice Ninja pods                                                       | `{}`                           |
-| `podAnnotations`            | Annotations for Invoiceninja pods                                                         | `{}`                           |
+| `podAnnotations`            | Annotations for Invoice Ninja pods                                                        | `{}`                           |
 | `extraVolumeMounts`         | Additional volume mounts                                                                  | `[]`                           |
 | `extraVolumes`              | Additional volumes                                                                        | `[]`                           |
 
@@ -122,7 +122,7 @@ The following table shows the configuration options for the Invoiceninja helm ch
 | `service.type`                     | Kubernetes Service type                                                    | `ClusterIP`                    |
 | `service.port`                     | Service FastCGI port                                                       | `9000`                         |
 | `service.nodePort`                 | Kubernetes FastCGI node port                                               | `""`                           |
-| `service.clusterIP`                | Invoiceninja service clusterIP IP                                          | `None`                         |
+| `service.clusterIP`                | Invoice Ninja service clusterIP IP                                         | `None`                         |
 | `service.loadBalancerSourceRanges` | Restricts access for LoadBalancer (only with `service.type: LoadBalancer`) | `[]`                           |
 | `service.loadBalancerIP`           | loadBalancerIP if service type is `LoadBalancer`                           | `nil`                          |
 | `service.externalTrafficPolicy`    | Enable client source IP preservation                                       | `Cluster`                      |
@@ -137,7 +137,7 @@ The following table shows the configuration options for the Invoiceninja helm ch
 | `nginx.ingress.hostname`                                | Default host for the ingress resource | `invoiceninja.local`     |
 | `nginx.serverBlock`                                     | Custom NGINX server block             | `nil`                    |
 | `nginx.extraVolumes`                                    | Array to add extra volumes            | Check `values.yaml` file |
-| `nginx.extraVolumes[0].persistentVolumeClaim.claimName` | Name of Invoiceninja public PVC       | `invoiceninja-public`    |
+| `nginx.extraVolumes[0].persistentVolumeClaim.claimName` | Name of Invoice Ninja public PVC      | `invoiceninja-public`    |
 | `nginx.extraVolumeMounts`                               | Array to add extra mount              | Check `values.yaml` file |
 
 > See [Dependencies](#dependencies) for more.
@@ -196,13 +196,13 @@ The following table shows the configuration options for the Invoiceninja helm ch
 
 ### Other parameters
 
-| Parameter                  | Description                             | Default |
+| Parameter                  | Description                              | Default |
-| -------------------------- | --------------------------------------- | ------- |
+| -------------------------- | ---------------------------------------- | ------- |
-| `autoscaling.enabled`      | Enable autoscaling for Invoiceninja     | `false` |
+| `autoscaling.enabled`      | Enable autoscaling for Invoice Ninja     | `false` |
-| `autoscaling.minReplicas`  | Minimum number of Invoiceninja replicas | `1`     |
+| `autoscaling.minReplicas`  | Minimum number of Invoice Ninja replicas | `1`     |
-| `autoscaling.maxReplicas`  | Maximum number of Invoiceninja replicas | `11`    |
+| `autoscaling.maxReplicas`  | Maximum number of Invoice Ninja replicas | `11`    |
-| `autoscaling.targetCPU`    | Target CPU utilization percentage       | `nil`   |
+| `autoscaling.targetCPU`    | Target CPU utilization percentage        | `nil`   |
-| `autoscaling.targetMemory` | Target Memory utilization percentage    | `nil`   |
+| `autoscaling.targetMemory` | Target Memory utilization percentage     | `nil`   |
 
 ## Installing with Arguments
 

charts/invoiceninja/templates/NOTES.txt

@@ -28,6 +28,7 @@ Externally through the following DNS name:
 {{- else if contains "ClusterIP" .Values.nginx.service.type }}
   export SVC_NAME=$(kubectl get svc --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name=nginx,app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
   export SVC_PORT=$(kubectl get svc --namespace {{ .Release.Namespace }} $SVC_NAME -o jsonpath="{.spec.ports[0].port}")
-  echo "Visit http://127.0.0.1:8080 to use your application"
+  echo "Add the line '127.0.0.1 {{ .Values.nginx.ingress.hostname }}' to your hosts file"
-  kubectl -n {{ .Release.Namespace }} port-forward svc/$SVC_NAME 8080:$SVC_PORT
+  echo "Visit http://{{ .Values.nginx.ingress.hostname }} to use your application"
+  kubectl -n {{ .Release.Namespace }} port-forward svc/$SVC_NAME 80:$SVC_PORT
 {{- end }}

charts/invoiceninja/templates/configmap.yaml

@@ -13,9 +13,9 @@ metadata:
   {{- end }}
 data:
   {{- if .Values.nginx.ingress.enabled }}
-  APP_URL: "http://{{ .Values.nginx.ingress.hostname }}/"
+  APP_URL: "http://{{ .Values.nginx.ingress.hostname }}"
   {{- else }}
-  APP_URL: "http://{{ include "common.names.fullname" . }}/"
+  APP_URL: "http://{{ include "common.names.fullname" . }}"
   {{- end }}
   APP_DEBUG: {{ .Values.debug | quote }}
   DB_HOST1: {{ include "invoiceninja.databaseHost" . | quote }}

charts/invoiceninja/values.yaml

@@ -12,13 +12,13 @@
 #     - myRegistryKeySecretName
 #   storageClass: myStorageClass
 
-## Invoiceninja image version
+## Invoice Ninja image version
 ## ref: https://github.com/invoiceninja/dockerfiles
 ##
 image:
   registry: docker.io
   repository: invoiceninja/invoiceninja
-  tag: 5.1.35
+  tag: 5.1.42
   ## Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent'
   ## ref: http://kubernetes.io/docs/user-guide/images/#pre-pulling-images
   ##
@@ -30,7 +30,7 @@ image:
   # pullSecrets:
   #   - myRegistryKeySecretName
 
-## String to turn on debug mode in Invoiceninja
+## String to turn on debug mode in Invoice Ninja
 ##
 debug: false
 
@@ -169,7 +169,7 @@ containerSecurityContext:
 ##
 replicaCount: 1
 
-## Set up update strategy for Invoiceninja installation. Set to Recreate if you use persistent volume that cannot be mounted by more than one pods to makesure the pods is destroyed first.
+## Set up update strategy for Invoice Ninja installation. Set to Recreate if you use persistent volume that cannot be mounted by more than one pods to makesure the pods is destroyed first.
 ## ref: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy
 ## Example:
 ## updateStrategy:
@@ -247,7 +247,7 @@ service:
   annotations: {}
 
 ## Configure extra options for liveness and readiness probes
-## This applies to all the Invoiceninja in the sharded cluster
+## This applies to all the Invoice Ninja in the sharded cluster
 ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)
 ##
 livenessProbe:
@@ -286,7 +286,7 @@ resources:
 persistence:
   public:
     enabled: true
-    ## Invoiceninja data Persistent Volume Storage Class
+    ## Invoice Ninja data Persistent Volume Storage Class
     ## If defined, storageClassName: <storageClass>
     ## If set to "-", storageClassName: "", which disables dynamic provisioning
     ## If undefined (the default) or set to null, no storageClassName spec is
@@ -305,7 +305,7 @@ persistence:
     dataSource: {}
   storage:
     enabled: true
-    ## Invoiceninja data Persistent Volume Storage Class
+    ## Invoice Ninja data Persistent Volume Storage Class
     ## If defined, storageClassName: <storageClass>
     ## If set to "-", storageClassName: "", which disables dynamic provisioning
     ## If undefined (the default) or set to null, no storageClassName spec is
@@ -394,7 +394,7 @@ externalDatabase:
   ## Database host
   ##
   host: ""
-  ## non-root Username for Invoiceninja Database
+  ## non-root Username for Invoice Ninja Database
   ##
   user: invoiceninja
   ## Database password
@@ -421,13 +421,13 @@ nginx:
     ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types
     ##
     type: ClusterIP
-  ## Configure the ingress resource that allows you to access the Invoiceninja
+  ## Configure the ingress resource that allows you to access the Invoice Ninja
   ## ref: http://kubernetes.io/docs/user-guide/ingress/
   ##
   ingress:
     enabled: true
     hostname: invoiceninja.local
-  ## Configure the serverblock for Invoiceninja
+  ## Configure the serverblock for Invoice Ninja
   ## Note: you may need to replace the fastcgi_pass value if the release name is different
   ##
   serverBlock: |
@@ -456,7 +456,7 @@ nginx:
             fastcgi_buffers 4 16k;
         }
     }
-  ## Configure the extraVolumes and extraVolumeMounts for Invoiceninja
+  ## Configure the extraVolumes and extraVolumeMounts for Invoice Ninja
   ## Note: you may need to replace the claimName if the release name is different
   ##
   extraVolumes: