Skip to main content

Certification track: AI Tooling

Dify on GKE Autopilot

Dify on GKE Autopilot

Dify is an open-source LLM application development platform for building production-grade AI applications with a visual workflow builder, RAG pipeline, agent framework, multi-model management, and built-in observability. This module deploys Dify on GKE Autopilot on top of the App_GKE foundation, which provisions and manages the shared Google Cloud and Kubernetes infrastructure.

This guide focuses on the cloud services Dify uses and how to explore and operate them from the Google Cloud Console and the command line. For the mechanics that are common to every GKE application — Workload Identity, ingress, autoscaling, CI/CD, Cloud Armor, IAP, Binary Authorization, VPC Service Controls, backups, and the deployment lifecycle — refer to the App_GKE foundation guide rather than repeating them here.


1. Overview

Dify runs as a Python/Flask API container (with an embedded Celery worker under supervisord) plus a separate Next.js web frontend. The deployment wires together a focused set of Google Cloud services:

CapabilityGoogle Cloud serviceNotes
ComputeGKE AutopilotAPI+worker pod (2 vCPU / 4 GiB by default) + web frontend pod, horizontally autoscaled
DatabaseCloud SQL for PostgreSQL 15Required — pgvector extension enabled for vector storage
Vector storepgvector (in-database)Reuses the Cloud SQL instance; no separate vector database needed
Shared filesFilestore (NFS)Shared Redis host co-location; NFS VM also used for task state
Object storageCloud StorageA dedicated dify-storage bucket for uploaded files and assets
Cache & task queueRedisRequired for Celery broker/backend and SSE/WebSocket LLM streaming
SecretsSecret ManagerAuto-generated SECRET_KEY and database password
IngressCloud Load BalancingExternal LoadBalancer, optional custom domain + managed certificate

Sensible defaults worth knowing up front:

  • PostgreSQL 15 is mandatory. MySQL and NONE are not supported; Dify requires PostgreSQL for all metadata, workflow state, and user accounts.
  • pgvector is always enabled. The vector extension is installed on the Cloud SQL instance automatically, making the same database instance the vector store — no extra service required.
  • Redis is required. Celery (workflow execution, document indexing, async LLM calls) and the SSE/WebSocket event bus both depend on Redis. Disabling it breaks all background processing.
  • NFS is enabled by default. The NFS server VM hosts the Redis process when no external Redis host is set.
  • A web frontend is deployed automatically. A langgenius/dify-web Deployment is wired to the API service URL — you do not need to configure it separately.
  • SECRET_KEY is auto-generated and stored in Secret Manager; it signs Dify sessions and must never be changed after first deployment.
  • Database migrations run on every pod start (via MIGRATION_ENABLED=true), so version upgrades apply schema changes automatically.

2. Google Cloud Services & How to Explore Them

All commands assume you have run gcloud container clusters get-credentials <cluster> --region <region> --project <project> and that PROJECT, REGION, and NAMESPACE are set. The namespace and other identifiers are reported in the deployment Outputs.

A. GKE Autopilot — the Dify workload

Dify runs two Autopilot Deployments: the API+worker pod (Flask/gunicorn + Celery via supervisord) and the web frontend (Next.js). Horizontal Pod Autoscaling sizes each Deployment between the minimum and maximum replica counts.

  • Console: Kubernetes Engine → Workloads → select the Dify API or web workload to see pods, events, and resource usage. Kubernetes Engine → Services & Ingress shows the external IP.
  • CLI:
    kubectl get pods,svc,hpa -n "$NAMESPACE"
    kubectl logs -n "$NAMESPACE" deploy/<service-name> --tail=100
    kubectl describe hpa -n "$NAMESPACE"

See App_GKE for how Autopilot, scaling, and the workload type (Deployment vs StatefulSet) are managed.

B. Cloud SQL for PostgreSQL 15

