ONLYOFFICE Docs per Kubernetes

1. Aggiungi repository 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. Installa Storage Persistente

Installa 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 è una Persistent Storage Class disponibile nel tuo cluster Kubernetes.

  Persistent Storage Classes per diversi provider:

  • Amazon EKS: gp2
  • Digital Ocean: do-block-storage
  • IBM Cloud: Default ibmc-file-bronze. Altre classi di storage
  • Yandex Cloud: yc-network-hdd o yc-network-ssd. Maggiori dettagli
  • minikube: standard
• PERSISTENT_SIZE è la dimensione totale di tutti i Persistent Storages per la classe di storage persistente nfs. Puoi esprimere la dimensione come un numero intero semplice con uno di questi suffissi: T, G, M, Ti, Gi, Mi. Ad esempio: 9Gi.

Vedi maggiori dettagli sull'installazione di NFS Server Provisioner tramite Helm qui.

Configura un Persistent Volume Claim

Il default nfs Persistent Volume Claim è 8Gi. Puoi cambiarlo nel file values.yaml nella sezione persistence.storageClass e persistence.size. Dovrebbe essere inferiore a PERSISTENT_SIZE almeno di circa il 5%. È consigliato utilizzare 8Gi o più per lo storage persistente per ogni 100 utenti attivi di ONLYOFFICE Docs.

Se desideri abilitare WOPI, imposta il parametro wopi.enabled=true. In questo caso, lo Storage Persistente deve essere collegato ai nodi del cluster con gli attributi di caching disabilitati per la directory montata per i client. Per NFS Server Provisioner, può essere ottenuto aggiungendo l'opzione noac al parametro storageClass.mountOptions. Trova maggiori informazioni qui.

3. Deploy RabbitMQ

Per installare RabbitMQ nel tuo cluster, esegui il seguente comando:

$ 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

Vedi maggiori dettagli sull'installazione di RabbitMQ tramite Helm qui.

4. Deploy Redis

Per installare Redis nel tuo cluster, esegui il seguente comando:

$ 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

Vedi maggiori dettagli sull'installazione di Redis tramite Helm qui.

5. Deploy Database

Come server di database, puoi utilizzare PostgreSQL, MySQL o 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. Distribuire StatsD exporter

1. Aggiungi repository 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. Installazione di Prometheus

   Per installare Prometheus nel tuo cluster, esegui il seguente comando:

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

   Per modificare l'intervallo di scraping, specifica il parametro server.global.scrape_interval.

   Vedi ulteriori dettagli sull'installazione di Prometheus tramite Helm qui.

3. Installazione di StatsD exporter

   Per installare StatsD exporter nel tuo cluster, esegui il seguente comando:

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

   Vedi ulteriori dettagli sull'installazione di Prometheus StatsD exporter tramite Helm qui.

   Per consentire le metriche StatsD in ONLYOFFICE Docs, segui questo passaggio.

7. Apportare modifiche ai file di configurazione Node-config

1. Crea un ConfigMap contenente un file json

   Per creare un ConfigMap da un file che contiene la struttura local.json, devi eseguire il seguente comando:

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

   Può essere utilizzato qualsiasi nome al posto di local-config.
2. Specifica i parametri durante l'installazione di ONLYOFFICE Docs

   Durante l'installazione di ONLYOFFICE Docs, specifica i parametri extraConf.configMap=local-config e extraConf.filename=local.json.

   Se hai bisogno di aggiungere un file di configurazione dopo che ONLYOFFICE Docs è già installato, devi eseguire il passaggio 7.1 e poi eseguire il comando

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

   oppure

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

   se i parametri sono specificati nel file values.yaml.

8. Aggiungi Font personalizzati

Per aggiungere font alle immagini, è necessario ricostruire le immagini. Consulta i passaggi pertinenti in questo manuale. Quindi specifica le tue immagini durante l'installazione di ONLYOFFICE Docs.

9. Aggiungi Plugin

Per aggiungere plugin alle immagini, è necessario ricostruire le immagini. Consulta i passaggi pertinenti in questo manuale. Quindi specifica le tue immagini durante l'installazione di ONLYOFFICE Docs.

10. Aggiungi dizionari personalizzati

Per aggiungere i tuoi dizionari personalizzati alle immagini, è necessario ricostruire le immagini. Consulta i passaggi pertinenti in questo manuale. Quindi specifica le tue immagini durante l'installazione di ONLYOFFICE Docs.

11. Cambia temi dell'interfaccia

1. Crea un ConfigMap contenente un file json

   Per creare un ConfigMap con un file json che contiene i temi dell'interfaccia, devi eseguire il seguente comando:

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

   Invece di custom-themes e custom-themes.json puoi usare qualsiasi altro nome.
