Skip to main content

Monica on Google Cloud Run

Monica on Google Cloud Run

Monica is an open-source personal relationship management (PRM) application — a "personal CRM" for organising how you stay in touch with friends, family, and contacts. This module deploys Monica on Cloud Run v2 on top of the App_CloudRun foundation, which provisions and manages the shared Google Cloud infrastructure.

This guide focuses on the cloud services Monica uses and how to explore and operate them from the Google Cloud Console and the command line. For the mechanics common to every Cloud Run application — service identity, ingress and load balancing, scaling and concurrency, CI/CD, Cloud Armor, IAP, Binary Authorization, VPC Service Controls, backups, and the deployment lifecycle — refer to the App_CloudRun foundation guide rather than repeating them here.


1. Overview

Monica runs as a PHP/Laravel container (official Apache image) on Cloud Run v2. The deployment wires together a focused set of Google Cloud services:

CapabilityGoogle Cloud serviceNotes
ComputeCloud Run v2Apache/PHP service, 1 vCPU / 2 GiB by default, serverless autoscaling; scale-to-zero supported
DatabaseCloud SQL for MySQL 8.0Required — Monica is fixed to MySQL
Object storageCloud StorageA dedicated monica-uploads bucket for contact photos and documents
PersistenceNFS (enabled by default)Keeps Laravel's storage/ uploads durable across cold starts and revisions
CacheRedis (optional)Off by default; used for cache/session when enabled
SecretsSecret ManagerAuto-generated Laravel APP_KEY; database password
IngressCloud Run URL / Cloud Load BalancingDefault run.app URL; optional external HTTPS load balancer + custom domain

Sensible defaults worth knowing up front:

  • MySQL 8.0 is the fixed engine. database_type = "MYSQL_8_0" is set by the shared application layer; Monica does not run on PostgreSQL here.
  • The image is the official prebuilt monica:<version>. No Cloud Build step — container_image_source = "prebuilt" pulls the Apache variant from Docker Hub, which serves on port 80.
  • APP_KEY is generated automatically and stored in Secret Manager. It is a Laravel encryption key and must never be rotated after first boot — rotating it permanently corrupts every encrypted database field and invalidates all sessions.
  • Migrations run automatically on start. The image entrypoint runs php artisan migrate --force on every container start, so the schema is created and upgraded on boot (after the db-init job provisions the database and user).
  • Direct private-IP TCP to Cloud SQL by default. enable_cloudsql_volume = false on Cloud Run — Monica connects to MySQL over the instance private IP (the SnipeIT/Matomo Laravel-on-MySQL pattern), no Auth Proxy socket, no SSL required.
  • NFS is enabled by default (enable_nfs = true) so uploaded files in Laravel's storage/ directory survive cold starts and new revisions.
  • Scale-to-zero is enabled by default (min_instance_count = 0, max = 1). Cold starts add a few seconds of latency plus Apache/migration startup on the first request after idle; set min_instance_count = 1 to keep an instance warm.
  • APP_URL is set from the predicted service URL so Laravel builds correct absolute links and the / → setup/registration redirect resolves on the right host.

2. Google Cloud Services & How to Explore Them

All commands assume PROJECT and REGION are set. Service and resource names are reported in the deployment Outputs.

A. Cloud Run — the Monica service

Monica runs as a Cloud Run v2 service that autoscales by request load between the minimum and maximum instance counts. Each deployment creates an immutable revision; traffic can be split across revisions for safe rollouts.

  • Console: Cloud Run → select the service for revisions, traffic, logs, and metrics.
  • CLI:
    gcloud run services list --project "$PROJECT" --region "$REGION" --filter="metadata.name~monica"
    gcloud run services describe <service-name> --project "$PROJECT" --region "$REGION"
    gcloud run revisions list --service <service-name> --project "$PROJECT" --region "$REGION"

See App_CloudRun for scaling, concurrency, execution environment, and traffic splitting.

B. Cloud SQL for MySQL 8.0

Monica stores all application data (contacts, activities, reminders, journal entries, users) in a managed Cloud SQL for MySQL 8.0 instance. On Cloud Run the service connects over the instance private IP by default (enable_cloudsql_volume = false); no public IP is exposed. On first deploy the db-init Job creates the application database and user and grants privileges; the container's entrypoint then runs the Laravel migrations.

  • Console: SQL → select the instance for connections, backups, flags, metrics.
  • 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"

The instance name, database, user, and password secret are in the Outputs. See App_CloudRun for the connection model, backups, and password rotation.

C. Cloud Storage

A dedicated Cloud Storage bucket (suffix monica-uploads) is provisioned automatically for Monica's uploaded files (contact photos, documents). Additional buckets can be declared via storage_buckets.

  • Console: Cloud Storage → Buckets.
  • CLI:
    gcloud storage buckets list --project "$PROJECT"
    gcloud storage ls gs://<uploads-bucket>/ # bucket name is in the Outputs

