ONLYOFFICE Docs para Kubernetes

1. Adicionar repositórios 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 armazenamento 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 é uma Classe de Armazenamento Persistente disponível no seu cluster Kubernetes.

  Classes de Armazenamento Persistente para diferentes provedores:

  • Amazon EKS: gp2
  • Digital Ocean: do-block-storage
  • IBM Cloud: Padrão ibmc-file-bronze. Mais classes de armazenamento
  • Yandex Cloud: yc-network-hdd ou yc-network-ssd. Mais detalhes
  • minikube: standard
• PERSISTENT_SIZE é o tamanho total de todos os Armazenamentos Persistentes para a Classe de Armazenamento Persistente nfs. Você pode expressar o tamanho como um número inteiro simples com um destes sufixos: T, G, M, Ti, Gi, Mi. Por exemplo: 9Gi.

Veja mais detalhes sobre a instalação do NFS Server Provisioner via Helm aqui.

Configurar uma Reivindicação de Volume Persistente

A Reivindicação de Volume Persistente padrão nfs é 8Gi. Você pode alterá-la no arquivo values.yaml na seção persistence.storageClass e persistence.size. Deve ser pelo menos 5% menor que PERSISTENT_SIZE. Recomenda-se usar 8Gi ou mais para armazenamento persistente para cada 100 usuários ativos do ONLYOFFICE Docs.

Se você deseja habilitar o WOPI, por favor, defina o parâmetro wopi.enabled=true. Nesse caso, o Armazenamento Persistente deve estar conectado aos nós do cluster com os atributos de cache desativados para o diretório montado para os clientes. Para o NFS Server Provisioner, isso pode ser alcançado adicionando a opção noac ao parâmetro storageClass.mountOptions. Por favor, encontre mais informações aqui.

3. Implantar RabbitMQ

Para instalar o RabbitMQ no seu cluster, execute o seguinte 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

Veja mais detalhes sobre a instalação do RabbitMQ via Helm aqui.

4. Implantar Redis

Para instalar o Redis no seu cluster, execute o seguinte 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

Veja mais detalhes sobre a instalação do Redis via Helm aqui.

5. Implantar Banco de Dados

Como servidor de banco de dados, você pode usar 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. Implantar StatsD exporter

1. Adicionar repositórios 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. Instalando Prometheus

   Para instalar o Prometheus no seu cluster, execute o seguinte 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 alterar o intervalo de coleta, especifique o parâmetro server.global.scrape_interval.

   Veja mais detalhes sobre a instalação do Prometheus via Helm aqui.

3. Instalando StatsD exporter

   Para instalar o StatsD exporter no seu cluster, execute o seguinte comando:

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

   Veja mais detalhes sobre a instalação do Prometheus StatsD exporter via Helm aqui.

   Para permitir as métricas StatsD no ONLYOFFICE Docs, siga este passo.

7. Fazer alterações nos arquivos de configuração Node-config

1. Criar um ConfigMap contendo um arquivo json

   Para criar um ConfigMap a partir de um arquivo que contém a estrutura local.json, você precisa executar o seguinte comando:

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

   Qualquer nome pode ser usado no lugar de local-config.
2. Especificar parâmetros ao instalar o ONLYOFFICE Docs

   Ao instalar o ONLYOFFICE Docs, especifique os parâmetros extraConf.configMap=local-config e extraConf.filename=local.json.

   Se você precisar adicionar um arquivo de configuração após o ONLYOFFICE Docs já estar instalado, você precisa executar o passo 7.1 e então executar o

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

   comando ou

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

   se os parâmetros estiverem especificados no arquivo values.yaml.

8. Adicionar fontes personalizadas

Para adicionar fontes às imagens, você precisa reconstruir as imagens. Consulte os passos relevantes neste manual. Em seguida, especifique suas imagens ao instalar o ONLYOFFICE Docs.

9. Adicionar plugins

Para adicionar plugins às imagens, você precisa reconstruir as imagens. Consulte os passos relevantes neste manual. Em seguida, especifique suas imagens ao instalar o ONLYOFFICE Docs.

10. Adicionar dicionários personalizados

Para adicionar seus dicionários personalizados às imagens, você precisa reconstruir as imagens. Consulte os passos relevantes neste manual. Em seguida, especifique suas imagens ao instalar o ONLYOFFICE Docs.

11. Alterar temas da interface

