Rebase

.dockerignore

@@ -3,7 +3,11 @@ docker/data
 *Dockerfile
 *.md
 .dockerignore
-.env*
-*.sqlite*
 nginx.conf
-supervisord.conf
+supervisord.conf
+*.md
+.github
+.idea
+docker-compose
+docs
+chart

Dockerfile

@@ -41,13 +41,15 @@ RUN addgroup --g 1000 -S www && \
   chown -R mercator:www /var/www /var/lib/nginx /var/log/nginx /etc/nginx/http.d
 
 # Clone sources from Github
-WORKDIR /var/www/
-RUN git clone https://github.com/dbarzin/mercator.git/
+#WORKDIR /var/www/
+#RUN git clone https://github.com/dbarzin/mercator.git/
+RUN mkdir /var/www/mercator
 WORKDIR /var/www/mercator
+COPY . .
 
 # Copy config files
-RUN cp docker/nginx.conf /etc/nginx/http.d/default.conf
-RUN cp docker/supervisord.conf /etc/supervisord.conf
+COPY docker/nginx.conf /etc/nginx/http.d/default.conf
+COPY docker/supervisord.conf /etc/supervisord.conf
 
 # change owner
 RUN chown -R mercator:www /var/www/mercator

_helm_chart/chart/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

_helm_chart/chart/Chart.lock

@@ -0,0 +1,9 @@
+dependencies:
+- name: redis
+  repository: oci://registry-1.docker.io/bitnamicharts
+  version: 20.1.7
+- name: postgresql
+  repository: oci://registry-1.docker.io/bitnamicharts
+  version: 16.0.1
+digest: sha256:432a55311d15e571a708a4299fc288c4c78c3ca9bf891172021568bf6a20c7eb
+generated: "2024-10-06T20:21:49.987133+02:00"

_helm_chart/chart/Chart.yaml

@@ -0,0 +1,36 @@
+apiVersion: v2
+name: mercator
+description: A Helm chart for running Mercator via Kubernetes
+home: https://github.com/dbarzin/mercator
+maintainers:
+  - name: Mercator
+    url: https://github.com/dbarzin/mercator/chart
+dependencies:
+  - condition: redis.enabled
+    name: redis
+    repository: oci://registry-1.docker.io/bitnamicharts
+    version: 20.x.x
+  - condition: postgresql.enabled
+    name: postgresql
+    repository: oci://registry-1.docker.io/bitnamicharts
+    version: 16.x.x
+# 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
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+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.1.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
+# follow Semantic Versioning. They should reflect the version the application is using.
+# It is recommended to use it with quotes.
+appVersion: "0.1.0"

_helm_chart/chart/README.md