Dify stores all application data (workflows, knowledge bases, user accounts, API keys) in a managed Cloud SQL for PostgreSQL 15 instance. Pods connect privately through the Cloud SQL Auth Proxy sidecar over a Unix socket — no public IP is exposed. On first deploy an initialization Job creates the application database and user. The pgvector extension is installed automatically so the same instance serves as the vector store.

  • Console: SQL → select the instance for connections, backups, flags, and metrics.
  • CLI:
    gcloud sql instances list --project "$PROJECT"
    gcloud sql instances describe <instance-name> --project "$PROJECT"
    gcloud sql connect <instance-name> --user=<db-user> --project "$PROJECT"

The instance name, database name, user, and the Secret Manager secret holding the password are all surfaced in the Outputs. For the connection model, automated backups, and password rotation, see App_GKE.

C. Filestore (NFS) and Cloud Storage

A Filestore (NFS) share is mounted into every pod. The NFS server VM also runs the Redis process used as the Celery broker when no external Redis host is configured. A dedicated Cloud Storage bucket (dify-storage) is provisioned for uploaded files and assets; Dify's google-storage driver accesses it via Workload Identity — no service account key file is needed.

  • Console: Filestore → Instances for the NFS share; Cloud Storage → Buckets.
  • CLI:
    gcloud filestore instances list --project "$PROJECT"
    gcloud storage buckets list --project "$PROJECT"
    gcloud storage ls gs://<dify-storage-bucket>/
    kubectl exec -n "$NAMESPACE" deploy/<service-name> -- df -h | grep -i nfs

See App_GKE for NFS provisioning, GCS Fuse, and CMEK options.

D. Redis — Celery and event bus

Redis is required for three functions in Dify:

RoleRedis DBPurpose
Celery broker & backenddb 1Queues and tracks all background tasks (LLM inference, document indexing)
Event busdb 0SSE/WebSocket streaming for real-time LLM output
General cachedb 0Application caching

When no external Redis host is configured, the NFS server VM IP is used as the Redis endpoint. For production, point redis_host at a dedicated Memorystore for Redis instance.

  • Console: Memorystore → Redis (if using a managed instance).
  • CLI:
    redis-cli -h <redis-host> ping
    redis-cli -h <redis-host> info keyspace

E. Secret Manager

The Dify SECRET_KEY (used for JWT signing and session encryption) and the database password are stored as Secret Manager secrets and injected into pods at runtime; plaintext never appears in pod specs. The SECRET_KEY is generated once and must not be rotated while the deployment is running — all pods must share the same value.

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

The database password secret name is in the Outputs. See App_GKE for the Secret Store CSI integration and rotation.

F. Networking & ingress

By default the Dify service is exposed through an external Cloud Load Balancing IP. A custom domain with a Google-managed certificate can be enabled, and a static IP can be reserved so the address survives redeploys.

  • Console: Network services → Load balancing; VPC network → IP addresses.
  • CLI:
    kubectl get ingress,svc -n "$NAMESPACE"
    gcloud compute addresses list --project "$PROJECT"

See App_GKE for custom domains, Cloud CDN, and static IP details.

G. Cloud Logging & Monitoring

Pod stdout/stderr flow to Cloud Logging; GKE and Cloud SQL metrics flow to Cloud Monitoring. Optional uptime checks and alert policies are available.

  • Console: Logging → Logs Explorer; Monitoring → Dashboards / Alerting.
  • CLI:
    gcloud logging read 'resource.type="k8s_container" AND resource.labels.namespace_name="'"$NAMESPACE"'"' \
    --project "$PROJECT" --limit 50

