Implement using WPR namespace for all service variables

README.md

@@ -42,13 +42,13 @@ in `values.yaml`.
 ## License activation
 
 There are three ways the service can be activated:
-1. During `docker build` by setting the `LICENSE_TICKET_ID` argument in Dockerfile or CLI (`--build-arg LICENSE_TICKET_ID=${MY_LOCAL_VARIABLE}`).
+1. During `docker build` by setting the `WPR_LICENSE_TICKET_ID` argument in Dockerfile or CLI (`--build-arg WPR_LICENSE_TICKET_ID=${MY_LOCAL_VARIABLE}`).
 2. Through the `values.yaml` config file (`licenseTicketID` parameter).
 3. During chart deployment/upgrade CLI call using the flag:
 ```shell
---set licenseTicketID=${LICENSE_TICKET_ID}
+--set licenseTicketID=${WPR_LICENSE_TICKET_ID}
 ```
-provided that `LICENSE_TICKET_ID` is set in your environment.
+provided that `WPR_LICENSE_TICKET_ID` is set in your environment.
 
 > [!IMPORTANT]
 > If you are attempting to build a production environment, it's recommended to use the custom Docker image with WProofreader Server instead of the public one published on Docker Hub. With the custom image, you won't need to activate the license on the container start. Thus, you just skip this step. Otherwise, you may face the issue with reaching the maximum allowed number of license activation attempts (by default, 25). In this case, you need to [contact support](https://webspellchecker.com/contact-us/) to extend/reset the license activation limit. Nevertheless, using the public image is acceptable for evaluation, testing and development purposes.

manifests/deployment_http.yaml

@@ -3,10 +3,10 @@ kind: Deployment
 metadata:
   name: wproofreader-app
   labels:
-    helm.sh/chart: wproofreader-1.2.0
+    helm.sh/chart: wproofreader-1.3.0
     app.kubernetes.io/name: wproofreader
     app.kubernetes.io/instance: wproofreader-app
-    app.kubernetes.io/version: "5.39.1.0"
+    app.kubernetes.io/version: "6.2.0.0"
     app.kubernetes.io/managed-by: Helm
 spec:
   replicas: 1
@@ -34,7 +34,7 @@ spec:
         - name: wproofreader
           securityContext:
             {}
-          image: "webspellchecker/wproofreader:5.39.1.0"
+          image: "webspellchecker/wproofreader:6.2.0.0"
           imagePullPolicy: IfNotPresent
           ports:
             - name: container-port
@@ -56,13 +56,13 @@ spec:
             - mountPath: /dictionaries
               name: dictionaries-volume
           env:
-            - name: PROTOCOL
+            - name: WPR_PROTOCOL
               value: "2"
-            - name: WEB_PORT
+            - name: WPR_WEB_PORT
               value: "80"
-            - name: VIRTUAL_DIR
+            - name: WPR_VIRTUAL_DIR
               value: wscservice
-            - name: LICENSE_TICKET_ID
+            - name: WPR_LICENSE_TICKET_ID
               valueFrom:
                 secretKeyRef:
                   name: wproofreader-app-lic

manifests/deployment_https.yaml

@@ -3,10 +3,10 @@ kind: Deployment
 metadata:
   name: wproofreader-app
   labels:
-    helm.sh/chart: wproofreader-1.2.0
+    helm.sh/chart: wproofreader-1.3.0
     app.kubernetes.io/name: wproofreader
     app.kubernetes.io/instance: wproofreader-app
-    app.kubernetes.io/version: "5.39.1.0"
+    app.kubernetes.io/version: "6.2.0.0"
     app.kubernetes.io/managed-by: Helm
 spec:
   replicas: 1
@@ -34,7 +34,7 @@ spec:
         - name: wproofreader
           securityContext:
             {}
-          image: "webspellchecker/wproofreader:5.39.1.0"
+          image: "webspellchecker/wproofreader:6.2.0.0"
           imagePullPolicy: IfNotPresent
           ports:
             - name: container-port
@@ -58,13 +58,13 @@ spec:
             - mountPath: /dictionaries
               name: dictionaries-volume
           env:
-            - name: PROTOCOL
+            - name: WPR_PROTOCOL
               value: "1"
-            - name: WEB_PORT
+            - name: WPR_WEB_PORT
               value: "443"
-            - name: VIRTUAL_DIR
+            - name: WPR_VIRTUAL_DIR
               value: wscservice
-            - name: LICENSE_TICKET_ID
+            - name: WPR_LICENSE_TICKET_ID
               valueFrom:
                 secretKeyRef:
                   name: wproofreader-app-lic

manifests/hpa.yaml

@@ -3,10 +3,10 @@ kind: HorizontalPodAutoscaler
 metadata:
   name: wproofreader-app
   labels:
-    helm.sh/chart: wproofreader-1.2.0
+    helm.sh/chart: wproofreader-1.3.0
     app.kubernetes.io/name: wproofreader
     app.kubernetes.io/instance: wproofreader-app
-    app.kubernetes.io/version: "5.39.1.0"
+    app.kubernetes.io/version: "6.2.0.0"
     app.kubernetes.io/managed-by: Helm
 spec:
   scaleTargetRef:

manifests/secrets.yaml

@@ -3,10 +3,10 @@ kind: Secret
 metadata:
   name: wproofreader-app-lic
   labels:
-    helm.sh/chart: wproofreader-1.2.0
+    helm.sh/chart: wproofreader-1.3.0
     app.kubernetes.io/name: wproofreader
     app.kubernetes.io/instance: wproofreader-app
-    app.kubernetes.io/version: "5.39.1.0"
+    app.kubernetes.io/version: "6.2.0.0"
     app.kubernetes.io/managed-by: Helm
 type: Opaque
 data:
@@ -17,10 +17,10 @@ kind: Secret
 metadata:
   name: wproofreader-app-cert
   labels:
-    helm.sh/chart: wproofreader-1.2.0
+    helm.sh/chart: wproofreader-1.3.0
     app.kubernetes.io/name: wproofreader
     app.kubernetes.io/instance: wproofreader-app
-    app.kubernetes.io/version: "5.39.1.0"
+    app.kubernetes.io/version: "6.2.0.0"
     app.kubernetes.io/managed-by: Helm
 type: Opaque
 data:

manifests/service_http.yaml

@@ -3,10 +3,10 @@ kind: Service
 metadata:
   name: wproofreader-app
   labels:
-    helm.sh/chart: wproofreader-1.2.0
+    helm.sh/chart: wproofreader-1.3.0
     app.kubernetes.io/name: wproofreader
     app.kubernetes.io/instance: wproofreader-app
-    app.kubernetes.io/version: "5.39.1.0"
+    app.kubernetes.io/version: "6.2.0.0"
     app.kubernetes.io/managed-by: Helm
 spec:
   type: ClusterIP

manifests/service_https.yaml

@@ -3,10 +3,10 @@ kind: Service
 metadata:
   name: wproofreader-app
   labels:
-    helm.sh/chart: wproofreader-1.2.0
+    helm.sh/chart: wproofreader-1.3.0
     app.kubernetes.io/name: wproofreader
     app.kubernetes.io/instance: wproofreader-app
-    app.kubernetes.io/version: "5.39.1.0"
+    app.kubernetes.io/version: "6.2.0.0"
     app.kubernetes.io/managed-by: Helm
 spec:
   type: ClusterIP

manifests/serviceaccount.yaml

@@ -3,8 +3,8 @@ kind: ServiceAccount
 metadata:
   name: wproofreader-app
   labels:
-    helm.sh/chart: wproofreader-1.2.0
+    helm.sh/chart: wproofreader-1.3.0
     app.kubernetes.io/name: wproofreader
     app.kubernetes.io/instance: wproofreader-app
-    app.kubernetes.io/version: "5.39.1.0"
+    app.kubernetes.io/version: "6.2.0.0"
     app.kubernetes.io/managed-by: Helm

manifests/volumes.yaml

@@ -3,10 +3,10 @@ kind: PersistentVolume
 metadata:
   name: wproofreader-app-dict
   labels:
-    helm.sh/chart: wproofreader-1.2.0
+    helm.sh/chart: wproofreader-1.3.0
     app.kubernetes.io/name: wproofreader
     app.kubernetes.io/instance: wproofreader-app
-    app.kubernetes.io/version: "5.39.1.0"
+    app.kubernetes.io/version: "6.2.0.0"
     app.kubernetes.io/managed-by: Helm
 spec:
   storageClassName: standard
@@ -29,10 +29,10 @@ kind: PersistentVolumeClaim
 metadata:
   name: wproofreader-app-dict
   labels:
-    helm.sh/chart: wproofreader-1.2.0
+    helm.sh/chart: wproofreader-1.3.0
     app.kubernetes.io/name: wproofreader
     app.kubernetes.io/instance: wproofreader-app
-    app.kubernetes.io/version: "5.39.1.0"
+    app.kubernetes.io/version: "6.2.0.0"
     app.kubernetes.io/managed-by: Helm
 spec:
   storageClassName: standard

wproofreader/Chart.yaml

@@ -4,6 +4,6 @@ description: A Helm chart for deploying webspellchecker/wproofreader in Kubernet
 
 type: application
 
-version: 1.2.0
+version: 1.3.0
 
-appVersion: "5.39.1.0"
+appVersion: "6.2.0.0"

wproofreader/templates/deployment.yaml

@@ -68,16 +68,16 @@ spec:
             - mountPath: {{ .Values.dictionaries.mountPath | default "/dictionaries" }}
               name: dictionaries-volume
           env:
-            - name: PROTOCOL
+            - name: WPR_PROTOCOL
               value: {{ if .Values.useHTTPS }}"1"{{ else }}"2"{{ end }}
-            - name: WEB_PORT
+            - name: WPR_WEB_PORT
               value: {{ .Values.webPort | default (include "wproofreader.defaultWebPort" .) | quote }}
-            - name: VIRTUAL_DIR
+            - name: WPR_VIRTUAL_DIR
               value: {{ .Values.virtualDir }}
             {{- with .Values.extraEnv }}
             {{- toYaml . | nindent 12 }}
             {{- end }}
-            - name: LICENSE_TICKET_ID
+            - name: WPR_LICENSE_TICKET_ID
               valueFrom:
                 secretKeyRef:
                   name: {{ include "wproofreader.fullname" . }}-lic

wproofreader/values.yaml

@@ -15,7 +15,7 @@ licenseTicketID: ""
 # extra environment variables to pass to the container
 extraEnv: []
 # extraEnv:
-#   - name: DOMAIN_NAME
+#   - name: WPR_DOMAIN_NAME
 #     value: "wproofreader.domain-name.com"
 
 # directory of the service for web and API requests, e.g. http://localhost/wscservice/api?cmd=ver
@@ -25,13 +25,13 @@ virtualDir: wscservice
 # note: Helm cannot reach outside its chart directory to fetch your files
 # leave empty if they are already present in the container
 # use same file names as those specified in Dockerfile
-# (i.e. CERT_CERT_NAME and CERT_KEY_NAME variables in WProofreader official Dockerfile: https://github.com/WebSpellChecker/wproofreader-docker)
+# (i.e. WPR_CERT_FILE_NAME and WPR_CERT_KEY_NAME variables in WProofreader official Dockerfile: https://github.com/WebSpellChecker/wproofreader-docker)
 # otherwise, one would have to manually edit the nginx config file (/etc/nginx/conf.d/wscservice.conf) on each Pod (in each container instance)
 certFile: ""
 keyFile: ""
 # directory where the certificate and its key will be kept inside the container
 # same remark as the one above on matching the Dockerfile variables applies
-# (i.e. CERT_DIR variable in WProofreader official Dockerfile: https://github.com/WebSpellChecker/wproofreader-docker)
+# (i.e. WPR_CERT_DIR variable in WProofreader official Dockerfile: https://github.com/WebSpellChecker/wproofreader-docker)
 certMountPath: "/certificate"
 
 # `dictionaries` structure provide storage for custom user dictionaries inside the cluster
@@ -44,7 +44,7 @@ dictionaries:
   # leave empty if no volume for custom dictionaries should be created.
   localPath: ""
   # location inside the container that the above directory should be mounted to
-  # make sure it matches DICTIONARIES_DIR variable in the Dockerfile (https://github.com/WebSpellChecker/wproofreader-docker)
+  # make sure it matches WPR_DICTIONARIES_DIR variable in the Dockerfile (https://github.com/WebSpellChecker/wproofreader-docker)
   mountPath: "/dictionaries"
   # maximum volume size – make sure it can accommodate all your data
   volumeSize: "20Gi"