ONLYOFFICE Docs para Kubernetes

1. Añadir repositorios de 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. Instalar Almacenamiento Persistente

Instalar 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 es una Clase de Almacenamiento Persistente disponible en su cluster de Kubernetes.

  Clases de Almacenamiento Persistente para diferentes proveedores:

  • Amazon EKS: gp2
  • Digital Ocean: do-block-storage
  • IBM Cloud: Predeterminado ibmc-file-bronze. Más clases de almacenamiento
  • Yandex Cloud: yc-network-hdd o yc-network-ssd. Más detalles
  • minikube: standard
• PERSISTENT_SIZE es el tamaño total de todos los Almacenamientos Persistentes para la clase de almacenamiento persistente nfs. Puede expresar el tamaño como un número entero simple con uno de estos sufijos: T, G, M, Ti, Gi, Mi. Por ejemplo: 9Gi.

Vea más detalles sobre la instalación de NFS Server Provisioner a través de Helm aquí.

Configurar una Solicitud de Volumen Persistente

La Solicitud de Volumen Persistente nfs predeterminada es de 8Gi. Puede cambiarla en el archivo values.yaml en la sección persistence.storageClass y persistence.size. Debe ser al menos un 5% menor que PERSISTENT_SIZE. Se recomienda usar 8Gi o más para el almacenamiento persistente por cada 100 usuarios activos de ONLYOFFICE Docs.

Si desea habilitar WOPI, por favor configure el parámetro wopi.enabled=true. En este caso, el Almacenamiento Persistente debe estar conectado a los nodos del cluster con los atributos de caché deshabilitados para el directorio montado para los clientes. Para NFS Server Provisioner, esto se puede lograr añadiendo la opción noac al parámetro storageClass.mountOptions. Encuentre más información aquí.

3. Desplegar RabbitMQ

Para instalar RabbitMQ en su cluster, ejecute el siguiente 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

Vea más detalles sobre la instalación de RabbitMQ a través de Helm aquí.

4. Desplegar Redis

Para instalar Redis en su cluster, ejecute el siguiente 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

Vea más detalles sobre la instalación de Redis a través de Helm aquí.

5. Desplegar Base de Datos

Como servidor de base de datos, puede usar 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. Implementar StatsD exporter

1. Agregar repositorios 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. Instalación de Prometheus

   Para instalar Prometheus en su clúster, ejecute el siguiente 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

   Para cambiar el intervalo de sondeo, especifique el parámetro server.global.scrape_interval.

   Vea más detalles sobre la instalación de Prometheus a través de Helm aquí.

3. Instalación de StatsD exporter

   Para instalar StatsD exporter en su clúster, ejecute el siguiente comando:

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

   Vea más detalles sobre la instalación de Prometheus StatsD exporter a través de Helm aquí.

   Para permitir las métricas de StatsD en ONLYOFFICE Docs, siga este paso.

7. Realizar cambios en los archivos de configuración de Node-config

1. Crear un ConfigMap que contenga un archivo json

   Para crear un ConfigMap a partir de un archivo que contiene la estructura local.json, debe ejecutar el siguiente comando:

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

   Se puede usar cualquier nombre en lugar de local-config.
2. Especificar parámetros al instalar ONLYOFFICE Docs

   Al instalar ONLYOFFICE Docs, especifique los parámetros extraConf.configMap=local-config y extraConf.filename=local.json.

   Si necesita agregar un archivo de configuración después de que ONLYOFFICE Docs ya esté instalado, debe ejecutar el paso 7.1 y luego ejecutar el

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

   comando o

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

   si los parámetros están especificados en el archivo values.yaml.

8. Agregar fuentes personalizadas

Para agregar fuentes a las imágenes, necesita reconstruir las imágenes. Consulte los pasos relevantes en este manual. Luego especifique sus imágenes al instalar ONLYOFFICE Docs.

9. Agregar Plugins

Para agregar plugins a las imágenes, necesita reconstruir las imágenes. Consulte los pasos relevantes en este manual. Luego especifique sus imágenes al instalar ONLYOFFICE Docs.

10. Agregar diccionarios personalizados

Para agregar sus diccionarios personalizados a las imágenes, necesita reconstruir las imágenes. Consulte los pasos relevantes en este manual. Luego especifique sus imágenes al instalar ONLYOFFICE Docs.

11. Cambiar temas de la interfaz

1. Crear un ConfigMap que contenga un archivo json

   Para crear un ConfigMap con un archivo json que contiene los temas de la interfaz, debe ejecutar el siguiente comando:

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

   En lugar de custom-themes y custom-themes.json puede usar cualquier otro nombre.
