ONLYOFFICE Docs pour Kubernetes

1. Ajouter les référentiels Helm

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
$ helm repo add nfs-server-provisioner https://kubernetes-sigs.github.io/nfs-ganesha-server-and-external-provisioner
$ helm repo add onlyoffice https://download.onlyoffice.com/charts/stable
$ helm repo update

2. Installer Stockage persistant

Installer NFS Server Provisioner

$ helm install nfs-server nfs-server-provisioner/nfs-server-provisioner \
  --set persistence.enabled=true \
  --set persistence.storageClass=PERSISTENT_STORAGE_CLASS \
  --set persistence.size=PERSISTENT_SIZE

• PERSISTENT_STORAGE_CLASS est une classe de stockage persistant disponible dans votre cluster Kubernetes.

  Classes de stockage persistant pour différents fournisseurs :

  • Amazon EKS: gp2
  • Digital Ocean: do-block-storage
  • IBM Cloud: Default ibmc-file-bronze. Plus de classes de stockage
  • Yandex Cloud: yc-network-hdd or yc-network-ssd. Plus de détails
  • minikube: standard
• PERSISTENT_SIZE est la taille totale de tous les stockages persistants pour la classe de stockage persistant NFS. Vous pouvez exprimer la taille sous forme d'entier simple avec l'un de ces suffixes : T, G, M, Ti, Gi, Mi. Par exemple : 9Gi.

Consultez plus de détails sur l'installation de NFS Server Provisioner via Helm ici.

Configurer une demande de volume persistant

The default nfs Persistent Volume Claim is 8Gi. You can change it in the values.yaml dans la section persistence.storageClass and persistence.size Elle doit être inférieure à PERSISTENT_SIZE d'au moins 5 %. Il est recommandeé d'utiliser 8 Gi ou plus de stockage persistant pour chaque tranche de 100 utilisateurs actifs d'ONLYOFFICE Docs.

If you want to enable WOPI, please set the parameter wopi.enabled=true. Dans ce cas, le stockage persistant doit être connecté aux nœuds du cluster avec les attributs de mise en cache désactivés pour le répertoire monté pour les clients. Pour NFS Server Provisioner, cela peut être réalisé en ajoutant l'option noac au paramètre storageClass.mountOptions. Veuillez trouver plus d'informations ici.

3. Déployer RabbitMQ

Pour installer RabbitMQ dans votre cluster, exécutez la commandee suivante :

$ helm install rabbitmq --version 16.0.14 bitnami/rabbitmq \
  --set persistence.storageClass=PERSISTENT_STORAGE_CLASS \
  --set resourcesPreset=none \
  --set image.repository=bitnamilegacy/rabbitmq \
  --set image.tag=4.1.3-debian-12-r1 \
  --set global.security.allowInsecureImages=true \
  --set metrics.enabled=false

Consultez plus de détails sur l'installation de RabbitMQ via Helm ici.

4. Déployer Redis

Pour installer Redis dans votre cluster, exécutez la commandee suivante :

$ helm install redis --version 22.0.7 bitnami/redis \
  --set architecture=standalone \
  --set master.persistence.storageClass=PERSISTENT_STORAGE_CLASS \
  --set master.resourcesPreset=none \
  --set global.security.allowInsecureImages=true \
  --set image.repository=bitnamilegacy/redis \
  --set image.tag=8.2.1-debian-12-r0 \
  --set metrics.enabled=false

Consultez plus de détails sur l'installation de Redis via Helm ici.

5. Déployer une base de données

En tant que serveur de base de données, vous pouvez utiliser PostgreSQL, MySQL ou MariaDB.

$ helm install postgresql --version 16.7.27 bitnami/postgresql \
  --set auth.database=postgres \
  --set primary.persistence.storageClass=PERSISTENT_STORAGE_CLASS \
  --set primary.persistence.size=PERSISTENT_SIZE \
  --set primary.resourcesPreset=none \
  --set image.repository=bitnamilegacy/postgresql \
  --set global.security.allowInsecureImages=true \
  --set image.tag=17.6.0-debian-12-r2 \
  --set metrics.enabled=false