3. Dify Application Behaviour

  • First-deploy database setup. An initialization Job (db-init) connects to Cloud SQL via the Auth Proxy and idempotently creates the Dify database user and database. It runs automatically and is safe to re-run.
  • Migrations on start. Each pod runs Dify's Flask-Migrate database migrations on startup (MIGRATION_ENABLED=true), so upgrading the application version applies schema changes automatically. No separate migration job is needed.
  • API + worker in one pod. The custom container wraps langgenius/dify-api with supervisord. Both the gunicorn API server and the Celery worker run inside the same pod — they share CPU and memory allocation. Size accordingly: 2 vCPU and 4 GiB is the recommended minimum.
  • Web frontend. A langgenius/dify-web Deployment is deployed automatically and wired to the API service URL. Access Dify through the web service external IP or the web_url output.
  • LLM provider API keys. Provider keys (OpenAI, Anthropic, etc.) are configured per-workspace via the Dify web console and stored in the application database. Use secret_environment_variables only for environment-level configuration that cannot be set in the UI.
  • CORS. WEB_API_CORS_ALLOW_ORIGINS and CONSOLE_CORS_ALLOW_ORIGINS default to "*". Restrict to your domain via environment_variables in production.
  • Health path. Readiness and liveness probes target /health with a 30-second initial delay to allow the API server and database migrations to complete on first boot.

4. Configuration Variables

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

Group 1 — Project & Identity

VariableDefaultDescription
project_id(required)Target Google Cloud project.
regionus-central1Region for the workload and regional resources.

Group 2 — Deployment Environment

VariableDefaultDescription
tenant_deployment_iddemoShort suffix that makes resource names unique per environment.
support_users[]Emails granted project access and monitoring alerts.
resource_labels{}Labels applied to all resources for cost and ownership tracking.

Group 3 — Application Identity

VariableDefaultDescription
application_namedifyBase name for resources. Do not change after first deploy.
display_nameDify - LLM Application PlatformFriendly name shown in the Console.
description(set)Workload description annotation.
application_version0.15.0Dify image version tag; applies to both API and web containers. Pin to a specific version in production.

Group 4 — Runtime & Scaling

VariableDefaultDescription
deploy_applicationtrueSet false to provision infrastructure only.
cpu_limit2000mCPU per pod; 2 vCPU minimum — gunicorn and Celery share this allocation.
memory_limit4GiMemory per pod; 4 GiB recommended for LLM workflow caching and document processing.
min_instance_count1Minimum replicas. Keep ≥ 1 so the Celery worker maintains its Redis broker connection.
max_instance_count3Maximum replicas (autoscaler ceiling).
container_port5001Dify API server listens on port 5001.
enable_cloudsql_volumetrueCloud SQL Auth Proxy sidecar for Unix socket connections. Required for database connectivity.
enable_vertical_pod_autoscalingfalseVPA tunes resource requests automatically; enabling it disables HPA.
enable_pod_disruption_budgetfalseCreates a PodDisruptionBudget for minimum availability during node maintenance.
pdb_min_available1Minimum pods available during disruptions.

Group 5 — Environment Variables & Secrets

VariableDefaultDescription
environment_variables{}Extra non-secret settings. Use to override WEB_API_CORS_ALLOW_ORIGINS, LOG_LEVEL, etc.
secret_environment_variables{}Map of env var → Secret Manager secret name. Use for LLM provider API keys.

Group 6 — GKE Backend & Cluster

VariableDefaultDescription
service_typeLoadBalancerHow the Service is exposed.
session_affinityClientIPSticky routing — recommended for Dify's session state.
workload_typenullAuto-resolves to StatefulSet when per-pod storage is enabled.
network_tags['nfsserver']Node/pod tags; nfsserver is required for NFS connectivity.
gke_cluster_name""GKE cluster name. Leave empty to auto-discover.
namespace_name""Kubernetes namespace. Auto-generated when empty.
termination_grace_period_seconds60Seconds Kubernetes waits after SIGTERM before force-killing.

Group 7 — StatefulSet Configuration

VariableDefaultDescription
stateful_pvc_enablednullEnable per-pod PVCs. Setting true auto-selects StatefulSet workload type.
stateful_pvc_size10GiStorage size for each PVC.
stateful_pvc_mount_path/dataContainer path where the per-pod PVC is mounted.
stateful_pvc_storage_classstandard-rwoKubernetes StorageClass for PVC provisioning.