2. Specifica i parametri durante l'installazione di ONLYOFFICE Docs

   Durante l'installazione di ONLYOFFICE Docs, specifica i parametri extraThemes.configMap=custom-themes e extraThemes.filename=custom-themes.json.

   Se hai bisogno di aggiungere temi dell'interfaccia dopo che ONLYOFFICE Docs è già installato, devi eseguire il passaggio 11.1 e poi eseguire il comando helm upgrade documentserver onlyoffice/docs --set extraThemes.configMap=custom-themes --set extraThemes.filename=custom-themes.json --no-hooks oppure helm upgrade documentserver -f ./values.yaml onlyoffice/docs --no-hooks se i parametri sono specificati nel file values.yaml.

12. Collegare il bucket Amazon S3 come cache a ONLYOFFICE Helm Docs

Per collegare il bucket Amazon S3 come cache, devi creare un file di configurazione o modificare quello esistente in conformità con questa guida e cambiare il valore del parametro persistence.storageS3 a true.

1. Distribuire la licenza di ONLYOFFICE Docs

1. Crea segreto

   Se hai una licenza valida di ONLYOFFICE Docs, crea un segreto license dal file:

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

   Dove SECRET_LICENSE_NAME è il nome di un futuro segreto con una licenza.

   Il nome del file di licenza sorgente dovrebbe essere 'license.lic' poiché questo nome verrà utilizzato come campo nel segreto creato.

   Se l'installazione viene eseguita senza creare un secret con il file di licenza esistente, verrà automaticamente creato un secret vuoto license. Per informazioni su come aggiornare un secret esistente con una licenza, vedere qui.
2. Specificare i parametri durante l'installazione di ONLYOFFICE Docs

   Quando si installa ONLYOFFICE Docs, specificare il parametro license.existingSecret=[SECRET_LICENSE_NAME].

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

   Se è necessario aggiungere la licenza dopo che ONLYOFFICE Docs è già stato installato, è necessario eseguire il passo 1.1 e quindi eseguire il comando helm upgrade documentserver onlyoffice/docs --set license.existingSecret=[SECRET_LICENSE_NAME] --no-hooks oppure helm upgrade documentserver -f ./values.yaml onlyoffice/docs --no-hooks se i parametri sono specificati nel file values.yaml.

2. Distribuire ONLYOFFICE Docs

Per distribuire ONLYOFFICE Docs con il nome di rilascio documentserver:

$ helm install documentserver onlyoffice/docs

Il comando distribuisce ONLYOFFICE Docs sul cluster Kubernetes nella configurazione predefinita. La sezione Parametri elenca i parametri che possono essere configurati durante l'installazione.

3. Disinstallare ONLYOFFICE Docs

Per disinstallare/eliminare il deployment documentserver:

$ helm delete documentserver

L'esecuzione del comando helm delete avvia hook, che eseguono alcune azioni preparatorie prima di eliminare completamente ONLYOFFICE Docs, che includono l'arresto del server, la pulizia dei PVC utilizzati e delle tabelle del database. Il tempo di esecuzione predefinito degli hook è di 300s. Il tempo di esecuzione può essere modificato utilizzando --timeout [time], ad esempio:

$ helm delete documentserver --timeout 25m

Se si desidera eliminare ONLYOFFICE Docs senza alcuna azione preparatoria, eseguire il seguente comando:

$ helm delete documentserver --no-hooks

Il comando helm delete rimuove tutti i componenti Kubernetes associati al chart e elimina il rilascio.

4. Parametri

Specificare ogni parametro utilizzando l'argomento --set key=value[,key=value] per helm install. Ad esempio:

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

Questo comando espone ONLYOFFICE Docs tramite HTTPS.

In alternativa, può essere fornito un file YAML che specifica i valori per i parametri durante l'installazione del chart:

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

5. Dettagli di configurazione e installazione

1. Esempio di deployment (opzionale)
   Importante Questo passaggio è opzionale. Puoi saltarlo completamente se non hai bisogno di distribuire l'esempio.

   Per distribuire l'esempio, imposta il parametro example.enabled su true:

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

2. Distribuzione delle metriche (opzionale)

   Importante Questo passaggio è opzionale. Puoi saltarlo completamente se non hai bisogno di distribuire le metriche.

   Per distribuire le metriche, imposta metrics.enabled su true:

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

   Se desideri utilizzare Grafana per visualizzare le metriche, imposta grafana.enabled su true. Se desideri utilizzare Nginx Ingress per accedere a Grafana, imposta grafana.ingress.enabled su true:

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