$ helm install mysql --version 14.0.3 bitnami/mysql \
  --set auth.database=onlyoffice \
  --set auth.username=onlyoffice \
  --set primary.persistence.storageClass=PERSISTENT_STORAGE_CLASS \
  --set primary.persistence.size=PERSISTENT_SIZE \
  --set primary.resourcesPreset=none \
  --set image.repository=bitnamilegacy/mysql \
  --set global.security.allowInsecureImages=true \
  --set image.tag=9.4.0-debian-12-r1 \
  --set metrics.enabled=false

6. Deployer StatsD

1. Ajouter les dépôts Helm

   $ helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
   $ helm repo add kube-state-metrics https://kubernetes.github.io/kube-state-metrics
   $ helm repo update

2. Installer Prometheus

   Pour installer Prometheus dans votre cluster, exécutez la commandee suivante :

   $ helm install prometheus -f https://raw.githubusercontent.com/ONLYOFFICE/Kubernetes-Docs/master/sources/extraScrapeConfigs.yaml prometheus-community/prometheus \
     --set server.global.scrape_interval=1m

   Pour modifier l'intervalle de scrape, spécifiez le paramètre server.global.scrape_interval parameter.

   Consultez plus de détails sur l'installation de Prometheus via Helm ici.

3. Installer StatsD

   Pour installer l'exportateur StatsD dans votre cluster, exécutez la commandee suivante :

   $ helm install statsd-exporter prometheus-community/prometheus-statsd-exporter \
     --set statsd.udpPort=8125 \
     --set statsd.tcpPort=8126 \
     --set statsd.eventFlushInterval=30000ms

   Consultez plus de détails sur l'installation de l'exportateur Prometheus StatsD via Helm ici.

   Pour autoriser les métriques StatsD dans ONLYOFFICE Docs, suivez cette étape.

7. Apporter des modifications au fichiers de configuration Node-config

1. Créer un ConfigMap contenant un fichier json

   Pour créer un ConfigMap à partir d'un fichier contenant la structure local.json vous devez exécuter la commandee suivante :

   $ kubectl create configmap local-config \
     --from-file=./local.json

   Tout nom peut être utilisé à la place de local-config.
2. Spécifier les paramètres lors de l'installation d'ONLYOFFICE Docs

   Lors de l'installation d'ONLYOFFICE Docs, spécifiez les paramètres extraConf.configMap=local-config et extraConf.filename=local.json.

   Si vous devez ajouter un fichier de configuration après l'installation d'ONLYOFFICE Docs, vous devez exécuter step 7.1 puis exécuter la commandee

   helm upgrade documentserver onlyoffice/docs --set extraConf.configMap=local-config --set extraConf.filename=local.json --no-hooks

   ou

   helm upgrade documentserver -f ./values.yaml onlyoffice/docs --no-hooks

   si les paramètres sont spécifiés dans le fichier values.yaml fichier.

8. Ajouter des polices personnalisées

Pour ajouter des polices aux images, vous devez reconstruire les images. Référez-vous aux étapes pertinentes dans this ce manuel. Ensuite, spécifiez vos images lors de l'installation d'ONLYOFFICE Docs.

9. Ajouter des plugins

Pour ajouter des plugins aux images, vous devez reconstruire les images. Référez-vous aux étapes pertinentes dans this ce manuel. Ensuite, spécifiez vos images lors de l'installation d'ONLYOFFICE Docs.

10. Ajouter des dictionnaires personnalisés

Pour ajouter vos dictionnaires personnalisés aux images, vous devez reconstruire les images. Référez-vous aux étapes pertinentes dans this ce manuel. Ensuite, spécifiez vos images lors de l'installation d'ONLYOFFICE Docs.

11. Modifier les thèmes d'interface

1. Créer un ConfigMap contenant un fichier json

   Pour créer un ConfigMap avec un fichier json contenant les thèmes d'interface, vous devez exécuter la commandee suivante :

   $ kubectl create configmap custom-themes \
     --from-file=./custom-themes.json

   Au lieu de custom-themes and custom-themes.json vous pouvez utiliser d'autres noms.
2. Spécifier les paramètres lors de l'installation d'ONLYOFFICE Docs

   Lors de l'installation d'ONLYOFFICE Docs, spécifiez les paramètres extraThemes.configMap=custom-themes et extraThemes.filename=custom-themes.json.

   If you need to add interface themes after the ONLYOFFICE Docs is already installed, you need to execute step 11.1 puis exécuter la commandee helm upgrade documentserver onlyoffice/docs --set extraThemes.configMap=custom-themes --set extraThemes.filename=custom-themes.json --no-hooks ou helm upgrade documentserver -f ./values.yaml onlyoffice/docs --no-hooks si les paramètres sont spécifiés dans le fichier values.yaml fichier.