Group 10 — Observability & Health

VariableDefaultDescription
startup_probe_config / startup_probeHTTP /health, 30 s delayStartup probe — container receives no traffic until /health returns 200.
health_check_config / liveness_probeHTTP /healthLiveness probe.
uptime_check_configdisabledOptional Cloud Monitoring uptime check.
alert_policies[]Optional metric alert policies.

Group 11 — Jobs & Scheduled Tasks

VariableDefaultDescription
initialization_jobs[]Leave empty to use the built-in db-init job. Provide a non-empty list to replace it entirely.
cron_jobs[]Scheduled Kubernetes CronJobs.
additional_services[]Additional Kubernetes Deployments alongside Dify (web frontend is wired automatically).

Group 12 — CI/CD & GitHub Integration

Standard App_GKE Cloud Build / Cloud Deploy integration — see App_GKE. Key inputs: enable_cicd_trigger, github_repository_url, github_token, enable_cloud_deploy, enable_binary_authorization.

Group 13 — Filesystem (NFS)

VariableDefaultDescription
enable_nfstrueShared Filestore volume; also provides the default Redis host when no external Redis is set.
nfs_mount_path/mnt/nfsMount path inside the container.
nfs_instance_name""Name of an existing NFS GCE VM. Leave empty to auto-discover.
nfs_instance_base_nameapp-nfsBase name for an inline NFS GCE VM when none exists.

Group 14 — Cloud Storage & Artifact Registry

VariableDefaultDescription
create_cloud_storagetrueProvision additional GCS buckets. The dify-storage bucket is always provisioned by Dify_Common.
storage_buckets[{ name_suffix = "data" }]Additional buckets beyond the auto-provisioned storage bucket.
gcs_volumes[]GCS Fuse mounts via the CSI driver.
manage_storage_kms_iam / enable_artifact_registry_cmekfalseCMEK options.

Group 16 — Database Backend

VariableDefaultDescription
db_namedify_dbPostgreSQL database name. Immutable after first deploy.
db_userdify_userApplication user. Immutable after first deploy.
database_password_length32Generated password length (16–64).
enable_auto_password_rotationfalseZero-downtime DB password rotation.

Group 17 — Backup & Maintenance

VariableDefaultDescription
backup_schedule0 2 * * *Automated backup cron (UTC).
backup_retention_days7Retention; raise to 30–90 for production/compliance.
enable_backup_import / backup_source / backup_urirestore optionsRestore from a backup on deploy.

Group 18 — Custom SQL Scripts

enable_custom_sql_scripts, custom_sql_scripts_bucket, custom_sql_scripts_path, custom_sql_scripts_use_root — run SQL from a GCS bucket after provisioning. See App_GKE.

Group 19 — Custom Domain, Static IP & Networking

VariableDefaultDescription
enable_custom_domaintrueProvision Ingress for custom hostnames + managed certificate.
application_domains[]Hostnames to serve.
reserve_static_iptrueStable external IP across redeploys.

Group 20 — Identity-Aware Proxy (IAP)

VariableDefaultDescription
enable_iapfalseRequire Google sign-in in front of Dify. Requires enable_custom_domain = true.
iap_authorized_users / iap_authorized_groups[]Who may access.
iap_oauth_client_id / iap_oauth_client_secret""Required when IAP is enabled (sensitive).

Group 21 — Redis Cache

VariableDefaultDescription
enable_redistrueRequired. Enables Redis for Celery task queue and SSE/WebSocket streaming.
redis_host""Leave empty to use the NFS server IP; set explicitly for an external Memorystore instance.
redis_port6379Redis port.
redis_auth""Optional Redis auth password (sensitive).

Group 22 — VPC Service Controls & Audit Logging

