Aller au contenu principal

OnlyOffice sur Google Cloud Run

OnlyOffice sur Google Cloud Run

ONLYOFFICE Document Server est une suite bureautique collaborative en ligne open source pour la co-édition en temps réel de documents texte, feuilles de calcul, présentations, PDF et formulaires — une alternative auto-hébergée à Google Docs / Microsoft Office Online. Il n'est généralement pas ouvert directement par les utilisateurs finaux ; il est plutôt intégré par une application hôte (Nextcloud, ownCloud, Seafile, ou une intégration personnalisée) via son API et un secret JWT partagé. Ce module déploie ONLYOFFICE Document Server sur Cloud Run v2 au-dessus de la fondation App_CloudRun, qui provisionne et gère l'infrastructure Google Cloud partagée.

Ce guide se concentre sur les services cloud qu'OnlyOffice utilise et sur la façon de les explorer et de les opérer depuis la console Google Cloud et la ligne de commande. Pour les mécanismes communs à chaque application Cloud Run — identité de service, ingress et équilibrage de charge, mise à l'échelle et concurrence, CI/CD, Cloud Armor, IAP, Binary Authorization, VPC Service Controls, sauvegardes et cycle de vie du déploiement — reportez-vous au guide de la fondation App_CloudRun plutôt que de les répéter ici.


Ce que coûte OnlyOffice sur RAD, et comparaison​

OnlyOffice sur le module Cloud Run de RAD coûte environ 102 $ US par mois, avec les frais de module facturés une fois en crédits RAD. Si vous avez besoin qu'OnlyOffice reste opérationnel en continu, qu'il s'adapte à travers plusieurs pods, ou qu'il fonctionne aux côtés d'autres charges de travail Kubernetes, consultez le guide GKE pour cette option. Si vous n'en avez besoin qu'occasionnellement — une démo, un projet saisonnier, quelque chose que vous évaluez — un projet géré par RAD peut être supprimé et restauré dans les 30 jours sans frais supplémentaires au lieu de payer pour qu'il reste inactif. Voir Mettez-le en pause gratuitement, ci-dessous. Les chiffres sont valables au 8 octobre 2026 ; les sources sont listées à la fin de cette section.

Ce que vous payez sur RAD​

RAD déploie OnlyOffice, qui est open source, il n'y a donc pas de frais de licence par utilisateur. Vous payez pour trois choses :

Dans un projet Google Cloud que vous possédezDans un projet que RAD gère pour vous
Frais de module, une fois par déploiement110 crédits (11 $ US au prix de la recharge)99 crédits (10 % de moins)
BuildsInclus dans le prix : pas de frais de build pour la création, 5 mises à jour par mois (mois calendaire UTC) gratuites puis 2 crédits chacune, et rien pour la suppression ou pour un build échoué, dans la limite de 10 builds échoués par jour (UTC). Les sessions de lab et les projets clients sont l'exception : ils sont toujours facturés pour le temps de build à la minuteIdem
Coût de fonctionnement Google CloudFacturé par Google à votre propre compte de facturation, environ 102 $ US par mois pour la configuration par défaut (tableau ci-dessous)Mesuré à l'heure en crédits ; RAD publie 67 crédits par jour, soit environ 2 010 par mois (environ 201 $ US au prix de la recharge)
Qui possède quoiVous possédez le projet et sa facturation ; RAD le déploie et le met à jourRAD possède le projet, avec des garde-fous, des quotas et des alertes budgétaires ; vous avez accès à la console, et un solde minimum acheté est conservé en réserve

