OnlyOffice on Cloud Run — Lab Guide

Overview

Estimated time: 45–90 minutes

An online office suite for collaborative real-time editing of documents, spreadsheets, and presentations. This lab takes you through the full operational lifecycle of the OnlyOffice on Cloud Run module on Google Cloud: deploy it, access and verify it, run it day-to-day, observe it, diagnose common problems, and tear it down.

The lab focuses on operating the Cloud Run module and the Google Cloud platform, not on OnlyOffice product features. For the complete list of provisioned services and every configuration input (organised by group), see the Configuration Guide — this lab deliberately does not duplicate that detail so it stays accurate over time.

Objectives

By the end of this lab you will be able to:

Deploy the module from the RAD platform and locate the resources it provisions.
Access and verify the running service.
Perform day-2 operations — inspect, scale, update, and manage secrets and storage.
Observe the service with Cloud Logging and Cloud Monitoring.
Diagnose and resolve the most common deployment and runtime issues.
Tear the deployment down cleanly.

Prerequisites

Services_GCP deployed in the target project (provides the VPC, Cloud SQL, Redis, Artifact Registry, and shared service accounts this module depends on).
A Google Cloud project with billing enabled.
gcloud CLI authenticated: gcloud auth login and gcloud auth application-default login.
Project Owner (or equivalent) IAM on the project.
RAD platform access with permission to deploy modules into the project.

Set these shell variables once; every task below reuses them:

export PROJECT="<your-gcp-project-id>"
export REGION="us-central1"          # the region you deploy into

Task 1 — Deploy the module [Automated]

Click Deploy in the RAD platform top navigation, open OnlyOffice (Cloud Run) from the Platform Modules list to start configuration, set project_id, and review the inputs. Configure only what you need — the Configuration Guide documents every input by group, with defaults. Review the estimated cost (if credits are enabled) and click Deploy, which opens the deployment status page with real-time logs.
The platform provisions the Cloud Run service, a Cloud SQL (PostgreSQL 15) database with its Secret Manager secrets, builds the container image, and runs a one-shot database-initialisation job. First deploys take roughly 20–35 minutes (Cloud SQL creation dominates).

When it completes, discover the resources with name-agnostic filters (so the commands keep working regardless of the deployment suffix):

SERVICE=$(gcloud run services list --project="$PROJECT" --region="$REGION" \
  --filter="metadata.name~onlyoffice" --format="value(metadata.name)" --limit=1)
SERVICE_URL=$(gcloud run services describe "$SERVICE" \
  --project="$PROJECT" --region="$REGION" --format="value(status.url)")
echo "Service: $SERVICE"
echo "URL:     $SERVICE_URL"

Task 2 — Access & verify [Manual]

Health check — confirm the service is up and the Document Server is ready:
```
curl -s "$SERVICE_URL/healthcheck"
```
Expected response: {"status":"pass"}. If the service returns a non-200 or the status field is not pass, the Document Server has not finished initialising — wait 1–2 minutes and retry.
JWT secret — OnlyOffice does not expose a browser admin UI. Integration is managed via a JWT secret stored in Secret Manager. Retrieve it for use in connected applications (e.g. Nextcloud, Seafile):
```
gcloud secrets list --project="$PROJECT" --filter="name~onlyoffice AND name~jwt"
SECRET=$(gcloud secrets list --project="$PROJECT" \
  --filter="name~onlyoffice AND name~jwt" --format="value(name)" --limit=1)
gcloud secrets versions access latest --secret="$SECRET" --project="$PROJECT"
```
Use this JWT value to configure the OnlyOffice integration in your document management application.

Task 3 — Operate & keep it running (Day-2) [Manual]

Inspect the service and its revisions (each deploy creates an immutable revision; traffic shifts to the newest healthy one):

gcloud run services describe "$SERVICE" --project="$PROJECT" --region="$REGION"
gcloud run revisions list --service="$SERVICE" --project="$PROJECT" --region="$REGION"

Scale by changing the min/max instance inputs and clicking Update on the deployment details page — the module owns the service spec, so scaling is a configuration change, not a manual gcloud edit (a manual edit would be reverted on the next apply).
Update the application version by changing the version input via Update on the deployment details page; a new image builds and a new revision rolls out.