See App_CloudRun for GCS Fuse and CMEK options.

D. Redis (optional cache)

Redis is disabled by default (enable_redis = false). When enabled, the foundation injects REDIS_HOST/REDIS_PORT; leaving redis_host empty while NFS is enabled uses the NFS server VM's IP as the Redis endpoint (the NFS VM co-hosts Redis).

  • Console: Memorystore → Redis (if using a managed instance).
  • CLI:
    redis-cli -h <redis-host> ping
    # Confirm the injected Redis env in the running revision:
    gcloud run services describe <service-name> --region "$REGION" \
    --format='value(spec.template.spec.containers[0].env)'

E. Secret Manager

One cryptographic secret is generated automatically and stored in Secret Manager: the Laravel APP_KEY (used for AES-256-CBC encryption of encrypted columns and for signing sessions/cookies). The database password is managed separately by the foundation.

  • Console: Security → Secret Manager.
  • CLI:
    gcloud secrets list --project "$PROJECT" --filter="name~monica-app-key"
    gcloud secrets versions access latest --secret=<secret-name> --project "$PROJECT"

See App_CloudRun for injection and rotation details.

F. Networking & ingress

The service is reachable at its run.app URL by default. An external HTTPS load balancer with a custom domain, Cloud CDN, and Cloud Armor can be layered on; ingress settings and VPC egress control connectivity.

  • Console: Cloud Run (service URL); Network services → Load balancing.
  • CLI:
    gcloud run services describe <service-name> --region "$REGION" --format='value(status.url)'
    gcloud compute addresses list --project "$PROJECT"

See App_CloudRun.

G. Cloud Logging & Monitoring

Container logs flow to Cloud Logging; Cloud Run and Cloud SQL metrics flow to Cloud Monitoring, with optional uptime checks and alert policies.

  • Console: Logging → Logs Explorer; Monitoring → Dashboards / Alerting.
  • CLI:
    gcloud run services logs read <service-name> --project "$PROJECT" --region "$REGION" --limit 50