1. Criar um ConfigMap contendo um arquivo json

   Para criar um ConfigMap com um arquivo json que contém os temas da interface, você precisa executar o seguinte comando:

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

   Em vez de custom-themes e custom-themes.json você pode usar quaisquer outros nomes.
2. Especificar parâmetros ao instalar o ONLYOFFICE Docs

   Ao instalar o ONLYOFFICE Docs, especifique os parâmetros extraThemes.configMap=custom-themes e extraThemes.filename=custom-themes.json.

   Se você precisar adicionar temas de interface após o ONLYOFFICE Docs já estar instalado, você precisa executar o passo 11.1 e então executar o comando 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 se os parâmetros estiverem especificados no arquivo values.yaml.

12. Conectar bucket Amazon S3 como cache ao ONLYOFFICE Helm Docs

Para conectar o bucket Amazon S3 como cache, você precisa criar um arquivo de configuração ou editar o existente de acordo com este guia e alterar o valor do parâmetro persistence.storageS3 para true.

1. Implantar a licença do ONLYOFFICE Docs

1. Criar segredo

   Se você tiver uma licença válida do ONLYOFFICE Docs, crie um segredo license a partir do arquivo:

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

   Onde SECRET_LICENSE_NAME é o nome de um futuro segredo com uma licença.

   O nome do arquivo de licença de origem deve ser 'license.lic' porque esse nome será usado como um campo no segredo criado.

   Se a instalação for realizada sem criar um segredo com o arquivo de licença existente, um segredo vazio license será criado automaticamente. Para informações sobre como atualizar um segredo existente com uma licença, veja aqui.
2. Especificar parâmetros ao instalar o ONLYOFFICE Docs

   Ao instalar o ONLYOFFICE Docs, especifique o parâmetro license.existingSecret=[SECRET_LICENSE_NAME].

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

   Se precisar adicionar a licença após o ONLYOFFICE Docs já estar instalado, você deve executar o passo 1.1 e então executar o comando helm upgrade documentserver onlyoffice/docs --set license.existingSecret=[SECRET_LICENSE_NAME] --no-hooks ou helm upgrade documentserver -f ./values.yaml onlyoffice/docs --no-hooks se os parâmetros estiverem especificados no arquivo values.yaml.

2. Implantar ONLYOFFICE Docs

Para implantar o ONLYOFFICE Docs com o nome de release documentserver:

$ helm install documentserver onlyoffice/docs

O comando implanta o ONLYOFFICE Docs no cluster Kubernetes na configuração padrão. A seção Parâmetros lista os parâmetros que podem ser configurados durante a instalação.

3. Desinstalar ONLYOFFICE Docs

Para desinstalar/excluir a implantação documentserver:

$ helm delete documentserver

Executar o comando helm delete aciona hooks, que realizam algumas ações preparatórias antes de excluir completamente o ONLYOFFICE Docs, incluindo parar o servidor, limpar o PVC usado e as tabelas do banco de dados. O tempo padrão de execução dos hooks é de 300s. O tempo de execução pode ser alterado usando --timeout [time], por exemplo:

$ helm delete documentserver --timeout 25m

Se você quiser excluir o ONLYOFFICE Docs sem nenhuma ação preparatória, execute o seguinte comando:

$ helm delete documentserver --no-hooks

O comando helm delete remove todos os componentes do Kubernetes associados ao chart e exclui a release.

4. Parâmetros

Especifique cada parâmetro usando o argumento --set key=value[,key=value] para helm install. Por exemplo:

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

Este comando expõe o ONLYOFFICE Docs via HTTPS.

Alternativamente, um arquivo YAML que especifica os valores para os parâmetros pode ser fornecido durante a instalação do chart:

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

5. Detalhes de configuração e instalação

1. Exemplo de implantação (opcional)
   Importante Este passo é opcional. Você pode ignorá-lo completamente se não precisar implantar o exemplo.

   Para implantar o exemplo, defina o parâmetro example.enabled como true:

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

2. Implantação de métricas (opcional)

   Importante Este passo é opcional. Você pode ignorá-lo completamente se não precisar implantar métricas.

   Para implantar métricas, defina metrics.enabled como true:

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

   Se você quiser usar o Grafana para visualizar métricas, defina grafana.enabled como true. Se quiser usar o Nginx Ingress para acessar o Grafana, defina grafana.ingress.enabled como true:

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