2. Especificar parámetros al instalar ONLYOFFICE Docs

   Al instalar ONLYOFFICE Docs, especifique los parámetros extraThemes.configMap=custom-themes y extraThemes.filename=custom-themes.json.

   Si necesita agregar temas de interfaz después de que ONLYOFFICE Docs ya esté instalado, debe ejecutar el paso 11.1 y luego ejecutar el comando helm upgrade documentserver onlyoffice/docs --set extraThemes.configMap=custom-themes --set extraThemes.filename=custom-themes.json --no-hooks o helm upgrade documentserver -f ./values.yaml onlyoffice/docs --no-hooks si los parámetros están especificados en el archivo values.yaml.

12. Conectar un bucket de Amazon S3 como caché a ONLYOFFICE Helm Docs

Para conectar un bucket de Amazon S3 como caché, necesita crear un archivo de configuración o editar el existente de acuerdo con esta guía y cambiar el valor del parámetro persistence.storageS3 a true.

1. Implementar la licencia de ONLYOFFICE Docs

1. Crear secreto

   Si tiene una licencia válida de ONLYOFFICE Docs, cree un secreto license a partir del archivo:

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

   Dónde SECRET_LICENSE_NAME es el nombre de un futuro secreto con una licencia.

   El nombre del archivo de licencia de origen debe ser 'license.lic' porque este nombre se usará como un campo en el secreto creado.

   Si la instalación se realiza sin crear un secreto con el archivo de licencia existente, se creará automáticamente un secreto vacío license. Para obtener información sobre cómo actualizar un secreto existente con una licencia, consulte aquí.
2. Especificar parámetros al instalar ONLYOFFICE Docs

   Al instalar ONLYOFFICE Docs, especifique el parámetro license.existingSecret=[SECRET_LICENSE_NAME].

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

   Si necesita agregar una licencia después de que ONLYOFFICE Docs ya esté instalado, debe ejecutar el paso 1.1 y luego ejecutar el comando helm upgrade documentserver onlyoffice/docs --set license.existingSecret=[SECRET_LICENSE_NAME] --no-hooks o helm upgrade documentserver -f ./values.yaml onlyoffice/docs --no-hooks si los parámetros están especificados en el archivo values.yaml.

2. Desplegar ONLYOFFICE Docs

Para desplegar ONLYOFFICE Docs con el nombre de lanzamiento documentserver:

$ helm install documentserver onlyoffice/docs

El comando despliega ONLYOFFICE Docs en el clúster de Kubernetes con la configuración predeterminada. La sección de Parámetros enumera los parámetros que se pueden configurar durante la instalación.

3. Desinstalar ONLYOFFICE Docs

Para desinstalar/eliminar el despliegue documentserver:

$ helm delete documentserver

Ejecutar el comando helm delete lanza hooks, que realizan algunas acciones preparatorias antes de eliminar completamente ONLYOFFICE Docs, lo que incluye detener el servidor, limpiar el PVC utilizado y las tablas de la base de datos. El tiempo de ejecución predeterminado de los hooks es de 300s. El tiempo de ejecución se puede cambiar utilizando --timeout [time], por ejemplo:

$ helm delete documentserver --timeout 25m

Si desea eliminar ONLYOFFICE Docs sin ninguna acción preparatoria, ejecute el siguiente comando:

$ helm delete documentserver --no-hooks

El comando helm delete elimina todos los componentes de Kubernetes asociados con el chart y elimina el lanzamiento.

4. Parámetros

Especifique cada parámetro utilizando el argumento --set key=value[,key=value] para helm install. Por ejemplo:

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

Este comando expone ONLYOFFICE Docs a través de HTTPS.

Alternativamente, se puede proporcionar un archivo YAML que especifique los valores para los parámetros durante la instalación del chart:

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

5. Detalles de configuración e instalación

1. Despliegue de ejemplo (opcional)
   Importante Este paso es opcional. Puede omitirlo por completo si no necesita desplegar el ejemplo.

   Para desplegar el ejemplo, establezca el parámetro example.enabled en true:

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

2. Despliegue de métricas (opcional)

   Importante Este paso es opcional. Puede omitirlo por completo si no necesita desplegar métricas.

   Para desplegar métricas, establezca metrics.enabled en true:

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

   Si desea usar Grafana para visualizar métricas, establezca grafana.enabled en true. Si desea usar Nginx Ingress para acceder a Grafana, establezca grafana.ingress.enabled en true:

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