3. Monica Application Behaviour

  • First-deploy database setup. An initialization Job runs db-init.sh using mysql:8.0-debian. It connects over the Cloud SQL socket (when mounted) or the private IP, and idempotently creates the application database and user, grants privileges, and verifies the app user can connect. The job is safe to re-run.
  • Migrations run automatically on start. The official Monica image's entrypoint runs php artisan migrate --force on every container start — there is no separate migration job. The schema is created on first boot (after db-init) and upgraded automatically when you bump application_version.
  • APP_KEY is immutable after first boot. It is generated once and written to Secret Manager. Changing it permanently corrupts all encrypted database fields and invalidates every session — only rotate during a planned maintenance window with a full data re-encryption plan.
  • First-run setup in the UI. Monica has no default credentials. Open the service URL: an unauthenticated visitor is redirected to the registration/setup page. The first account you create becomes the administrator. Register with admin@techequity.cloud for RAD deployments.
  • File uploads need persistence. Uploaded photos/documents live under Laravel's storage/. NFS is enabled by default so they survive cold starts and revisions; the monica-uploads GCS bucket is also provisioned. Disabling NFS risks losing uploaded files on the next cold start.
  • Health path. The startup probe is TCP on / (passes as soon as Apache binds the port) and the liveness probe is HTTP GET / (Monica's home page returns 200). Allow a generous first-boot window for Apache startup plus the initial php artisan migrate --force.
  • Inspect job execution:
    gcloud run jobs list --project "$PROJECT" --region "$REGION"
    gcloud run jobs executions list --job <db-init-job-name> --project "$PROJECT" --region "$REGION"

4. Configuration Variables

Variables are grouped exactly as they appear on the deployment platform. Only settings specific to or notable for Monica are listed; every other input is inherited from App_CloudRun with its standard behaviour.

Group 3 — Application Identity

VariableDefaultDescription
application_namemonicaBase name for resources. Do not change after first deploy.
display_name(set)Human-readable name shown in the Console.
application_versionlatestMonica image tag; pin to a specific release in production.

Group 4 — Runtime & Scaling

VariableDefaultDescription
deploy_applicationtrueSet false to provision infrastructure only.
container_image_sourceprebuiltPulls the official monica image directly — do not change to custom.
cpu_limit1000mCPU per instance (1 vCPU).
memory_limit2GiMemory per instance.
min_instance_count00 enables scale-to-zero; set 1 to avoid cold-start + migration latency.
max_instance_count1Single instance is sufficient for a personal CRM.
container_port80Monica's Apache image listens on port 80.
enable_cloudsql_volumefalseCloud Run connects to MySQL over private-IP TCP; the Auth Proxy socket is off.

Group 10 — Storage & Filesystem

VariableDefaultDescription
enable_nfstrueOn by default — persists Laravel storage/ uploads across cold starts/revisions.
nfs_mount_path/var/www/html/storageMount path inside the container.
create_cloud_storagetrueProvision the monica-uploads bucket (plus any in storage_buckets).
gcs_volumes[]Optional GCS Fuse volume mounts (requires gen2).

Group 12 — Database Backend

VariableDefaultDescription
database_typeMYSQL_8_0Fixed to MySQL 8.0.
db_namemonicaDatabase base name (tenant-prefixed at deploy). Immutable after first deploy.
db_usermonicaApplication database user base name. Password auto-generated in Secret Manager.

Group 14 — Observability & Health

VariableDefaultDescription
startup_probeTCP / 30s delay, 20 retriesPasses when Apache binds the port; generous window for first-boot migration.
liveness_probeHTTP / 300s delayMonica's home page returns 200.

Group 21/22 — Redis Cache

VariableDefaultDescription
enable_redisfalseEnable to add cache/session backing; injects REDIS_HOST/REDIS_PORT.
redis_host""Redis endpoint. Leave empty to use the NFS server IP (requires enable_nfs = true).
redis_port6379Redis port.

All other inputs follow standard App_CloudRun behaviour.


5. Outputs

Returned on a successful deployment — the quickest way to locate and explore the running resources.

OutputDescription
service_nameCloud Run service name.
service_urlDefault run.app URL of the service.
service_locationRegion the service runs in.
stage_servicesStage-specific service details (Cloud Deploy).
load_balancer_ip / load_balancer_urlExternal HTTPS load balancer IP / URL (when enabled).
database_instance_nameCloud SQL instance name.
database_name / database_userApplication database name / user.
database_password_secretSecret Manager secret holding the DB password.
database_host / database_portDB endpoint (private IP) / port.
storage_bucketsCreated Cloud Storage buckets (monica-uploads).
network_name / network_exists / regionsVPC network, presence, regions.
container_image / container_registryDeployed image and Artifact Registry repo.
monitoring_enabled / monitoring_notification_channels / uptime_check_namesMonitoring status, channels, uptime checks.
initialization_jobsNames of the setup jobs (db-init).
deployment_id / tenant_id / resource_prefixNaming identifiers.
project_id / project_numberProject identifiers.
cicd_enabled / github_repository_url / github_repository_owner / github_repository_name / cicd_configurationCI/CD status and details.
artifact_registry_repository / cloudbuild_trigger_name / cloudbuild_trigger_idRegistry and build trigger.
vpc_sc_enabled / vpc_sc_perimeter_name / vpc_sc_dry_run_modeVPC-SC status.
audit_logging_enabled / artifact_registry_cmek_enabledAudit logging and CMEK status.

6. Configuration Pitfalls & Sensible Defaults

Risk: Critical (data loss / outage / security) — High (service degraded) — Medium (cost or partial degradation) — Low (minor).

Inherited plan-time validation. This module passes its configuration through the App_CloudRun foundation engine, which validates values and combinations at plan time — a gen1 runtime with NFS/GCS mounts, an out-of-range redis_port/backup_retention_days, a database_type outside the supported set, IAP with no authorized identities. Invalid configuration fails the plan with a clear, named error before any resource is created, so most mistakes below are caught up front rather than at apply or runtime.

SettingSensible valueRiskConsequence if wrong
APP_KEY (auto-generated)Never rotate after first bootCriticalRotating it permanently corrupts every encrypted database field and invalidates all sessions.
db_name / db_userSet onceCriticalImmutable after first deploy; renaming recreates the DB/user and destroys all data.
database_typeMYSQL_8_0CriticalMonica is a MySQL app; a non-MySQL engine breaks the driver and migrations.
enable_nfstrueHighDisabling loses uploaded contact photos/documents on the next cold start or revision.
container_image_sourceprebuiltHighSetting custom points the service at an unbuilt Artifact Registry image (Image not found).
container_port80HighThe Apache image listens on 80; a mismatched port fails the startup probe.
APP_URL (auto-set)Actual service URLHighA wrong URL breaks absolute links and the / → setup/registration redirect (404 on the bad host).
enable_cloudsql_volumefalse (Cloud Run)MediumMonica connects over private-IP TCP; forcing the socket is unnecessary and can leave DB_HOST as a socket path the client mishandles.
min_instance_count0 (or 1 for warm)MediumScale-to-zero adds cold-start + Apache/migration latency on the first request after idle.
memory_limit2GiMediumTrimming too far risks PHP OOM during first-boot migrations and heavy pages.
enable_redisoff unless neededLowOptional cache/session backing; when enabled without a host and NFS off, the Redis endpoint is blank.

For the foundation behaviour referenced throughout — service identity, scaling and concurrency, ingress and load balancing, CI/CD, Cloud Armor, IAP, Binary Authorization, VPC-SC, backups, and image mirroring — see App_CloudRun. Monica-specific application configuration shared with the GKE variant is described in Monica_Common.