@@ -0,0 +1,123 @@
+# Mercator Helm Chart
+## TL;DR
+
+```bash
+helm install mercator .
+```
+
+## Introduction 
+
+This chart bootstraps **Mercator** deployment on a [Kubernetes](https://kubernetes.io/) cluster using the [Helm](https://helm.sh/) package manager.
+
+## Prerequisites
+- Kubernetes 1.23+
+- Helm 3.8.0+
+
+## Persistence
+The Mercator chart relies on the PostgreSQL chart persistence. This means that Mercator does not persist anything.
+
+## Parameters
+This part provides an overview of all the configurable parameters used in the `values.yaml` file for deploying the Mercator application using a Helm chart.
+
+### Global parameters
+
+| Parameter                                      | Description                                                                  | Default Value              |
+|------------------------------------------------|------------------------------------------------------------------------------|----------------------------|
+| **replicaCount**                               | Number of application replicas to deploy.                                    | `1`                        |
+| **image.repository**                           | Docker image repository for the Mercator application.                        | `ghcr.io/dbarzin/mercator` |
+| **image.pullPolicy**                           | Specifies when to pull the Docker image (`Always`, `IfNotPresent`, `Never`). | `IfNotPresent`             |
+| **image.tag**                                  | Tag of the Docker image.                                                     | `"latest"`                 |
+| **imagePullSecrets**                           | Secrets to use for pulling private Docker images.                            | `[]`                       |
+| **serviceAccount.create**                      | Specifies whether a service account should be created.                       | `true`                     |
+| **serviceAccount.automount**                   | Automatically mount the ServiceAccount’s API credentials.                    | `true`                     |
+| **serviceAccount.annotations**                 | Annotations to add to the service account.                                   | `{}`                       |
+| **serviceAccount.name**                        | Name of the service account to use or create.                                | `""`                       |
+| **podAnnotations**                             | Annotations to add to the pod.                                               | `{}`                       |
+| **podLabels**                                  | Labels to add to the pod.                                                    | `{}`                       |
+| **podSecurityContext**                         | Security context for the pod.                                                | `{}`                       |
+| **securityContext**                            | Security context for the container, e.g., user permissions.                  | `{}`                       |
+| **service.type**                               | Kubernetes service type (`ClusterIP`, `NodePort`, `LoadBalancer`).           | `ClusterIP`                |
+| **service.port**                               | Port exposed by the service.                                                 | `80`                       |
+| **ingress.enabled**                            | Enable or disable ingress resource creation.                                 | `false`                    |
+| **resources**                                  | Resource limits and requests for the application.                            | `{}`                       |
+| **livenessProbe.httpGet.path**                 | HTTP path for liveness probe.                                                | `/`                        |
+| **livenessProbe.httpGet.port**                 | Port for liveness probe.                                                     | `http`                     |
+| **readinessProbe.httpGet.path**                | HTTP path for readiness probe.                                               | `/`                        |
+| **readinessProbe.httpGet.port**                | Port for readiness probe.                                                    | `http`                     |
+| **autoscaling.enabled**                        | Enable or disable horizontal pod autoscaling.                                | `false`                    |
+| **autoscaling.minReplicas**                    | Minimum number of replicas for autoscaling.                                  | `1`                        |
+| **autoscaling.maxReplicas**                    | Maximum number of replicas for autoscaling.                                  | `100`                      |
+| **autoscaling.targetCPUUtilizationPercentage** | Target CPU utilization for autoscaling.                                      | `80`                       |
+| **volumes**                                    | Additional volumes for the deployment.                                       | `[]`                       |
+| **volumeMounts**                               | Additional volume mounts for the deployment.                                 | `[]`                       |
+| **nodeSelector**                               | Node selector for scheduling pods.                                           | `{}`                       |
+| **tolerations**                                | Tolerations for scheduling pods.                                             | `[]`                       |
+| **affinity**                                   | Affinity rules for scheduling pods.                                          | `{}`                       |
+
+### Mercator parameters
+
+| Parameter                                  | Description                                                                  | Default Value                |
+|--------------------------------------------|------------------------------------------------------------------------------|------------------------------|
+| **debug**                                  | Enable debug mode for the application.                                       | `false`                      |
+| **environment**                            | Environment to deploy (`development`, `production`).                         | `"development"`              |
+| **key**                                    | Secret key for the application.                                              | `""`                         |
+| **reverse_proxy**                          | URL for the reverse proxy used by the application.                           | `"http://localhost"`         |
+| **use_demo_data**                          | Specify if demo data should be used (1 for true, 0 for false).               | `1`                          |
+
+### Mercator LDAP parameters
+
+| Parameter                                  | Description                                                                  | Default Value                |
+|--------------------------------------------|------------------------------------------------------------------------------|------------------------------|
+| **ldap.enabled**                           | Enable or disable LDAP integration.                                          | `false`                      |
+| **ldap.type**                              | Type of LDAP server (e.g., Active Directory).                                | `"AD"`                       |
+| **ldap.host**                              | LDAP server host.                                                            | `"127.0.0.1"`                |
+| **ldap.username**                          | LDAP bind user credentials.                                                  | `"cn=user,dc=local,dc=com"`  |
+| **ldap.password**                          | Password for the LDAP bind user.                                             | `"secret"`                   |
+| **ldap.base_dn**                           | Base DN for LDAP queries.                                                    | `"dc=local,dc=com"`          |
+| **ldap.service.number**                    | LDAP service port number.                                                    | `"389"`                      |
+| **ldap.scope**                             | Scope for LDAP queries.                                                      | `"ou=Accounting,dc=com"`     |
+
+### Mercator SMTP parameters
+| Parameter                                  | Description                                                                  | Default Value                |
+|--------------------------------------------|------------------------------------------------------------------------------|------------------------------|
+| **smtp.host**                              | SMTP server host for sending emails.                                         | `"smtp.mailtrap.io"`         |
+| **smtp.port**                              | SMTP server port.                                                            | `"25"`                       |
+| **smtp.username**                          | SMTP username for authentication.                                            | `""`                         |
+| **smtp.password**                          | SMTP password for authentication.                                            | `""`                         |
+
+### Mercator AWS parameters
+| Parameter                                  | Description                                                                  | Default Value                |
+|--------------------------------------------|------------------------------------------------------------------------------|------------------------------|
+| **aws.access_key_id**                      | AWS access key ID.                                                           | `""`                         |
+| **aws.secret_access_key**                  | AWS secret access key.                                                       | `""`                         |
+| **aws.default_region**                     | Default AWS region.                                                          | `"us-east-1"`                |
+| **aws.bucket**                             | AWS S3 bucket name.                                                          | `""`                         |
+
+### Mercator PUSHER parameters
+| Parameter                                  | Description                                                                  | Default Value                |
+|--------------------------------------------|------------------------------------------------------------------------------|------------------------------|
+| **pusher.app_id**                          | Pusher app ID.                                                               | `""`                         |
+| **pusher.app_key**                         | Pusher app key.                                                              | `""`                         |
+| **pusher.app_secret**                      | Pusher app secret.                                                           | `""`                         |
+
+### Mercator KEYCLOAK parameters
+| Parameter                                  | Description                                                                  | Default Value                |
+|--------------------------------------------|------------------------------------------------------------------------------|------------------------------|
+| **keycloak.enabled**                       | Enable or disable Keycloak integration.                                      | `false`                      |
+| **keycloak.client_id**                     | Keycloak client ID.                                                          | `""`                         |
+| **keycloak.client_secret**                 | Keycloak client secret.                                                      | `""`                         |
+| **keycloak.redirect_uri**                  | Redirect URI for Keycloak integration.                                       | `""`                         |
+| **keycloak.base_url**                      | Base URL of Keycloak server.                                                 | `""`                         |
+| **keycloak.realm**                         | Keycloak realm name.                                                         | `""`                         |
+
+### Mercator database parameters
+
+| Parameter                                  | Description                                                                  | Default Value                |
+|--------------------------------------------|------------------------------------------------------------------------------|------------------------------|
+| **secret.postgres.postgresPassword**       | PostgreSQL password for the application.                                     | `"2ù_-qeeYT21!8zA2~"`        |
+| **postgresql.enabled**                     | Enable or disable PostgreSQL deployment.                                     | `true`                       |
+| **postgresql.auth.username**               | PostgreSQL username for authentication.                                      | `"mercator_user"`            |
+| **postgresql.auth.database**               | PostgreSQL database name.                                                    | `"mercator"`                 |
+| **redis.enabled**                          | Enable or disable Redis deployment.                                          | `true`                       |
+| **redis.auth.enabled**                     | Enable or disable Redis authentication.                                      | `true`                       |
+| **redis.auth.password**                    | Password for Redis authentication.                                           

_helm_chart/chart/templates/NOTES.txt

@@ -0,0 +1,22 @@
+1. Get the application URL by running these commands:
+{{- if .Values.ingress.enabled }}
+{{- range $host := .Values.ingress.hosts }}
+  {{- range .paths }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
+  {{- end }}
+{{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "chart.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT
+{{- else if contains "LoadBalancer" .Values.service.type }}
+     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
+           You can watch its status by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "chart.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "chart.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
+  echo http://$SERVICE_IP:{{ .Values.service.port }}
+{{- else if contains "ClusterIP" .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "chart.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
+{{- end }}