VariableDefaultDescription
enable_vpc_scfalseEnforce a VPC-SC perimeter (requires organization_id).
vpc_cidr_ranges / vpc_sc_dry_run(set)Access level CIDRs / dry-run mode.
enable_audit_loggingfalseDetailed Cloud Audit Logs.

5. Outputs

These values are returned on a successful deployment and are the quickest way to locate and explore the running resources.

OutputDescription
service_nameKubernetes Service name (Dify API).
namespaceNamespace the workload runs in.
service_cluster_ipIn-cluster ClusterIP of the API service.
stage_service_cluster_ipsMap of ClusterIPs for stage-specific services (Cloud Deploy).
service_external_ipExternal LoadBalancer IP (when a static IP is reserved).
web_urlURL of the Dify web frontend (use this to open the browser UI).
database_instance_nameCloud SQL instance name.
database_nameApplication database name.
database_userApplication database user.
database_password_secretSecret Manager secret holding the DB password.
database_host / database_portDB endpoint (127.0.0.1 via Auth Proxy) / port.
storage_bucketsCreated Cloud Storage buckets.
network_name / network_exists / regionsVPC network, presence, available regions.
container_image / container_registryDeployed image and Artifact Registry repo.
monitoring_enabled / monitoring_notification_channelsMonitoring status and channels.
initialization_jobs / db_import_jobNames of the setup and (optional) import jobs.
deployment_id / tenant_id / resource_prefixNaming identifiers.
project_id / project_numberProject identifiers.
cicd_enabled / cicd_configurationCI/CD status and details.
github_repository_url / github_repository_owner / github_repository_nameCI/CD repository details.
artifact_registry_repository / cloudbuild_trigger_name / cloudbuild_trigger_idRegistry and build trigger.
kubernetes_readyWhether the cluster and workload are ready.
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).

SettingSensible valueRiskConsequence if wrong
enable_redistrue (required)CriticalAll Celery tasks (workflow execution, document indexing, async LLM calls) fail silently without Redis.
enable_cloudsql_volumetrue (required)CriticalThe Auth Proxy sidecar is the only path to PostgreSQL; disabling it breaks all database connectivity.
SECRET_KEY (auto-generated)immutable once setCriticalAll pods must share the same key; rotating it logs out all users and invalidates active sessions.
db_name / db_userset onceCriticalImmutable after first deploy; renaming recreates the database and destroys data.
enable_backup_importfalse unless restoringCriticalEnabling without a valid backup_uri fails the import job.
enable_redis + enable_nfsboth true if no external RedisCriticalWithout NFS, there is no Redis host when redis_host is empty — Celery fails to start.
secret_environment_variables for LLM keysalways use secret refsCriticalPlain env vars expose API keys in pod specs visible via kubectl describe pod.
enable_redis + redis_hostcorrect hostHighIncorrect redis_host produces a malformed Celery broker URL; all async tasks queue indefinitely.
memory_limit4GiHighToo little memory causes OOM kills during document ingestion or LLM workflow caching.
min_instance_count1HighScale-to-zero causes cold starts and abandons in-flight Celery tasks.
timeout_seconds300 (raise for workflows)HighMulti-step workflows and RAG indexing can exceed 300 s; increase to 3600 for complex deployments.
WEB_API_CORS_ALLOW_ORIGINSrestrict in productionHighDefault "*" allows cross-origin requests from any domain.
application_versionpin to a specific versionMediumUnpinned versions risk unexpected schema migrations that break the application on redeploy.
enable_iap / enable_cloud_armorenable for productionMediumThe Dify console is publicly reachable without these controls.
backup_retention_days7 (raise for prod)MediumToo short for compliance retention.

For the foundation behaviour referenced throughout — IAM and Workload Identity, autoscaling, ingress and certificates, CI/CD, Cloud Armor, IAP, Binary Authorization, VPC-SC, backups, and image mirroring — see App_GKE. Dify-specific application configuration shared with the Cloud Run variant is described in Dify_Common.