12. Connecter un compartiment Amazon en tant que cache à ONLYOFFICE Helm Docs

Pour connecter un compartiment Amazon S3 comme cache, vous devez create un fichier de configuration ou modifier celui existant conformément à this guide and change the value of the parameter persistence.storageS3 to true.

1. Deployer la licence ONLYOFFICE Docs

1. Créer un secret

   Si vous disposez d'une licence ONLYOFFICE Docs valide, créez un secret license à partir du fichier :

   $ kubectl create secret generic [SECRET_LICENSE_NAME] --from-file=path/to/license.lic

   Wici SECRET_LICENSE_NAME est le nom d'un futur secret contenant une licence.

   Le nom du fichier de licence source doit être 'license.lic' car ce nom sera utilisé comme champ dans le secret créé.

   Si l'installation est effectuée sans créer de secret avec le fichier de licence existant, un secret vide license sera automatiquement créé. Pour savoir comment mettre à jour un secret existant avec une licence, voir ici.
2. Spécifier les paramètres lors de l'installation d'ONLYOFFICE Docs

   Lors de l'installation d'ONLYOFFICE Docs, spécifiez le paramètre license.existingSecret=[SECRET_LICENSE_NAME].

   $ helm install documentserver onlyoffice/docs --set license.existingSecret=[SECRET_LICENSE_NAME]

   If you need to add license after the ONLYOFFICE Docs is already installed, you need to execute step 1.1 puis exécuter la commandee helm upgrade documentserver onlyoffice/docs --set license.existingSecret=[SECRET_LICENSE_NAME] --no-hooks ou helm upgrade documentserver -f ./values.yaml onlyoffice/docs --no-hooks si les paramètres sont spécifiés dans le fichier values.yaml fichier.

2. Deployer ONLYOFFICE Docs

Pour déployer ONLYOFFICE Docs avec le nom de version documentserver:

$ helm install documentserver onlyoffice/docs

La commandee déploie ONLYOFFICE Docs sur le cluster Kubernetes dans la configuration par défaut. La section Paramètres répertorie les paramètres pouvant être configurés lors de l'installation.

3. Désinstaller ONLYOFFICE Docs

Pour désinstaller/supprimer le déploiement documentserver :

$ helm delete documentserver

Executing the helm delete La commandee lance des hooks qui effectuent des actions préparatoires avant de supprimer complètement ONLYOFFICE Docs, notamment l'arrêt du serveur, le nettoyage des PVC utilisés et des tables de base de données. Le temps d'exécution des hooks par défaut est de 300 s. Le temps d'exécution peut être modifié avec --timeout [time], par exemple :

$ helm delete documentserver --timeout 25m

Si vous souhaitez supprimer ONLYOFFICE Docs sans actions préparatoires, exécutez la commandee suivante :

$ helm delete documentserver --no-hooks

The helm delete supprime tous les composants Kubernetes associés au chart et supprime la version.

4. Paramèters

Spécifiez chaque paramètre en utilisant l'argument --set key=value[,key=value] pour helm install. Par exemple :

$ helm install documentserver onlyoffice/docs --set ingress.enabled=true,ingress.ssl.enabled=true,ingress.host=example.com

Cette commandee expose ONLYOFFICE Docs via HTTPS.

Vous pouvez également fournir un fichier YAML spécifiant les valeurs des paramètres lors de l'installation du chart :

$ helm install documentserver -f values.yaml onlyoffice/docs

5. Détails de configuration et installation

1. Déploiement de l'exemple (optionnel)
   Important Cette étape est optionnelle. Vous pouvez l'ignorer entièrement si vous n'avez pas besoin de déployer l'exemple.

   Pour déployer l'exemple, définissez le paramètre example.enabled à true :

   $ helm install documentserver onlyoffice/docs --set example.enabled=true