Votre premier déploiement réussi sur RAD est exempt de frais de module, quel que soit le montant : une fois par compte, pour un module que vous déployez et payez vous-même (dans une solution, les frais d'une application : la première à réussir ; jamais une session de lab ou un projet client).

10 crédits coûtent 1 $ US lors d'une recharge ponctuelle, et moins avec un plan mensuel. Dans un projet géré par RAD, la base de données, le serveur de fichiers et le réseau sont partagés par toutes les applications du projet, de sorte qu'une deuxième application n'ajoute pas un deuxième ensemble de ces éléments.

Coût de fonctionnement par défaut dans votre propre projet (us-central1, prix catalogue Google) :

Ressource (par défaut du module)Par mois
Cloud Run, 2x vCPU / 4 Gio (scaleToZero)31,53 $ US
Cloud SQL pour PostgreSQL, 1 vCPU / 3,75 Go, zonal, 10 Go SSD51,02 $ US
Serveur de fichiers NFS/cache (petite VM)13,43 $ US
Cloud NAT et réseau5 $ US
Cloud Storage (modules complémentaires, sauvegardes)1 $ US
Totalenviron 102 $ US

Comparaison​

OptionPrixQui l'exécute
ONLYOFFICE DocSpace, StartupGratuitCloud hébergé par ONLYOFFICE. Jusqu'à 3 administrateurs, 2 Go de stockage, utilisateurs gratuits illimités
ONLYOFFICE DocSpace, Business20 $/administrateur/moisCloud hébergé par ONLYOFFICE. 250 Go par administrateur, salles illimitées
RAD, Cloud Run, votre propre projetEnviron 102 $ US, plus 11 $ US une fois par déploiementAutomatisation de RAD, dans votre projet
RAD, Cloud Run, un projet géré par RADEnviron 960 crédits (77–96 $ US)RAD
RAD, GKE AutopilotVoir le guide GKERAD

Le DocSpace d'ONLYOFFICE est tarifé par administrateur, et non par utilisateur éditeur, ce qui est la comparaison la plus juste avec le coût d'infrastructure fixe de RAD. Pour une petite équipe qui n'a besoin que d'un ou deux administrateurs, le niveau Startup gratuit de DocSpace ou son plan Business à 20 $/mois peut être moins cher en espèces que le coût de fonctionnement d'un projet propre à RAD — la différence est que ce module déploie le Document Server que vous intégrez dans votre propre application, plutôt que l'espace de travail groupé d'ONLYOFFICE, ce qui est important si vous utilisez déjà une plateforme de documents (Nextcloud, ownCloud, une application personnalisée) qui n'a besoin que du moteur d'édition.

Mettez-le en pause gratuitement : supprimez un projet géré par RAD, restaurez-le quand vous en avez besoin​

Si OnlyOffice s'exécute dans un projet que RAD gère pour vous, vous avez une deuxième option qui va bien au-delà de la mise à l'échelle à zéro : supprimez l'ensemble du projet et restaurez-le dans les 30 jours pour presque rien. Cela convient bien mieux à OnlyOffice dont vous n'avez besoin qu'occasionnellement — une démo, une évaluation, un projet saisonnier — que de le faire fonctionner en continu.

Une restauration n'est pas garantie — conservez vos propres sauvegardes. Les conditions de Google Cloud ne garantissent pas qu'un projet restauré, ou les ressources qu'il contient, seront utilisables après sa restauration, de sorte que la restauration ne peut pas être considérée comme un moyen fiable de récupérer un projet supprimé. Avant de supprimer, assurez-vous d'avoir effectué des sauvegardes appropriées des données et de la configuration de l'application et de les avoir stockées en dehors du projet. Si une restauration échoue, ou si le projet restauré ne fonctionne pas, la solution de repli consiste à redéployer l'application (voir la section suivante) et à restaurer sa configuration et ses données à partir de ces sauvegardes.

  • Comment ça marche. La suppression d'un projet géré par RAD délie d'abord sa facturation, puis demande à Google de supprimer le projet. Google ne supprime pas le projet immédiatement : il le conserve, récupérable, pendant 30 jours. Comme la facturation est déjà déliée, rien n'est facturé pendant cette attente. Contrairement à la suppression d'un module, cela ne détruit pas la base de données, la VM ou la ressource de calcul une par une — l'ensemble du projet, et tout ce qu'il contient, s'arrête simplement.
  • La restauration est une vérification, pas une reconstruction. Dans les 30 jours, le propriétaire du projet peut le restaurer. RAD demande à Google de restaurer le projet et de rattacher son compte de facturation, puis vous demande d' exécuter Mettre à jour sur chaque déploiement pour confirmer que tout est revenu. Comme rien n'a été détruit individuellement, cette mise à jour trouve les mêmes ressources déjà présentes — c'est une vérification, pas une reconstruction, et une mise à jour ne facture jamais les frais de module à nouveau. Les mises à jour sont incluses dans le prix (5 par mois pour chaque déploiement), donc une restauration ne coûte normalement aucun crédit.
  • Ainsi, un mois d'utilisation occasionnelle peut coûter quelques dollars, et non les 201 $ US par mois pour le maintenir en fonctionnement. Déployez OnlyOffice, utilisez-le pendant un certain temps, supprimez le projet. Restaurez-le la prochaine fois que vous en avez besoin, confirmez avec Mettre à jour, et supprimez-le à nouveau lorsque vous avez terminé. Vous ne payez que les frais de module une seule fois et le temps pendant lequel OnlyOffice a été réellement actif.
  • Ce que cela nécessite. Vous devez être propriétaire du projet (pas un projet que vous apportez et dont RAD ne gère que la facturation), et vous le restaurez vous-même dans les 30 jours — après cela, Google le supprime définitivement. La restauration est admise comme la création d'un nouveau projet : votre solde de crédits achetés doit toujours dépasser le seuil du niveau (100 crédits pour le niveau sandbox que la plupart des utilisations d'étude et de démonstration conviennent). Google indique que la plupart des services sont à nouveau pleinement fonctionnels dans les 36 heures suivant une restauration.
  • Un véritable manque : les sauvegardes nocturnes ne survivent pas. Les sauvegardes sont écrites dans un bucket à l'intérieur du projet, et ce bucket n'est pas protégé par la suppression logicielle de Cloud Storage, il est donc très probable qu'il disparaisse dès que vous supprimez le projet — même si le projet lui-même est récupérable pendant 30 jours. Si vous avez personnalisé OnlyOffice et que vous souhaitez conserver ce travail, copiez une sauvegarde (vers Google Drive, ou un bucket en dehors du projet) avant de supprimer. Pour une installation par défaut sans rien d'irremplaçable, cela n'a pas d'importance.

Payez uniquement pendant que vous l'utilisez, l'autre méthode : supprimer et redéployer​

L'option ci-dessus ne s'applique qu'à un projet géré par RAD ; dans votre propre projet, ou une fois la fenêtre de 30 jours passée, la façon d'arrêter de payer est de supprimer le déploiement et de le redéployer lorsque vous en avez besoin.

  • Ce que coûte un redéploiement. Les frais de module à nouveau (les builds sont inclus) : 110 crédits (11,00 $ US) dans votre propre projet, ou 99 crédits dans un projet géré par RAD. La suppression permet d'économiser de l'argent une fois qu'OnlyOffice resterait inutilisé pendant environ 3 jours ou plus dans votre propre projet (environ 3,40 $ US par jour), ou environ 2 jours ou plus dans un projet géré par RAD (67 crédits par jour).
  • La majeure partie du coût de fonctionnement est généralement la base de données et toute VM de fichier/cache partagée. Elles ne s'arrêtent que lorsque rien d'autre dans le projet ne les utilise, donc la suppression d'OnlyOffice alors que quelque chose d'autre partage le projet n'économise que la partie de calcul propre à cette application.
  • Conservez d'abord vos données. Les sauvegardes nocturnes vont dans un bucket à l'intérieur du déploiement et sont supprimées avec lui, donc copiez la dernière sauvegarde avant de supprimer si vous voulez la conserver.