3. Esporre ONLYOFFICE Docs
   1. Esporre ONLYOFFICE Docs tramite Servizio (solo HTTP)
      Dovresti saltare questo passaggio se intendi esporre ONLYOFFICE Docs tramite HTTPS.

      Questo tipo di esposizione crea un loadbalancer per accedere a ONLYOFFICE Docs. Usa questo tipo se utilizzi la terminazione TLS esterna e non hai un'altra applicazione web nel cluster k8s.

      Per esporre ONLYOFFICE Docs tramite servizio, imposta il parametro service.type su LoadBalancer:

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

      Esegui il seguente comando per ottenere l'IP del servizio documentserver:

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

      Dopo di ciò, ONLYOFFICE Docs sarà disponibile su http://DOCUMENTSERVER-SERVICE-IP/.

      Se l'IP del servizio è vuoto, prova a ottenere il nome host del servizio documentserver:

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

      In questo caso, ONLYOFFICE Docs sarà disponibile su http://DOCUMENTSERVER-SERVICE-HOSTNAME/.

   2. Esporre ONLYOFFICE Docs tramite Ingress

      Prima, installa il Kubernetes Nginx Ingress Controller:

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

      Per abilitare l'esposizione delle metriche di ingress-nginx a Prometheus, esegui:

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

      Vedi maggiori dettagli sull'installazione di Nginx Ingress tramite Helm qui.

      Quindi scegli il tuo metodo di esposizione:

      • Via HTTP

        Dovresti saltare questo se intendi esporre ONLYOFFICE Docs tramite HTTPS.

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

        Ottieni l'IP dell'ingress:

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

        ONLYOFFICE Docs sarà disponibile su http://DOCUMENTSERVER-INGRESS-IP/ (o usa il nome host se l'IP è vuoto).

      • Via HTTPS (terminazione TLS)

        Crea il segreto tls con il tuo certificato SSL:

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

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

        Associa l'IP o il nome host dell'ingress con il tuo nome di dominio tramite il tuo provider DNS. Dopo di ciò, ONLYOFFICE Docs sarà disponibile su https://your-domain-name/.

      • Via HTTPS usando 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

        Quindi installa o aggiorna ONLYOFFICE Docs impostando ingress.enabled, ingress.ssl.enabled, ingress.letsencrypt.enabled su true, e specificando i tuoi valori per ingress.letsencrypt.email e ingress.host (o ingress.tenants per domini multipli).

      • Via un percorso virtuale

        Imposta i parametri ingress.enabled, ingress.host e ingress.path:

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

        Controller di ingress supportati: Ingress NGINX di Kubernetes, NGINX Ingress di NGINX, HAProxy Ingress di HAProxy.

        Per Ingress NGINX di Kubernetes, aggiungi il pattern (/|$)(.*) a ingress.path, ad esempio /docs(/|$)(.*).

   3. Esporre ONLYOFFICE Docs tramite route in OpenShift

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

      Per la terminazione TLS, aggiungi manualmente i certificati alla route tramite la console web di OpenShift.

6. Scalare ONLYOFFICE Docs

1. Autoscaling orizzontale dei Pod

   Puoi abilitare l'Autoscaling in modo che il numero di repliche delle distribuzioni docservice e converter venga calcolato automaticamente in base ai valori e al tipo di metriche.

   Per le metriche delle risorse, l'API metrics.k8s.io deve essere registrata, generalmente fornita da metrics-server. Può essere avviata come add-on del cluster.

   Per abilitare HPA per il deployment di docservice, specificare il parametro docservice.autoscaling.enabled=true. Allo stesso modo, per abilitare HPA per il deployment di converter, specificare converter.autoscaling.enabled=true. In entrambi i casi, il parametro replicas corrispondente viene ignorato e il numero di repliche è controllato da HPA.

   Per ulteriori informazioni sull'Autoscaling Orizzontale dei Pod, vedere qui. Per altri parametri di Autoscaling configurabili, vedere la tabella dei Parametri.

2. Scalabilità manuale

   I deployment di docservice e converter consistono ciascuno di 2 pod per impostazione predefinita.

   Per scalare il deployment di docservice:

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

   Per scalare il deployment di converter:

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

7. Aggiornare ONLYOFFICE Docs

Per aggiornare, impostare i parametri per l'aggiornamento. Ad esempio:

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

Oppure modificare il file values.yaml ed eseguire:

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

Il comando helm upgrade esegue un hook che spegne ONLYOFFICE Docs e pulisce il database. Il tempo di esecuzione predefinito dell'hook è 300s. Per modificarlo:

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

Per aggiornare qualsiasi parametro diverso dalla versione di ONLYOFFICE Docs, eseguire helm upgrade senza hook:

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

Per annullare gli aggiornamenti:

$ helm rollback documentserver

8. Spegnere ONLYOFFICE Docs

Per eseguire lo spegnimento, eseguire il seguente comando:

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

Dove <NAMESPACE> è il namespace in cui ONLYOFFICE Docs è installato. Predefinito a default se non specificato. Ad esempio:

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