3. Expor ONLYOFFICE Docs
   1. Expor ONLYOFFICE Docs via Serviço (apenas HTTP)
      Você deve pular este passo se for expor ONLYOFFICE Docs via HTTPS.

      Este tipo de exposição cria um balanceador de carga para acessar o ONLYOFFICE Docs. Use este tipo se você usar terminação TLS externa e não tiver outra aplicação web no cluster k8s.

      Para expor ONLYOFFICE Docs via serviço, defina o parâmetro service.type como LoadBalancer:

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

      Execute o seguinte comando para obter o IP do serviço documentserver:

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

      Depois disso, o ONLYOFFICE Docs estará disponível em http://DOCUMENTSERVER-SERVICE-IP/.

      Se o IP do serviço estiver vazio, tente obter o hostname do serviço documentserver:

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

      Nesse caso, o ONLYOFFICE Docs estará disponível em http://DOCUMENTSERVER-SERVICE-HOSTNAME/.

   2. Expor ONLYOFFICE Docs via Ingress

      Primeiro, instale o Kubernetes Nginx Ingress Controller:

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

      Para habilitar a exposição de métricas do ingress-nginx para o Prometheus, execute:

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

      Veja mais detalhes sobre a instalação do Nginx Ingress via Helm aqui.

      Em seguida, escolha seu método de exposição:

      • Via HTTP

        Você deve pular isso se for expor ONLYOFFICE Docs via HTTPS.

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

        Obtenha o IP do ingress:

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

        O ONLYOFFICE Docs estará disponível em http://DOCUMENTSERVER-INGRESS-IP/ (ou use o hostname se o IP estiver vazio).

      • Via HTTPS (terminação TLS)

        Crie o segredo tls com seu 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

        Associe o IP ou hostname do ingress com seu nome de domínio através do seu provedor de DNS. Depois disso, o ONLYOFFICE Docs estará disponível em 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

        Em seguida, instale ou atualize o ONLYOFFICE Docs configurando ingress.enabled, ingress.ssl.enabled, ingress.letsencrypt.enabled como true, e especificando seus valores para ingress.letsencrypt.email e ingress.host (ou ingress.tenants para múltiplos domínios).

      • Via um caminho virtual

        Defina os parâmetros ingress.enabled, ingress.host e ingress.path:

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

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

        Para Ingress NGINX por Kubernetes, adicione o padrão (/|$)(.*) a ingress.path, por exemplo, /docs(/|$)(.*).

   3. Expor ONLYOFFICE Docs via rota no OpenShift

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

      Para terminação TLS, adicione manualmente certificados à rota através do console web do OpenShift.

6. Escalar ONLYOFFICE Docs

1. Escalonamento Horizontal de Pods

   Você pode habilitar o escalonamento automático para que o número de réplicas das implantações docservice e converter seja calculado automaticamente com base nos valores e tipo de métricas.

   Para métricas de recursos, a API metrics.k8s.io deve estar registrada, o que geralmente é fornecido pelo metrics-server. Ele pode ser iniciado como um complemento do cluster.

   Para habilitar o HPA para a implantação do docservice, especifique o parâmetro docservice.autoscaling.enabled=true. Da mesma forma, para habilitar o HPA para a implantação do converter, especifique converter.autoscaling.enabled=true. Em ambos os casos, o parâmetro replicas correspondente é ignorado e o número de réplicas é controlado pelo HPA.

   Para mais informações sobre o Horizontal Pod Autoscaling, veja aqui. Para outros parâmetros configuráveis de Autoscaling, consulte a tabela de Parâmetros.

2. Escalonamento manual

   As implantações docservice e converter consistem em 2 pods cada por padrão.

   Para escalar a implantação do docservice:

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

   Para escalar a implantação do converter:

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

7. Atualizar ONLYOFFICE Docs

Para atualizar, defina os parâmetros para a atualização. Por exemplo:

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

Ou modifique o arquivo values.yaml e execute:

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

O comando helm upgrade executa um hook que desliga o ONLYOFFICE Docs e limpa o banco de dados. O tempo padrão de execução do hook é 300s. Para alterá-lo:

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

Para atualizar qualquer parâmetro além da versão do ONLYOFFICE Docs, execute helm upgrade sem hooks:

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

Para reverter atualizações:

$ helm rollback documentserver

8. Desligar ONLYOFFICE Docs

Para realizar o desligamento, execute o seguinte comando:

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

Onde <NAMESPACE> é o namespace onde o ONLYOFFICE Docs está instalado. O padrão é default se não especificado. Por exemplo:

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

Após a execução bem-sucedida do Pod shutdown-ds, exclua o Job:

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