Sessions de lab et environnements gérés​

  • Sessions de lab, pour la formation. Un formateur anime une session pour une classe. Chaque participant dispose d'OnlyOffice dans son propre projet Google Cloud pendant 15 minutes à 24 heures, dans la limite d'une allocation définie par le formateur. Le formateur peut aussi créer un seul environnement partagé pour toute la classe, et chacun utilise alors la même application et ses données. Soit le formateur finance toutes les places, soit chaque participant paie la sienne. Tout est supprimé à la fin de la session et les crédits inutilisés sont reversés au formateur.
  • Environnements gérés, pour les sociétés de conseil. Un partenaire exécute OnlyOffice pour un client à partir d'un portefeuille cloisonné qu'il finance, et règle directement avec le client. Si le portefeuille est faible, la facturation est suspendue et les données sont conservées, de sorte que personne ne reçoit de frais inattendus. À la fin, le partenaire remet le projet et les déploiements deviennent la propriété du client.
  • Les crédits peuvent être achetés dans plus de 20 devises, y compris XAF, XOF, NGN, GHS, KES et ZAR, par carte, virement bancaire ou argent mobile.

Sources (8 octobre 2026) : Prix catalogue Google Cloud de l'API Cloud Billing Catalog ; Supprimer et restaurer des projets pour la fenêtre de récupération de 30 jours et ce qu'elle dit sur les objets Cloud Storage sans suppression logicielle ; frais RAD et estimations de crédits quotidiens de radmodules.dev/pricing ; tarification ONLYOFFICE DocSpace. Les prix changent ; vérifiez chaque source avant de vous fier à un chiffre.

1. Vue d'ensemble​

L'image onlyoffice/documentserver est "tout inclus" : elle regroupe ses propres convertisseurs, nginx et RabbitMQ (AMQP) sous supervisord. Ce module construit un mince wrapper personnalisé autour d'elle et externalise PostgreSQL (Cloud SQL) et Redis ; le RabbitMQ intégré reste interne sur localhost.

CapacitéService Google CloudNotes
CalculCloud Run v2Conteneur personnalisé, 2 vCPU / 4 Gio par défaut, autoscaling sans serveur ; mise à l'échelle à zéro prise en charge
Base de donnéesCloud SQL pour PostgreSQL 15Obligatoire — une garde au moment de la planification rejette MySQL et tout autre moteur
Cache / état d'éditionRedis externeObligatoire — une garde au moment de la planification rejette enable_redis = false ; par défaut, le Redis de la VM NFS colocalisée lorsque redis_host est vide
Persistance des fichiersCloud Filestore (NFS)Activé par défaut ; stockage partagé des pièces jointes/documents entre les instances, monté à /opt/onlyoffice/storage
Stockage d'objetsCloud StorageDeux buckets par défaut : un bucket storage déclaré par OnlyOffice_Common, plus un bucket data via storage_buckets (les deux sont régis par create_cloud_storage, qui par défaut true ici puisque Cloud Run n'a pas d'option PVC de bloc)
SecretsSecret ManagerJWT_SECRET de 48 caractères généré automatiquement ; mot de passe de la base de données géré séparément
IngressURL Cloud Run / Équilibrage de charge CloudURL run.app par défaut ; équilibreur de charge HTTPS externe facultatif + domaine personnalisé

Valeurs par défaut judicieuses à connaître d'emblée :

  • PostgreSQL 15 est obligatoire. Une garde inter-variables au moment de la planification dans le validation.tf de ce module rejette tout database_type autre que POSTGRES_13/14/15/NONE — MySQL et SQL Server ne sont pas pris en charge par Document Server.
  • Redis est obligatoire, pas facultatif. Une précondition au moment de la planification échoue le déploiement si enable_redis = false. Avec redis_host laissé vide, enable_nfs doit rester true afin que l'IP de la VM NFS colocalisée puisse servir d'hôte Redis par défaut.
  • NFS est activé par défaut (enable_nfs = true, contrairement à la plupart des autres modules Cloud Run), car il sert à la fois de stockage partagé des pièces jointes et de source de point de terminaison Redis par défaut.
  • JWT_SECRET est généré une seule fois et ne doit jamais être renouvelé après qu'une application hôte (Nextcloud, ownCloud, une intégration personnalisée) a été configurée pour intégrer l'éditeur — le renouveler rompt la confiance entre Document Server et chaque intégration jusqu'à ce que toutes soient mises à jour avec la nouvelle valeur.
  • La mémoire minimale est de 4 Gio, et non les 512 Mio–2 Gio habituels de la plateforme. La pile Postgres-client/Redis-client/RabbitMQ/nginx/convertisseur intégrée sous supervisord est lourde et nécessite cette marge.
  • cpu_always_allocated est par défaut false (coût d'abord, facturation basée sur les requêtes). Le travail d'édition/conversion principal s'exécute dans la requête, donc un démarrage à froid est supportable, mais la chaleur du cache de documents intégré et la file d'attente de conversion RabbitMQ interne se réinitialisent à chaque démarrage à froid. Définissez true (avec min_instance_count >= 1) pour un éditeur toujours chaud.
  • L'image est construite sur mesure, non préconstruite. container_image_source = "custom" enveloppe l'image Docker Hub onlyoffice/documentserver avec un cloud-entrypoint.sh qui mappe les variables DB_*/REDIS_HOST de la Fondation sur la propre convention de Document Server. application_version = "latest" est épinglé à 8.3.3 au moment de la construction via un ARG de construction ONLYOFFICE_VERSION spécifique à l'application (le APP_VERSION injecté de la Fondation n'est délibérément pas utilisé, car il gagnerait autrement la fusion).
  • Les vérifications de santé ciblent /healthcheck, non authentifiées, avec un budget généreux au premier démarrage (délai initial de 90 s, jusqu'à 40 échecs) car la pile intégrée est lente à devenir prête.

2. Services Google Cloud et comment les explorer​

Toutes les commandes supposent que PROJECT et REGION sont définis. Les noms de services et de ressources sont rapportés dans les Sorties du déploiement.

A. Cloud Run — le service OnlyOffice​

OnlyOffice Document Server s'exécute comme un seul service Cloud Run v2 (l'image wrapper personnalisée) qui s'adapte automatiquement en fonction de la charge de requêtes entre le nombre minimal et maximal d'instances. Chaque déploiement crée une révision immuable.

  • Console : Cloud Run → sélectionnez le service pour les révisions, le trafic, les journaux et les métriques.
  • CLI :
    gcloud run services list --project "$PROJECT" --region "$REGION"
    gcloud run services describe <service-name> --project "$PROJECT" --region "$REGION"
    gcloud run revisions list --service <service-name> --project "$PROJECT" --region "$REGION"