Dopo che il Pod shutdown-ds è stato eseguito con successo, eliminare il Job:

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

Per riavviare ONLYOFFICE Docs dopo lo spegnimento, riavviare i pod docservice e converter:

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

9. Aggiornare la licenza di ONLYOFFICE Docs

Dalla versione v5.1.1, è possibile aggiornare la licenza ricreando il segreto senza riavviare i pod. Per aggiornare la licenza:

• Posizionare il nuovo file license.lic in una directory.
• Eseguire i seguenti comandi:

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

  Dove SECRET_LICENSE_NAME è il nome del segreto esistente con una licenza.

Il documentserver rileggerà automaticamente la nuova licenza.

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

10. Test di installazione di ONLYOFFICE Docs

Testare la disponibilità di ONLYOFFICE Docs e l'accesso alle dipendenze connesse:

$ helm test documentserver -n <NAMESPACE>

L'output dovrebbe contenere:

Phase: Succeeded

Per visualizzare il log del test:

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

Dopo il test, eliminare il Pod test-ds:

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

11. Eseguire i Job in un cluster k8s privato

Quando si esegue un Job per l'installazione, l'aggiornamento, il rollback o l'eliminazione, il container necessita di accesso a Internet per scaricare gli ultimi script SQL. Se l'accesso alla rete esterna è limitato nel tuo cluster, imposta privateCluster=true e crea manualmente un ConfigMap con gli script SQL necessari.

Se il tuo cluster ha già i configmap remove-db-scripts e init-db-scripts, eliminali prima:

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

Scarica gli script del database. Per 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

Per 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

Crea configmap da essi:

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

Se hai usato nomi diversi per ConfigMap o i file, imposta i parametri appropriati per i job corrispondenti: existingConfigmap.tblRemove.name / existingConfigmap.tblRemove.keyName per gli script di pulizia, e existingConfigmap.tblCreate.name / existingConfigmap.tblCreate.keyName per gli script di creazione.

Quindi, quando esegui helm install|upgrade|rollback|delete, imposta il parametro privateCluster=true.

12. Accesso alla pagina delle informazioni

L'accesso alla pagina /info è limitato per impostazione predefinita. Per consentire l'accesso, specificare gli indirizzi IP o le subnet utilizzando il parametro proxy.infoAllowedIP. Si noti che a causa delle specifiche della rete Kubernetes, i client effettivi sono tipicamente indirizzi di Pod, Nodo o Load Balancer piuttosto che l'IP originale dell'utente.

Puoi ulteriormente limitare l'accesso utilizzando l'Autenticazione di Base di Nginx impostando il parametro proxy.infoAllowedUser e una password tramite proxy.infoAllowedPassword. In alternativa, usa un segreto esistente impostando proxy.infoAllowedExistingSecret.

1. Distribuire Grafana

1. Distribuire Grafana senza dashboard predefiniti
   Salta questo passaggio se vuoi distribuire Grafana con dashboard predefiniti.

   $ 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. Distribuire Grafana con dashboard preconfigurati
   1. Installare dashboard Grafana preconfigurati

      Impostare i parametri grafana.enabled e grafana.dashboard.enabled su true. Se ONLYOFFICE Docs è già installato, eseguire:

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

      Questo scarica i dashboard preconfigurati in formato JSON dal sito web di Grafana, applica le modifiche necessarie e crea un configmap da essi. Viene anche aggiunto un dashboard per le metriche di ONLYOFFICE Docs (si presume che il passaggio 6 (Distribuire StatsD exporter) sia già stato completato).

   2. Installare 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

      I seguenti dashboard saranno importati in Grafana: Node Exporter, Deployment Statefulset Daemonset, Redis Dashboard per Prometheus Redis Exporter, RabbitMQ-Overview, Database PostgreSQL, controller NGINX Ingress, ONLYOFFICE Docs e Utilizzo delle risorse da parte di Pod e Container.

      Puoi vedere la descrizione delle metriche di ONLYOFFICE Docs visualizzate in Grafana qui.

      Vedi maggiori dettagli sull'installazione di Grafana tramite Helm qui.

2. Accesso a Grafana tramite Ingress

Se ONLYOFFICE Docs è stato installato con il parametro grafana.ingress.enabled (Distribuzione delle metriche), Grafana sarà disponibile a: http://INGRESS-ADDRESS/grafana/

Se Ingress è stato installato con una connessione sicura (Esporre ONLYOFFICE Docs tramite HTTPS), Grafana sarà disponibile a: https://your-domain-name/grafana/

3. Visualizzare le metriche raccolte in Grafana

Vai a http(s)://your-domain-name/grafana/ e accedi con:

Login - admin

Per ottenere la password, esegui:

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

Nella sezione dashboard, vedrai i dashboard aggiunti che mostrano le metriche ricevute da Prometheus.