2. Déploiement des métriques (optionnel)

   Important Cette étape est optionnelle. Vous pouvez l'ignorer entièrement si vous n'avez pas besoin de déployer les métriques.

   Pour déployer les métriques, définissez metrics.enabled à true :

   $ helm install documentserver onlyoffice/docs --set metrics.enabled=true

   Si vous souhaitez utiliser Grafana pour visualiser les métriques, définissez grafana.enabled à true. Si vous souhaitez utiliser Nginx Ingress pour accéder à Grafana, définissez grafana.ingress.enabled à true :

   $ helm install documentserver onlyoffice/docs --set grafana.enabled=true --set grafana.ingress.enabled=true

3. Exposer ONLYOFFICE Docs
   1. Exposer ONLYOFFICE Docs via Service (HTTP uniquement)
      Vous devez ignorer cette étape si vous allez exposer ONLYOFFICE Docs via HTTPS.

      Ce type d'exposition crée un équilibreur de charge pour accéder à ONLYOFFICE Docs. Utilisez ce type si vous utilisez la terminaison TLS externe et n'avez pas d'autre application web dans le cluster k8s.

      Pour exposer ONLYOFFICE Docs via service, définissez le paramètre service.type à LoadBalancer :

      $ helm install documentserver onlyoffice/docs --set service.type=LoadBalancer,service.port=80

      Exécutez la commande suivante pour obtenir l'IP du service documentserver :

      $ kubectl get service documentserver -o jsonpath="{.status.loadBalancer.ingress[*].ip}"

      Ensuite, ONLYOFFICE Docs sera disponible sur http://DOCUMENTSERVER-SERVICE-IP/.

      Si l'IP du service est vide, essayez d'obtenir le nom d'hôte du service documentserver :

      $ kubectl get service documentserver -o jsonpath="{.status.loadBalancer.ingress[*].hostname}"

      Dans ce cas, ONLYOFFICE Docs sera disponible sur http://DOCUMENTSERVER-SERVICE-HOSTNAME/.

   2. Exposer ONLYOFFICE Docs via Ingress

      Premièrement, installez le contrôleur Kubernetes Nginx Ingress :

      $ helm install nginx-ingress ingress-nginx/ingress-nginx --set controller.publishService.enabled=true,controller.replicaCount=2

      Pour activer l'exposition des métriques ingress-nginx à Prometheus, exécutez :

      $ helm install nginx-ingress -f https://raw.githubusercontent.com/ONLYOFFICE/Kubernetes-Docs/master/sources/ingress_values.yaml ingress-nginx/ingress-nginx

      Consultez plus de détails sur l'installation de Nginx Ingress via Helm ici.

      Choisissez ensuite votre méthode d'exposition :

      • Via HTTP

        Vous devez ignorer ceci si vous allez exposer ONLYOFFICE Docs via HTTPS.

        $ helm install documentserver onlyoffice/docs --set ingress.enabled=true

        Obtenez l'IP de l'ingress :

        $ kubectl get ingress documentserver -o jsonpath="{.status.loadBalancer.ingress[*].ip}"

        ONLYOFFICE Docs sera disponible sur http://DOCUMENTSERVER-INGRESS-IP/ (ou utilisez le nom d'hôte si l'IP est vide).

      • Via HTTPS (terminaison TLS)

        Créez le secret tls avec votre certificat SSL :

        $ kubectl create secret generic tls \
          --from-file=./tls.crt \
          --from-file=./tls.clé

        $ helm install documentserver onlyoffice/docs --set ingress.enabled=true,ingress.ssl.enabled=true,ingress.host=example.com

        Associez l'IP ou le nom d'hôte de l'ingress à votre nom de domaine via votre fournisseur DNS. Ensuite, ONLYOFFICE Docs sera disponible à https://your-domain-name/.

      • Via HTTPS avec Let's Encrypt

        $ helm repo add jetstack https://charts.jetstack.io
        $ helm repo update

        $ helm install cert-manager --version v1.17.4 jetstack/cert-manager \
          --namespace cert-manager \
          --create-namespace \
          --set crds.enabled=true \
          --set crds.keep=false

        Installez ou mettez à niveau ONLYOFFICE Docs en définissant ingress.enabled, ingress.ssl.enabled, ingress.letsencrypt.enabled à true, et en spécifiant vos valeurs pour ingress.letsencrypt.email et ingress.host (ou ingress.tenants pour plusieurs domaines).

      • Via un chemin virtuel

        Définissez les paramètres ingress.enabled, ingress.host et ingress.path :

        $ helm install documentserver onlyoffice/docs --set ingress.enabled=true,ingress.host=your-domain-name,ingress.path=/docs

        Contrôleurs d'ingress pris en charge : Ingress NGINX by Kubernetes, NGINX Ingress by NGINX, HAProxy Ingress by HAProxy.

        Pour Ingress NGINX by Kubernetes, ajoutez le modèle (/|$)(.*) à ingress.path, par ex. /docs(/|$)(.*).

   3. Exposer ONLYOFFICE Docs via une route dans OpenShift

      $ helm install documentserver onlyoffice/docs --set openshift.route.enabled=true,openshift.route.host=your-domain-name,openshift.route.path=/docs

      Pour la terminaison TLS, ajoutez manuellement des certificats à la route via la console web OpenShift.