Voir App_CloudRun pour la mise à l'échelle, la concurrence, l'environnement d'exécution et la répartition du trafic.

B. Cloud SQL pour PostgreSQL 15​

OnlyOffice stocke les métadonnées de documents, les versions et l'état de l'application dans une instance gérée de Cloud SQL pour PostgreSQL 15. Le service se connecte en privé via le proxy d'authentification Cloud SQL sur un socket Unix ; aucune IP publique n'est exposée. Lors du premier déploiement, le job db-init intégré crée le rôle d'application, la base de données et les autorisations — le Document Server installe ensuite son propre schéma au premier démarrage.

  • Console : SQL → sélectionnez l'instance pour les connexions, les sauvegardes, les indicateurs, les métriques.
  • CLI :
    gcloud sql instances list --project "$PROJECT"
    gcloud sql instances describe <instance-name> --project "$PROJECT"
    gcloud sql connect <instance-name> --user=<db-user> --database=<db-name> --project "$PROJECT"

Le nom de l'instance, la base de données, l'utilisateur et le secret du mot de passe se trouvent dans les Sorties. Voir App_CloudRun pour le modèle de connexion, les sauvegardes et la rotation des mots de passe.

C. Redis externe et Cloud Filestore (NFS)​

Redis contient l'état de session/édition qui doit être partagé entre chaque instance OnlyOffice — le RabbitMQ intégré reste interne, mais Redis est externalisé et obligatoire (une garde au moment de la planification échoue le déploiement si enable_redis = false). Avec redis_host laissé vide, la Fondation injecte l'IP Redis de la VM NFS colocalisée (enable_nfs doit rester true dans ce cas) ; définissez redis_host explicitement pour pointer vers une instance Redis différente. Cloud Filestore (NFS) est activé par défaut et monté à /opt/onlyoffice/storage pour le stockage partagé des pièces jointes/documents entre les instances — contrairement à la variante GKE, il n'y a pas d'option PVC de bloc, car les instances Cloud Run sont sans état et éphémères.

  • Console : Compute Engine → Instances de VM (la VM colocalisée NFS/Redis) ; Filestore → Instances.
  • CLI :
    redis-cli -h <redis-host> ping
    # Confirm the resolved Redis/DB env vars in the running revision:
    gcloud run services describe <service-name> --region "$REGION" \
    --format='value(spec.template.spec.containers[0].env)'

Voir App_CloudRun pour le modèle de découverte de la VM NFS et la convention selon laquelle l'hôte Redis se replie sur l'IP NFS.

D. Cloud Storage​