3. Exponer ONLYOFFICE Docs
   1. Exponer ONLYOFFICE Docs a través de Servicio (solo HTTP)
      Debe omitir este paso si va a exponer ONLYOFFICE Docs a través de HTTPS.

      Este tipo de exposición crea un balanceador de carga para acceder a ONLYOFFICE Docs. Use este tipo si utiliza terminación TLS externa y no tiene otra aplicación web en el clúster k8s.

      Para exponer ONLYOFFICE Docs a través de servicio, establezca el parámetro service.type en LoadBalancer:

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

      Ejecute el siguiente comando para obtener la IP del servicio documentserver:

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

      Después de eso, ONLYOFFICE Docs estará disponible en http://DOCUMENTSERVER-SERVICE-IP/.

      Si la IP del servicio está vacía, intente obtener el nombre de host del servicio documentserver:

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

      En este caso, ONLYOFFICE Docs estará disponible en http://DOCUMENTSERVER-SERVICE-HOSTNAME/.

   2. Exponer ONLYOFFICE Docs a través de Ingress

      Primero, instale el Controlador de Ingress Nginx de Kubernetes:

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

      Para habilitar la exposición de métricas de ingress-nginx a Prometheus, ejecute:

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

      Vea más detalles sobre la instalación de Nginx Ingress a través de Helm aquí.

      Luego elija su método de exposición:

      • A través de HTTP

        Debe omitir esto si va a exponer ONLYOFFICE Docs a través de HTTPS.

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

        Obtenga la IP de ingress:

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

        ONLYOFFICE Docs estará disponible en http://DOCUMENTSERVER-INGRESS-IP/ (o use el nombre de host si la IP está vacía).

      • A través de HTTPS (terminación TLS)

        Cree el secreto tls con su certificado 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

        Asocie la IP o el nombre de host de ingress con su nombre de dominio a través de su proveedor de DNS. Después de eso, ONLYOFFICE Docs estará disponible en https://your-domain-name/.

      • A través de 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

        Luego instale o actualice ONLYOFFICE Docs estableciendo ingress.enabled, ingress.ssl.enabled, ingress.letsencrypt.enabled en true, y especificando sus valores para ingress.letsencrypt.email e ingress.host (o ingress.tenants para múltiples dominios).

      • A través de una ruta virtual

        Establezca los parámetros ingress.enabled, ingress.host y ingress.path:

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

        Controladores de ingress compatibles: Ingress NGINX por Kubernetes, NGINX Ingress por NGINX, HAProxy Ingress por HAProxy.

        Para Ingress NGINX por Kubernetes, agregue el patrón (/|$)(.*) a ingress.path, por ejemplo, /docs(/|$)(.*).

   3. Exponer ONLYOFFICE Docs a través de ruta en OpenShift

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

      Para la terminación TLS, agregue manualmente los certificados a la ruta a través de la consola web de OpenShift.

6. Escalar ONLYOFFICE Docs

1. Autoscaling Horizontal de Pods

   Puede habilitar el Autoscaling para que el número de réplicas de los despliegues docservice y converter se calcule automáticamente en función de los valores y el tipo de métricas.

   Para las métricas de recursos, la API metrics.k8s.io debe estar registrada, lo cual generalmente es proporcionado por el metrics-server. Puede lanzarse como un complemento del clúster.

   Para habilitar HPA para el despliegue de docservice, especifique el parámetro docservice.autoscaling.enabled=true. De manera similar, para habilitar HPA para el despliegue de converter, especifique converter.autoscaling.enabled=true. En ambos casos, el parámetro correspondiente replicas se ignora y el número de réplicas es controlado por HPA.

   Para más información sobre el Escalado Horizontal de Pods, consulte aquí. Para otros parámetros configurables de Autoscaling, consulte la tabla de Parámetros.

2. Escalado manual

   Los despliegues de docservice y converter constan de 2 pods cada uno por defecto.

   Para escalar el despliegue de docservice:

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

   Para escalar el despliegue de converter:

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

7. Actualizar ONLYOFFICE Docs

Para actualizar, configure los parámetros para la actualización. Por ejemplo:

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

O modifique el archivo values.yaml y ejecute:

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

El comando helm upgrade ejecuta un hook que apaga ONLYOFFICE Docs y limpia la base de datos. El tiempo de ejecución del hook por defecto es de 300s. Para cambiarlo:

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

Para actualizar cualquier parámetro que no sea la versión de ONLYOFFICE Docs, ejecute helm upgrade sin hooks:

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

Para revertir actualizaciones:

$ helm rollback documentserver

8. Apagar ONLYOFFICE Docs

Para realizar el apagado, ejecute el siguiente comando:

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

Dónde <NAMESPACE> es el espacio de nombres donde está instalado ONLYOFFICE Docs. Por defecto es default si no se especifica. Por ejemplo:

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