6. Mettre à l'échelle ONLYOFFICE Docs

1. Mise à l'échelle automatique horizontale des pods

   Vous pouvez activer la mise à l'échelle automatique afin que le nombre de réplicas des déploiements docservice and converter soit calculé automatiquement en fonction des valeurs et du type de métriques.

   Pour les métriques de ressources, l'API metrics.k8s.io doit être enregistrée, ce qui est généralement fourni par metrics-server. Elle peut être lancée en tant qu'add-on de cluster.

   Pour activer HPA pour le déploiement docservice, spécifiez le paramètre docservice.autoscaling.enabled=true. De même, pour activer HPA pour le déploiement converter, spécifiez converter.autoscaling.enabled=true. Dans les deux cas, le paramètre replicas correspondant est ignoré et le nombre de réplicas est contrôlé par HPA.

   Pour plus d'informations sur la mise à l'échelle automatique horizontale des pods, voir ici. For other configurable Autoscaling parameters, see the Paramètres table.

2. Mise à l'échelle manuelle

   Les déploiements docservice et converter sont composés de 2 pods chacun par défaut.

   Pour mettre à l'échelle le déploiement docservice :

   $ kubectl scale -n default deployment docservice --replicas=POD_COUNT

   Pour mettre à l'échelle le déploiement converter :

   $ kubectl scale -n default deployment converter --replicas=POD_COUNT

7. Mettre à jour ONLYOFFICE Docs

Pour mettre à jour, définissez les paramètres de mise à niveau. Par exemple :

$ helm upgrade documentserver onlyoffice/docs \
  --set docservice.image.tag=[version]

Ou modifiez le fichier values.yaml et exécutez :

$ helm upgrade documentserver -f values.yaml onlyoffice/docs

La commande helm upgrade exécute un hook qui arrête ONLYOFFICE Docs et nettoie la base de données. Le temps d'exécution par défaut du hook est de 300 s. Pour le modifier :

$ helm upgrade documentserver -f values.yaml onlyoffice/docs --timeout 15m

Pour mettre à jour tout paramètre autre que la version d'ONLYOFFICE Docs, exécutez helm upgrade sans hooks :

$ helm upgrade documentserver onlyoffice/docs --set jwt.enabled=false --no-hooks

Pour annuler les mises à jour :

$ helm rollback documentserver

8. Arrêter ONLYOFFICE Docs

Pour effectuer l'arrêt, exécutez la commandee suivante :

$ kubectl apply -f https://raw.githubusercontent.com/ONLYOFFICE/Kubernetes-Docs/master/sources/shutdown-ds.yaml -n <NAMESPACE>

Wici <NAMESPACE> est le namespace dans lequel ONLYOFFICE Docs est installé. La valeur par défaut est default if not specified. Par exemple :

$ kubectl apply -f https://raw.githubusercontent.com/ONLYOFFICE/Kubernetes-Docs/master/sources/shutdown-ds.yaml -n onlyoffice

Après que le pod shutdown-ds s'est exécuté avec succès, supprimez le Job :

$ kubectl delete job shutdown-ds -n <NAMESPACE>

Pour redémarrer ONLYOFFICE Docs après l'arrêt, redémarrez les pods docservice et converter :

$ kubectl delete pod converter-*** docservice-*** -n <NAMESPACE>

9. Mettre à jour votre licence ONLYOFFICE Docs