Deux buckets sont provisionnés par défaut : un bucket storage déclaré par OnlyOffice_Common (pour les besoins de stockage propres à l'application) et un bucket data de la valeur par défaut storage_buckets de ce module — tous deux régis par create_cloud_storage, qui par défaut true ici (contrairement à la variante GKE, qui par défaut false car la persistance y réside sur un PVC de bloc + NFS à la place).

  • Console : Cloud Storage → Buckets.
  • CLI :
    gcloud storage buckets list --project "$PROJECT" --filter="name~onlyoffice"

Voir App_CloudRun pour les options GCS Fuse et CMEK.

E. Secret Manager​

Un secret spécifique à OnlyOffice est généré automatiquement et stocké dans Secret Manager : JWT_SECRET (48 caractères, pas de caractères spéciaux), qui signe chaque requête API interne de Document Server et doit être présenté par toute application hôte qui intègre l'éditeur. Le mot de passe de la base de données est géré séparément par la fondation.

  • Console : Sécurité → Secret Manager.
  • CLI :
    gcloud secrets list --project "$PROJECT" --filter="name~onlyoffice-jwt-secret"
    gcloud secrets versions access latest --secret=<secret-name> --project "$PROJECT"

Voir App_CloudRun pour les détails d'injection et de rotation.

F. Réseau et ingress​

Le service est accessible par son URL run.app par défaut. Étant donné que Document Server est généralement appelé par le propre backend d'une application hôte (et non directement par les utilisateurs finaux), conservez ingress_settings = "all" à moins que tous les appelants ne soient à l'intérieur du VPC. Un équilibreur de charge HTTPS externe avec un domaine personnalisé, Cloud CDN et Cloud Armor peuvent être superposés.

  • Console : Cloud Run (URL du service) ; Services réseau → Équilibrage de charge.
  • CLI :
    gcloud run services describe <service-name> --region "$REGION" --format='value(status.url)'
    gcloud compute addresses list --project "$PROJECT"

Voir App_CloudRun.

G. Cloud Logging et Monitoring​

Les journaux de conteneurs sont envoyés à Cloud Logging ; les métriques Cloud Run et Cloud SQL sont envoyées à Cloud Monitoring, avec des vérifications de disponibilité et des stratégies d'alerte facultatives.

  • Console : Logging → Explorateur de journaux ; Monitoring → Tableaux de bord / Alertes.
  • CLI :
    gcloud run services logs read <service-name> --project "$PROJECT" --region "$REGION" --limit 50

3. Comportement de l'application OnlyOffice​

  • Configuration de la base de données au premier déploiement, pas de job de migration séparé. Le job db-init intégré s'exécute en utilisant postgres:15-alpine. Il résout l'hôte Cloud SQL (le répertoire du socket Unix du proxy d'authentification, avec un repli sur l'IP privée de l'instance), attend que PostgreSQL soit accessible, crée/met à jour le rôle d'application avec le mot de passe généré, crée la base de données de l'application et accorde tous les privilèges — il ne provisionne que le rôle/la base de données/les autorisations. Le Document Server installe son propre schéma au premier démarrage, il n'y a donc pas d'étape de migration séparée. Le job peut être réexécuté en toute sécurité (execute_on_apply = true).
  • JWT_SECRET est immuable après la connexion des intégrations. Généré une fois (48 caractères) et écrit dans Secret Manager. JWT_ENABLED = "true", JWT_HEADER = "Authorization", JWT_IN_BODY = "true" sont définis automatiquement par OnlyOffice_Common. La rotation du secret invalide la confiance avec chaque application hôte intégrant l'éditeur jusqu'à ce que chacune soit reconfigurée avec la nouvelle valeur.
  • Le mappage des variables d'environnement DB et Redis se fait dans le cloud-entrypoint.sh intégré. Il définit DB_TYPE = "postgres" et DB_PWD à partir du DB_PASSWORD injecté (DB_HOST/DB_PORT/DB_NAME/DB_USER correspondent déjà aux noms de Document Server), et mappe REDIS_HOST/REDIS_PORT/REDIS_AUTH sur REDIS_SERVER_HOST/REDIS_SERVER_PORT/REDIS_SERVER_PASS avant d'exécuter exec le /app/ds/run-document-server.sh en amont. Comme cette logique est intégrée à l' image personnalisée, une modification de cloud-entrypoint.sh nécessite une reconstruction pour prendre effet.
  • Bug fournisseur spécifique à Cloud Run, corrigé au moment de la construction. Sur Cloud Run, DB_HOST est un répertoire de socket Unix du proxy d'authentification Cloud SQL (/cloudsql/<instance>), ce qui est correct pour la connexion réelle à la base de données — mais le run-document-server.sh en amont a sa propre porte de disponibilité séparée, waiting_for_connection(), qui exécute inconditionnellement nc -z "$DB_HOST" "$DB_PORT". nc ne peut pas résoudre un chemin de système de fichiers comme un hôte TCP, donc sans correctif, cela boucle indéfiniment (Waiting for connection to the /cloudsql/... host on port 5432 se répétant dans Cloud Logging) et le conteneur ne devient jamais Prêt. Le Dockerfile du module sed -i corrige cette porte pour qu'elle se court-circuite avec succès lorsque $1 est un répertoire existant, laissant la vérification nc originale inchangée pour les hôtes TCP réels — ainsi GKE (dont le sidecar du proxy d'authentification écoute sur 127.0.0.1) n'est pas affecté et n'a pas besoin de correctif. Une assertion grep -q juste après le sed fait échouer bruyamment le Cloud Build si une future mise à jour ONLYOFFICE_VERSION modifie la formulation du script en amont — voir modules/OnlyOffice_Common/scripts/Dockerfile.
  • Pas de flux d'inscription traditionnel. Document Server n'est généralement pas ouvert directement par les utilisateurs finaux — il est intégré via des appels API depuis une application hôte (Nextcloud, ownCloud, une intégration personnalisée) utilisant le secret JWT partagé. Il n'y a pas de compte administrateur à créer au premier démarrage ; la disponibilité est confirmée via /healthcheck et par l'application hôte ouvrant avec succès un document pour la co-édition.
  • Chemin de santé. Les sondes de démarrage et de vivacité ciblent /healthcheck — le point de terminaison de Document Server qui renvoie true uniquement une fois que nginx et les services de documents sont opérationnels et que la base de données est accessible, servie sans authentification. Prévoyez plusieurs minutes au premier démarrage (délai initial de 90 secondes, période de 15 secondes, jusqu'à 40 échecs — environ 10 minutes de marge pendant que la pile intégrée démarre et que le schéma s'installe).
  • WOPI est désactivé par défaut. WOPI_ENABLED = "false" ; activez-le via environment_variables uniquement lors de l'intégration avec un hôte WOPI (par exemple SharePoint).
  • Inspecter l'exécution du job et la configuration en cours :
    gcloud run jobs list --project "$PROJECT" --region "$REGION"
    gcloud run jobs executions list --job <job-name> --project "$PROJECT" --region "$REGION"
    gcloud run services describe <service-name> --region "$REGION" \
    --format='value(spec.template.spec.containers[0].env)'

4. Variables de configuration​

Les variables sont regroupées exactement telles qu'elles apparaissent sur la plateforme de déploiement. Seuls les paramètres spécifiques ou notables pour OnlyOffice sont listés ; toutes les autres entrées sont héritées de App_CloudRun avec son comportement standard.

Groupe 1 — Projet et identité​

VariableValeur par défautDescription
project_id(obligatoire)Projet Google Cloud cible.
regionus-central1Région pour le service et les ressources régionales.

Groupe 2 — Environnement de déploiement​

VariableValeur par défautDescription
tenant_iddemoSuffixe court qui rend les noms de ressources uniques par environnement.
support_users[]Adresses e-mail autorisées à accéder au projet et aux alertes de surveillance.
resource_labels{}Étiquettes appliquées à toutes les ressources.

Groupe 3 — Identité de l'application​

VariableValeur par défautDescription
application_nameonlyofficeNom de base des ressources. Ne pas modifier après le premier déploiement.
display_nameONLYOFFICE Document ServerNom lisible par l'homme affiché dans la console.
description(défini)Description du service.
application_versionlatestTag de l'image Document Server ; latest est épinglé à 8.3.3 au moment de la construction via l'ARG de construction ONLYOFFICE_VERSION.

Groupe 4 — Exécution et mise à l'échelle​

VariableValeur par défautDescription
deploy_applicationtrueDéfinissez false pour provisionner uniquement l'infrastructure.
container_image_sourcecustomToujours personnalisé — enveloppe l'image Docker Hub onlyoffice/documentserver avec le point d'entrée cloud.
container_image""Laissez vide pour utiliser l'image personnalisée construite.
cpu_limit2000mCPU par instance.
memory_limit4GiMémoire par instance ; la pile intégrée nécessite au moins 4 Gio.
cpu_always_allocatedfalseFacturation axée sur les coûts, basée sur les requêtes. Compromis : la chaleur du cache de documents et la file d'attente de conversion RabbitMQ interne se réinitialisent au démarrage à froid. Définissez true (+ min_instance_count >= 1) pour un éditeur toujours chaud.
min_instance_count / max_instance_count0 / 5Limites de répliques de pod/instance.
container_port80Le nginx intégré de Document Server écoute sur le port 80.
execution_environmentgen2Gen2 requis pour les montages NFS et GCS Fuse.
timeout_seconds300Durée maximale de la requête (0–3600 secondes).
enable_cloudsql_volumetrueProxy d'authentification Cloud SQL pour les connexions socket.
enable_image_mirroringtrueToujours vrai — met en miroir l'image de base Docker Hub dans Artifact Registry avant la construction personnalisée.
container_build_configconstruire l'image wrapperConfiguration Dockerfile/build-arg ; build_args définit ONLYOFFICE_VERSION (voir Vue d'ensemble).
traffic_split[]Répartir le trafic entre les révisions pour les déploiements progressifs.
container_protocolhttp1Version du protocole HTTP.
cloudsql_volume_mount_path/cloudsqlRépertoire du socket du proxy d'authentification.
additional_services / additional_containers[]Non utilisé par ce module — inerte sauf configuration explicite.
max_revisions_to_retain7Déclaré pour la parité de convention ; non référencé par le déploiement de ce module.

Groupe 5 — Accès et contrôle d'ingress​

VariableValeur par défautDescription
ingress_settingsallConservez all à moins que tous les appelants de l'API Document Server ne soient à l'intérieur du VPC.
vpc_egress_settingPRIVATE_RANGES_ONLYAcheminer uniquement le trafic RFC 1918 via le VPC.
enable_iapfalseExiger la connexion Google. Bloque les appels API de l'application hôte si activé.
iap_authorized_users / iap_authorized_groups[]Qui peut accéder via IAP.
network_name""Réseau VPC à utiliser ; découvre automatiquement un seul réseau géré par Services_GCP.

Groupe 6 — Variables d'environnement et secrets​

VariableValeur par défautDescription
environment_variables{}Paramètres supplémentaires non secrets. DB_TYPE, JWT_ENABLED, JWT_HEADER, JWT_IN_BODY, WOPI_ENABLED sont définis automatiquement — ne pas écraser JWT_ENABLED/JWT_HEADER/JWT_IN_BODY ici.
secret_environment_variables{}Mappage de variable d'environnement → nom de secret Secret Manager.
explicit_secret_values{}Valeurs sensibles brutes écrites directement dans Secret Manager au moment de la planification.
secret_propagation_delay30Secondes à attendre après la création du secret avant de continuer.
secret_rotation_period2592000sFréquence de notification de rotation de Secret Manager.
module_writable_secret_ids{}Non utilisé par ce module (aucun hook post-installation n'écrit les secrets en retour).

Groupe 7 — Sauvegarde et restauration​

VariableValeur par défautDescription
backup_schedule0 2 * * *Cron de sauvegarde automatisée (UTC).
backup_retention_days7Rétention ; augmenter pour la production/conformité.
enable_backup_import / backup_source / backup_file / backup_formatoptions de restaurationRestaurer à partir d'une sauvegarde lors du déploiement.

Groupe 8 — CI/CD et Binary Authorization​

Intégration standard App_CloudRun Cloud Build / Cloud Deploy — voir App_CloudRun. Entrées clés : enable_cicd_trigger, github_repository_url, github_token, enable_cloud_deploy, enable_binary_authorization.

Groupe 9 — Scripts SQL personnalisés​

enable_custom_sql_scripts, custom_sql_scripts_bucket, custom_sql_scripts_path, custom_sql_scripts_use_root — exécutez du SQL à partir d'un bucket GCS après le provisionnement. Non utilisé par le déploiement OnlyOffice par défaut (l'installation du schéma est gérée par le Document Server lui-même). Voir App_CloudRun.

Groupe 10 — Équilibreur de charge, CDN et rétention d'images​

VariableValeur par défautDescription
enable_cloud_armorfalseProvisionner un équilibreur de charge HTTPS global + Cloud Armor WAF.
admin_ip_ranges[]Plages CIDR exemptées des règles WAF.
application_domains[]Noms de domaine personnalisés pour l'équilibreur de charge HTTPS.
enable_cdnfalseActiver Cloud CDN sur le backend de l'équilibreur de charge HTTPS.
max_images_to_retain / delete_untagged_images / image_retention_days(défini)Politique de nettoyage d'Artifact Registry.

Groupe 11 — Stockage et système de fichiers​

VariableValeur par défautDescription
create_cloud_storagetrueRégit à la fois le bucket storage déclaré par Common et la liste storage_buckets propre à ce module. Par défaut true ici (contrairement à false de GKE) puisque Cloud Run n'a pas d'option de persistance PVC de bloc.
storage_buckets[{ name_suffix = "data" }]Bucket(s) GCS supplémentaire(s) au-delà du bucket storage auto-provisionné.
enable_nfstrueActivé par défaut — stockage partagé des pièces jointes et source d'hôte Redis de repli.
nfs_mount_path/opt/onlyoffice/storageChemin de montage à l'intérieur du conteneur.
nfs_instance_name / nfs_instance_base_name"" / app-nfsVM NFS existante à utiliser, ou nom de base pour une VM intégrée.
gcs_volumes[]Montages de volume GCS Fuse (nécessite gen2).
manage_storage_kms_iam / enable_artifact_registry_cmekfalseOptions CMEK.

Groupe 12 — Backend de base de données​

VariableValeur par défautDescription
database_typePOSTGRES_15Obligatoire — une garde au moment de la planification (validation.tf) rejette tout sauf POSTGRES_13/14/15/NONE. MySQL n'est pas pris en charge.
db_nameonlyofficeNom de la base de données PostgreSQL. Immuable après le premier déploiement.
db_useronlyofficeUtilisateur de la base de données de l'application. Mot de passe généré automatiquement dans Secret Manager.
database_password_length32Longueur du mot de passe généré (16–64).
enable_auto_password_rotation / rotation_propagation_delay_secdésactivéRotation du mot de passe de la base de données.
application_database_name / application_database_usercrappdb / crappuserMiroir de parité de la fondation uniquement — ce module connecte la base de données via db_name/db_user ci-dessus, pas ceux-ci ; inerte sauf si le module est recâblé.

Groupe 13 — Jobs et tâches planifiées​

VariableValeur par défautDescription
initialization_jobs[]Laissez vide pour utiliser le job db-init intégré (crée le rôle/la base de données/les autorisations ; le Document Server installe son propre schéma).
cron_jobs[]Non utilisé — OnlyOffice n'a pas de tâches récurrentes planifiées par la plateforme.

Groupe 14 — Observabilité et santé​

VariableValeur par défautDescription
startup_probeHTTP /healthcheck, délai 90s, période 15s, 40 échecsBudget généreux au premier démarrage pour la lourde pile intégrée.
liveness_probeHTTP /healthcheck, délai 120s, période 30s, 3 échecsSonde de vivacité.
startup_probe_config / health_check_configmême chemin, forme structuréeDéfinitions de sondes de niveau de service alternatives ; startup_probe/liveness_probe prennent effet par défaut.
uptime_check_config{ enabled=false, path="/healthcheck" }Vérification de disponibilité Cloud Monitoring ; désactivée par défaut.
alert_policies[]Stratégies d'alerte métrique.

Groupe 21 — Cache et file d'attente Redis​

VariableValeur par défautDescription
enable_redistrueObligatoire — une garde au moment de la planification rejette false.
redis_host""Laissez vide pour utiliser l'IP Redis de la VM NFS colocalisée (nécessite enable_nfs = true).
redis_port6379Port Redis.
redis_auth""Mot de passe d'authentification Redis facultatif (sensible).

Groupe 22 — VPC Service Controls et journalisation d'audit​

VariableValeur par défautDescription
enable_vpc_scfalseAppliquer un périmètre VPC-SC (nécessite organization_id).
vpc_cidr_ranges / vpc_sc_dry_run(défini)CIDR de niveau d'accès / mode simulation.
enable_audit_loggingfalseJournaux d'audit Cloud détaillés.

5. Sorties​

Retournées lors d'un déploiement réussi — le moyen le plus rapide de localiser et d'explorer les ressources en cours d'exécution.

SortieDescription
service_nameNom du service Cloud Run.
service_urlURL run.app par défaut du service.
service_locationRégion dans laquelle le service s'exécute.
stage_servicesURL de service spécifiques à l'étape (Cloud Deploy).
load_balancer_ip / load_balancer_urlIP / URL de l'équilibreur de charge HTTPS externe (lorsqu'activé).
database_instance_nameNom de l'instance Cloud SQL.
database_name / database_userNom / utilisateur de la base de données de l'application.
database_password_secretSecret Manager contenant le mot de passe de la base de données.
database_host / database_portPoint de terminaison / port de la base de données.
storage_bucketsBuckets Cloud Storage créés.
network_name / network_exists / regionsRéseau VPC, présence, régions.
container_image / container_registryImage déployée et dépôt Artifact Registry.
monitoring_enabled / monitoring_notification_channels / uptime_check_namesStatut de la surveillance, canaux, tests de disponibilité.
initialization_jobsNoms des jobs de configuration (db-init).
deployment_id / tenant_id / resource_prefixIdentifiants de nommage.
project_id / project_numberIdentifiants du projet.
cicd_enabled / github_repository_url / github_repository_owner / github_repository_name / cicd_configurationStatut et détails CI/CD.
artifact_registry_repository / cloudbuild_trigger_name / cloudbuild_trigger_idRegistre et déclencheur de build.
vpc_sc_enabled / vpc_sc_perimeter_name / vpc_sc_dry_run_modeStatut VPC-SC.
audit_logging_enabled / artifact_registry_cmek_enabledJournalisation d'audit et statut CMEK.

6. Pièges de configuration et valeurs par défaut judicieuses​

Risque : Critique (perte de données / panne / sécurité) — Élevé (service dégradé) — Moyen (coût ou dégradation partielle) — Faible (mineur).

Validation héritée au moment du plan. Ce module transmet sa configuration au moteur de base App_CloudRun, qui valide les valeurs et les combinaisons au moment du plan. OnlyOffice superpose en outre ses propres protections inter-variables dans validation.tf : database_type PostgreSQL uniquement, enable_redis obligatoire, couplage redis_host/enable_nfs, min_instance_count <= max_instance_count, et cohérence enable_cloudsql_volume vs database_type = "NONE". Une configuration invalide fait échouer le plan avec une erreur claire et nommée avant la création de toute ressource, de sorte que la plupart des erreurs ci-dessous sont détectées en amont plutôt qu'à l'apply ou à l'exécution.

ParamètreValeur judicieuseRisqueConséquence si incorrect
database_typePOSTGRES_15 (ou 13/14)CritiqueTout autre moteur est rejeté au moment du plan — MySQL n'est pas pris en charge par Document Server.
enable_redistrueCritiqueUne protection au moment du plan rejette false — sans Redis partagé, l'état de session/édition ne peut pas être coordonné entre les instances.
redis_host / enable_nfsLaisser redis_host vide uniquement avec enable_nfs = trueCritiqueUn redis_host vide avec enable_nfs = false échoue au moment du plan — il n'y a pas d'hôte Redis à résoudre.
JWT_SECRET (auto-généré)Ne jamais modifier après l'existence d'intégrationsCritiqueLe faire pivoter rompt chaque application hôte (Nextcloud/ownCloud/etc.) intégrant l'éditeur jusqu'à ce que toutes soient mises à jour avec la nouvelle valeur.
db_name / db_userDéfinir une foisCritiqueImmuable après le premier déploiement ; le renommage recrée la base de données/l'utilisateur et orpheline toutes les données.
enable_backup_importfalse sauf restaurationCritiqueL'activation sans sauvegarde valide fait échouer le job d'importation.
memory_limit4GiÉlevéLa pile Postgres-client/Redis-client/RabbitMQ/nginx/converter fournie sous supervisord est lourde ; un sous-dimensionnement risque un OOM pendant le démarrage ou la conversion de documents.
ingress_settingsall (sauf si tous les appelants sont dans le VPC)ÉlevéL'API de Document Server est normalement appelée par le backend d'une application hôte ; bloquer ce trafic rompt chaque intégration d'éditeur intégré.
enable_iapuniquement lorsqu'aucune application hôte externe n'appelle l'APIÉlevéIAP bloque toutes les requêtes non authentifiées, y compris les appels d'API Document Server de l'application hôte.
enable_cloudsql_volumetrue sauf database_type = "NONE"ÉlevéUne protection au moment du plan rejette la combinaison enable_cloudsql_volume = true avec database_type = "NONE" — le sidecar Auth Proxy n'aurait aucune instance à laquelle se connecter.
cpu_always_allocatedfalse (coût d'abord) ou true pour un éditeur toujours chaudMoyenAvec false + mise à l'échelle à zéro, le cache de documents et la file d'attente de conversion interne de RabbitMQ se réinitialisent à chaque démarrage à froid, ajoutant de la latence à la prochaine session d'édition.
min_instance_count1 pour éviter les démarrages à froid sur les sessions d'édition activesMoyenLa mise à l'échelle à zéro (0) ajoute une latence de première requête à l'échelle de la sonde de démarrage après l'inactivité, ressentie par chaque collaborateur ouvrant un document.
create_cloud_storage / storage_bucketslaisser les valeurs par défaut sauf si la persistance doit être ajustéeMoyenLa définition de create_cloud_storage = false supprime également le bucket storage déclaré en commun, car les deux sont contrôlés par le même drapeau.
backup_retention_days7 (augmenter pour la production)MoyenTrop court pour la rétention de conformité.
enable_cloud_armoractiver pour la productionMoyenL'API Document Server est publiquement accessible sans protection WAF.
ONLYOFFICE_VERSION ARG de build (Dockerfile)Mettre à jour uniquement après avoir confirmé que le patch de la porte de disponibilité sed/grep correspond toujours à la formulation en amontÉlevéLe patch sed -i du Dockerfile à run-document-server.sh's waiting_for_connection() (faisant en sorte que le répertoire de socket Cloud SQL DB_HOST court-circuite la vérification nc -z) est protégé par une assertion grep -q au moment du build. Si une mise à jour de version modifie le texte exact du script en amont, le Cloud Build échoue bruyamment à cette étape — la solution consiste à mettre à jour le modèle sed dans modules/OnlyOffice_Common/scripts/Dockerfile, et non à ignorer la vérification. Non patchée, l'image du fournisseur reste bloquée indéfiniment sur Cloud Run (répétant Waiting for connection to the /cloudsql/... host on port 5432 dans Cloud Logging) car nc ne peut jamais résoudre un répertoire de socket Unix comme hôte TCP ; GKE n'est pas affecté car son sidecar Auth Proxy écoute sur un véritable hôte TCP 127.0.0.1.

Pour le comportement de base référencé partout — identité de service, mise à l'échelle et concurrence, ingress et équilibrage de charge, CI/CD, Cloud Armor, IAP, Binary Authorization, VPC-SC, sauvegardes et mise en miroir d'images — voir App_CloudRun. La configuration d'application spécifique à OnlyOffice partagée avec la variante GKE — le secret JWT, le bootstrap de la base de données, l'image du conteneur et le point d'entrée, les paramètres d'application principaux et le comportement de la sonde de santé — est décrite dans OnlyOffice_Common.

Need RAD to do something it does not do yet? Request it on the roadmap, or vote on what is already there.