Después de que el Pod shutdown-ds se ejecute con éxito, elimine el Job:

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

Para reiniciar ONLYOFFICE Docs después del apagado, reinicie los pods de docservice y converter:

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

9. Actualizar la licencia de ONLYOFFICE Docs

Desde la versión v5.1.1, puede actualizar la licencia recreando el secreto sin reiniciar los pods. Para actualizar la licencia:

• Coloque el nuevo archivo license.lic en un directorio.
• Ejecute los siguientes comandos:

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

  Dónde SECRET_LICENSE_NAME es el nombre del secreto existente con una licencia.

El servidor de documentos releerá automáticamente la nueva licencia.

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

10. Prueba de instalación de ONLYOFFICE Docs

Pruebe la disponibilidad de ONLYOFFICE Docs y el acceso a las dependencias conectadas:

$ helm test documentserver -n <NAMESPACE>

La salida debe contener:

Phase: Succeeded

Para ver el registro de la prueba:

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

Después de la prueba, elimine el Pod test-ds:

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

11. Ejecutar Jobs en un clúster k8s privado

Al ejecutar un Job para instalación, actualización, reversión o eliminación, el contenedor necesita acceso a internet para descargar los últimos scripts SQL. Si el acceso a la red externa está restringido en su clúster, configure privateCluster=true y cree manualmente un ConfigMap con los scripts SQL necesarios.

Si su clúster ya tiene los configmaps remove-db-scripts y init-db-scripts, elimínelos primero:

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

Descargue los scripts de la base de datos. Para 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

Para 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

Cree configmaps a partir de ellos:

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

Si utilizó nombres diferentes para ConfigMap o los archivos, configure los parámetros apropiados para los jobs correspondientes: existingConfigmap.tblRemove.name / existingConfigmap.tblRemove.keyName para scripts de limpieza, y existingConfigmap.tblCreate.name / existingConfigmap.tblCreate.keyName para scripts de creación.

Luego, al ejecutar helm install|upgrade|rollback|delete, configure el parámetro privateCluster=true.

12. Acceso a la página de información

El acceso a la página /info está limitado por defecto. Para permitir el acceso, especifique las direcciones IP o subredes usando el parámetro proxy.infoAllowedIP. Tenga en cuenta que debido a las especificidades de la red de Kubernetes, los clientes reales suelen ser direcciones de Pod, Nodo o Balanceador de Carga en lugar de la IP original del usuario.

Puede restringir aún más el acceso utilizando la Autenticación Básica de Nginx configurando el parámetro proxy.infoAllowedUser y una contraseña a través de proxy.infoAllowedPassword. Alternativamente, use un secreto existente configurando proxy.infoAllowedExistingSecret.

1. Desplegar Grafana

1. Desplegar Grafana sin tableros predefinidos
   Omita este paso si desea desplegar Grafana con tableros predefinidos.

   $ 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. Desplegar Grafana con paneles preconfigurados
   1. Instalar paneles preconfigurados de Grafana

      Establezca los parámetros grafana.enabled y grafana.dashboard.enabled en true. Si ONLYOFFICE Docs ya está instalado, ejecute:

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

      Esto descarga paneles preconfigurados en formato JSON desde el sitio web de Grafana, aplica las ediciones necesarias y crea un configmap a partir de ellos. También se añade un panel para las métricas de ONLYOFFICE Docs (se asume que el paso 6 (Desplegar StatsD exporter) ya se ha completado).

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

      Los siguientes paneles serán importados a Grafana: Node Exporter, Deployment Statefulset Daemonset, Redis Dashboard para Prometheus Redis Exporter, RabbitMQ-Overview, Base de datos PostgreSQL, controlador NGINX Ingress, ONLYOFFICE Docs y Uso de recursos por Pods y Contenedores.

      Puede ver la descripción de las métricas de ONLYOFFICE Docs visualizadas en Grafana aquí.

      Vea más detalles sobre la instalación de Grafana a través de Helm aquí.

2. Acceso a Grafana a través de Ingress

Si ONLYOFFICE Docs se instaló con el parámetro grafana.ingress.enabled (Despliegue de métricas), Grafana estará disponible en: http://INGRESS-ADDRESS/grafana/

Si Ingress se instaló con una conexión segura (Exponer ONLYOFFICE Docs a través de HTTPS), Grafana estará disponible en: https://your-domain-name/grafana/

3. Ver métricas recopiladas en Grafana

Vaya a http(s)://your-domain-name/grafana/ e inicie sesión con:

Login - admin

Para obtener la contraseña, ejecute:

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

En la sección de paneles, verá los paneles añadidos que muestran las métricas recibidas de Prometheus.