Depuis la version v5.1.1, vous pouvez mettre à jour la licence en recréant le secret sans redémarrer les pods. Pour mettre à jour la licence :

• Placez le nouveau fichier license.lic dans un répertoire.
• Exécutez les commandees suivantes :

  $ kubectl delete secret [SECRET_LICENSE_NAME] -n <NAMESPACE>
  $ kubectl create secret generic [SECRET_LICENSE_NAME] --from-file=path/to/license.lic -n <NAMESPACE>

  Wici SECRET_LICENSE_NAME est le nom du secret existant contenant une licence.

Le serveur de documents relira automatiquement la nouvelle licence.

$ kubectl delete pod converter-*** docservice-*** -n <NAMESPACE>

10. Test de fonctionnement ONLYOFFICE Docs

Tester la disponibilité d'ONLYOFFICE Docs et l'accès aux dépendances connectées :

$ helm test documentserver -n <NAMESPACE>

La sortie doit contenir :

Phase: Succeeded

Pour afficher le journal de test :

$ kubectl logs -f test-ds -n <NAMESPACE>

Après les tests, supprimez le pod test-ds :

$ kubectl delete pod test-ds -n <NAMESPACE>

11. Exécuter des Jobs dans le cluster privé k8s

Lors de l'exécution d'un job pour l'installation, la mise à jour, le rollback ou la suppression, le conteneur a besoin d'un accès Internet pour télécharger les derniers scripts SQL. Si l'accès au réseau externe est restreint dans votre cluster, définissez privateCluster=true and manually create a ConfigMap avec les scripts SQL nécessaires.

Si votre cluster dispose déjà de remove-db-scripts and init-db-scripts configmaps, supprimez-les d'abord :

$ kubectl delete cm remove-db-scripts init-db-scripts

Téléchargez les scripts de base de données. Pour PostgreSQL :

$ wget -O removetbl.sql https://raw.githubusercontent.com/ONLYOFFICE/server/master/schema/postgresql/removetbl.sql
$ wget -O createdb.sql https://raw.githubusercontent.com/ONLYOFFICE/server/master/schema/postgresql/createdb.sql

Pour MySQL :

$ wget -O removetbl.sql https://raw.githubusercontent.com/ONLYOFFICE/server/master/schema/mysql/removetbl.sql
$ wget -O createdb.sql https://raw.githubusercontent.com/ONLYOFFICE/server/master/schema/mysql/createdb.sql

Créez des configmaps à partir d'eux :

$ kubectl create configmap remove-db-scripts --from-file=./removetbl.sql
$ kubectl create configmap init-db-scripts --from-file=./createdb.sql

Si vous avez utilisé des noms différents pour ConfigMap ou les fichiers, définissez les paramètres appropriés pour les jobs correspondants : existingConfigmap.tblRemove.name / existingConfigmap.tblRemove.cléName pour les scripts de nettoyage, et existingConfigmap.tblCreate.name / existingConfigmap.tblCreate.cléName pour les scripts de création.

Ensuite, lors de l'exécution de helm install|upgrade|rollback|delete, définissez le paramètre privateCluster=true.

12. Accéder à la page d'informations

L'accès à la page /info est limité par défaut. Pour autoriser l'accès, spécifiez les adresses IP ou les sous-réseaux à l'aide du paramètre proxy.infoAllowedIP Notez qu'en raison des spécificités du réseau Kubernetes, les clients réels sont généralement des adresses de Pod, de nœud ou d'équilibreur de charge plutôt que l'IP utilisateur d'origine.

Vous pouvez restreindre davantage l'accès à l'aide de l'authentification HTTP de base Nginx en définissant le paramètre proxy.infoAllowedUser et un mot de passe via proxy.infoAllowedPassword. Vous pouvez également utiliser un secret existant en définissant proxy.infoAllowedExistingSecret.

1. Deployer Grafana

1. Déployer Grafana sans tableaux de bord prêts à l'emploi
   Ignorez cette étape si vous souhaitez déployer Grafana avec des tableaux de bord prêts à l'emploi.

   $ helm install grafana --version 12.1.8 bitnami/grafana \
     --set service.ports.grafana=80 \
     --set config.useGrafanaIniFile=true \
     --set config.grafanaIniConfigMap=grafana-ini \
     --set datasources.secretName=grafana-datasource \
     --set resourcesPreset=none \
     --set image.repository=bitnamilegacy/grafana \
     --set image.tag=12.1.1-debian-12-r1 \
     --set global.security.allowInsecureImages=true