Para reiniciar o ONLYOFFICE Docs após o desligamento, reinicie os pods docservice e converter:

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

9. Atualizar licença do ONLYOFFICE Docs

Desde a versão v5.1.1, você pode atualizar a licença recriando o segredo sem reiniciar os pods. Para atualizar a licença:

• Coloque o novo arquivo license.lic em um diretório.
• Execute os seguintes comandos:

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

  Onde SECRET_LICENSE_NAME é o nome do segredo existente com uma licença.

O documentserver irá reler a nova licença automaticamente.

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

10. Teste de instalação do ONLYOFFICE Docs

Teste a disponibilidade do ONLYOFFICE Docs e o acesso às dependências conectadas:

$ helm test documentserver -n <NAMESPACE>

A saída deve conter:

Phase: Succeeded

Para visualizar o log do teste:

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

Após o teste, exclua o Pod test-ds:

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

11. Executar Jobs em um cluster k8s privado

Ao executar um Job para instalação, atualização, reversão ou exclusão, o contêiner precisa de acesso à internet para baixar os scripts SQL mais recentes. Se o acesso à rede externa for restrito no seu cluster, defina privateCluster=true e crie manualmente um ConfigMap com os scripts SQL necessários.

Se o seu cluster já tiver os configmaps remove-db-scripts e init-db-scripts, exclua-os primeiro:

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

Baixe os scripts do banco de dados. 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

Crie configmaps a partir deles:

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

Se você usou nomes diferentes para o ConfigMap ou os arquivos, defina os parâmetros apropriados para os jobs correspondentes: existingConfigmap.tblRemove.name / existingConfigmap.tblRemove.keyName para scripts de limpeza, e existingConfigmap.tblCreate.name / existingConfigmap.tblCreate.keyName para scripts de criação.

Então, ao executar helm install|upgrade|rollback|delete, defina o parâmetro privateCluster=true.

12. Acesso à página de informações

O acesso à página /info é limitado por padrão. Para permitir o acesso, especifique os endereços IP ou sub-redes usando o parâmetro proxy.infoAllowedIP. Note que, devido às especificidades da rede Kubernetes, os clientes reais são tipicamente endereços de Pod, Node ou Load Balancer em vez do IP original do usuário.

Você pode restringir ainda mais o acesso usando a Autenticação Básica do Nginx definindo o parâmetro proxy.infoAllowedUser e uma senha via proxy.infoAllowedPassword. Alternativamente, use um segredo existente definindo proxy.infoAllowedExistingSecret.

1. Implantar Grafana

1. Implantar Grafana sem dashboards prontos
   Pule este passo se quiser implantar o Grafana com dashboards prontos.

   $ 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. Implantar Grafana com dashboards prontos
   1. Instalar dashboards prontos do Grafana

      Defina os parâmetros grafana.enabled e grafana.dashboard.enabled como true. Se o ONLYOFFICE Docs já estiver instalado, execute:

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

      Isso baixa dashboards prontos em formato JSON do site do Grafana, aplica as edições necessárias e cria um configmap a partir deles. Um dashboard para métricas do ONLYOFFICE Docs também é adicionado (pressupõe-se que o passo 6 (Implantar StatsD exporter) já foi concluído).

   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

      Os seguintes dashboards serão importados para o Grafana: Node Exporter, Deployment Statefulset Daemonset, Redis Dashboard para Prometheus Redis Exporter, RabbitMQ-Overview, Banco de Dados PostgreSQL, controlador NGINX Ingress, ONLYOFFICE Docs e Uso de recursos por Pods e Containers.

      Você pode ver a descrição das métricas do ONLYOFFICE Docs visualizadas no Grafana aqui.

      Veja mais detalhes sobre a instalação do Grafana via Helm aqui.

2. Acesso ao Grafana via Ingress

Se o ONLYOFFICE Docs foi instalado com o parâmetro grafana.ingress.enabled (Implantação de métricas), o Grafana estará disponível em: http://INGRESS-ADDRESS/grafana/

Se o Ingress foi instalado com uma conexão segura (Expor ONLYOFFICE Docs via HTTPS), o Grafana estará disponível em: https://your-domain-name/grafana/

3. Visualizar métricas coletadas no Grafana

Acesse http(s)://your-domain-name/grafana/ e faça login com:

Login - admin

Para obter a senha, execute:

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

Na seção de dashboards, você verá os dashboards adicionados exibindo métricas recebidas do Prometheus.