Manage secrets and storage:

gcloud secrets list --project="$PROJECT" --filter="name~onlyoffice"

Open a database session for inspection or maintenance:

INSTANCE=$(gcloud sql instances list --project="$PROJECT" --format="value(name)" --limit=1)
gcloud sql connect "$INSTANCE" --user=onlyoffice --project="$PROJECT"

Task 4 — Observe: Logging & Monitoring [Manual]

Logs — from the CLI or the Logs Explorer:
```
gcloud run services logs read "$SERVICE" --project="$PROJECT" --region="$REGION" --limit=50
```
Logs Explorer filter: resource.type="cloud_run_revision" AND resource.labels.service_name="<service>".
Monitoring — open the Cloud Run dashboard for the service and review request count, request latency (P50/P95/P99), instance count (scaling behaviour), and CPU / memory utilisation. The module also provisions an uptime check; confirm it is green under Monitoring → Uptime checks, and review Alerting → Policies.

Task 5 — Troubleshoot & debug [Manual]

Durable techniques for the failure modes you are most likely to hit. These are platform-level diagnostics and do not change with OnlyOffice releases.

Revision unhealthy / service won't serve: inspect the latest revision and its logs for startup errors — OnlyOffice Document Server takes 60–90 seconds to initialise; check that /healthcheck eventually returns {"status":"pass"}.
```
gcloud run revisions list --service="$SERVICE" --project="$PROJECT" --region="$REGION"
gcloud run services logs read "$SERVICE" --project="$PROJECT" --region="$REGION" --limit=100
```
Database connection errors: confirm the Cloud SQL instance is RUNNABLE, the DB password secret exists, and the initialisation job completed successfully.

Initialisation job failed: list executions and read the failed one's logs:

gcloud run jobs executions list --job="${SERVICE}-db-init" \
  --project="$PROJECT" --region="$REGION"

Redis connection errors: confirm Redis is reachable and the Redis password secret exists.
JWT integration failures: verify the JWT secret value matches what is configured in the connected application. Retrieve the current value from Secret Manager as shown in Task 2.
Image build failed: review Cloud Build history for the failed build's log.
403 / permission errors: verify the runtime service account's IAM roles.

See the Configuration Guide's Configuration Pitfalls section for setting-specific gotchas.

Task 6 — Tear down [Automated]

On the Deployments page, open the deployment and click the Trash icon (Delete). Delete runs terraform destroy and is irreversible (the deployment record is retained for history). If a deployment is stuck and the RAD platform can no longer manage it (for example after manual changes that conflict with the Terraform state), use Purge instead — it removes the deployment from RAD's records without destroying the cloud resources (it makes RAD forget the project). This removes everything the module created — the Cloud Run service, Cloud SQL database, Secret Manager secrets, and Artifact Registry images. Resources owned by Services_GCP (the VPC, shared Cloud SQL, registry) are managed separately and are not removed here.

Summary

Task	Type	Outcome
1 — Deploy	Automated	Cloud Run service, Cloud SQL (PostgreSQL 15), Redis connection, Secret Manager secrets, and init job provisioned
2 — Access & verify	Manual	Health check at `/healthcheck` returns `{"status":"pass"}`; JWT secret retrieved from Secret Manager
3 — Operate	Manual	Inspect revisions, scale, update version, manage secrets/storage; open DB session
4 — Observe	Manual	Query Cloud Logging; review Cloud Monitoring metrics and uptime check
5 — Troubleshoot	Manual	Diagnose startup delays, DB connection issues, init job failures, Redis errors, and JWT integration problems
6 — Tear down	Automated	Delete (Trash) removes all module resources

By Dr Shiyghan Emmanuel Navti · Google Cloud certified: ACE · PCA · PCD · PDE · PSE · CDL

Overview​

Objectives​

Prerequisites​

Task 1 — Deploy the module [Automated]​

Task 2 — Access & verify [Manual]​

Task 3 — Operate & keep it running (Day-2) [Manual]​

Task 4 — Observe: Logging & Monitoring [Manual]​

Task 5 — Troubleshoot & debug [Manual]​

Task 6 — Tear down [Automated]​

Summary​