2. Déployer Grafana avec des tableaux de bord prêts à l'emploi
   1. Installer des tableaux de bord Grafana prêts à l'emploi

      Définissez les paramètres grafana.enabled et grafana.dashboard.enabled à true. Si ONLYOFFICE Docs est déjà installé, exécutez :

      helm upgrade documentserver onlyoffice/docs --set grafana.enabled=true --set grafana.dashboard.enabled=true

      Cela télécharge des tableaux de bord prêts à l'emploi au format JSON depuis le site web de Grafana, applique les modifications nécessaires et crée un configmap à partir d'eux. Un tableau de bord pour les métriques ONLYOFFICE Docs est également ajouté (il est supposé que step 6 (Deploy StatsD exporter) a déjà été complétée).

   2. Installer Grafana

      $ helm install grafana --version 12.1.8 bitnami/grafana \
        --set service.ports.grafana=80 \
        --set config.useGrafanaIniFile=true \
        --set config.grafanaIniConfigMap=grafana-ini \
        --set datasources.secretName=grafana-datasource \
        --set resourcesPreset=none \
        --set image.repository=bitnamilegacy/grafana \
        --set image.tag=12.1.1-debian-12-r1 \
        --set global.security.allowInsecureImages=true \
        --set dashboardsProvider.enabled=true \
        --set dashboardsConfigMaps[0].configMapName=dashboard-node-exporter \
        --set dashboardsConfigMaps[0].fileName=dashboard-node-exporter.json \
        --set dashboardsConfigMaps[1].configMapName=dashboard-deployment \
        --set dashboardsConfigMaps[1].fileName=dashboard-deployment.json \
        --set dashboardsConfigMaps[2].configMapName=dashboard-redis \
        --set dashboardsConfigMaps[2].fileName=dashboard-redis.json \
        --set dashboardsConfigMaps[3].configMapName=dashboard-rabbitmq \
        --set dashboardsConfigMaps[3].fileName=dashboard-rabbitmq.json \
        --set dashboardsConfigMaps[4].configMapName=dashboard-postgresql \
        --set dashboardsConfigMaps[4].fileName=dashboard-postgresql.json \
        --set dashboardsConfigMaps[5].configMapName=dashboard-nginx-ingress \
        --set dashboardsConfigMaps[5].fileName=dashboard-nginx-ingress.json \
        --set dashboardsConfigMaps[6].configMapName=dashboard-documentserver \
        --set dashboardsConfigMaps[6].fileName=dashboard-documentserver.json \
        --set dashboardsConfigMaps[7].configMapName=dashboard-cluster-resourses \
        --set dashboardsConfigMaps[7].fileName=dashboard-cluster-resourses.json

      Les tableaux de bord suivants seront importés dans Grafana : Node Exporter, Deployment Statefulset Daemonset, Redis Dashboard for Prometheus Redis Exporter, RabbitMQ-Overview, PostgreSQL Database, contrôleur NGINX Ingress, ONLYOFFICE Docs et utilisation des ressources par les pods et conteneurs.

      Vous pouvez consulter la description des métriques ONLYOFFICE Docs visualisées dans Grafana ici.

      Consultez plus de détails sur l'installation de Grafana via Helm ici.

2. Accéder à Grafana via Ingress

Si ONLYOFFICE Docs a été installé avec le paramètre grafana.ingress.enabled (Metrics deployment), Grafana sera disponible à : http://INGRESS-ADDRESS/grafana/

Si l'Ingress a été installé avec une connexion sécurisée (Expose ONLYOFFICE Docs via HTTPS), Grafana sera disponible à : https://your-domain-name/grafana/

3. Afficher les métriques de Gaticid dans Grafana

Accédez à http(s)://your-domain-name/grafana/ et connectez-vous avec :

Login - admin

Pour obtenir le mot de passe, exécutez :

$ kubectl get secret grafana-admin --namespace default -o jsonpath="{.data.GF_SECURITY_ADMIN_PASSWORD}" | base64 --decode

Dans la section des tableaux de bord, vous verrez les tableaux de bord ajoutés affichant les métriques reçues de Prometheus.