Skip to main content

Vikunja on GKE Autopilot — Lab Guide

📖 Configuration Guide

Overview​

Estimated time: 45–90 minutes

Vikunja is an open-source, self-hosted to-do and project management application with lists, kanban boards, gantt charts, reminders, and team sharing via a REST API and web UI. This lab takes you through the full operational lifecycle of the Vikunja on GKE Autopilot 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 GKE module and the Google Cloud platform, not on Vikunja 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.
  • Connect to the GKE cluster and access the running workload.
  • Perform day-2 operations — inspect, scale, update, and manage secrets and storage.
  • Observe the workload 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, GKE Autopilot cluster, Cloud SQL, Artifact Registry, and shared service accounts this module depends on).
  • A Google Cloud project with billing enabled.
  • gcloud CLI and kubectl installed; gcloud auth login and gcloud auth application-default login completed.
  • 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]​

  1. Click Deploy in the RAD platform top navigation, open Vikunja (GKE) 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.

  2. The platform deploys the workload into the GKE Autopilot cluster, provisions a Cloud SQL (PostgreSQL 15) database with its Secret Manager secrets (VIKUNJA_SERVICE_JWTSECRET and the database password), builds the custom container image (grafting a static busybox onto the scratch upstream image), and runs a one-shot database-initialisation job. First deploys take roughly 20–35 minutes (Cloud SQL creation dominates).

  3. Connect to the cluster and discover the namespace with name-agnostic filters:

    CLUSTER=$(gcloud container clusters list --project="$PROJECT" --format="value(name)" --limit=1)
    gcloud container clusters get-credentials "$CLUSTER" --region="$REGION" --project="$PROJECT"

    NS=$(kubectl get ns -o name | grep vikunja | head -1 | cut -d/ -f2)
    echo "Cluster: $CLUSTER   Namespace: $NS"
    kubectl get all -n "$NS"

Task 2 — Access & verify [Manual]​

  1. Confirm the workload is running and find its external address:

    kubectl get pods,svc -n "$NS"
    EXTERNAL_IP=$(kubectl get svc -n "$NS" \
      -o jsonpath='{.items[?(@.spec.type=="LoadBalancer")].status.loadBalancer.ingress[0].ip}')
    echo "External IP: $EXTERNAL_IP"

  2. Confirm the service is healthy. Vikunja exposes a public health endpoint that returns 200 once the server has bound its port and connected to PostgreSQL:

    curl -s "http://${EXTERNAL_IP}/health"   # expect a JSON object such as {"database":true,...}

  3. Open http://${EXTERNAL_IP} in a browser. On first visit Vikunja shows the login page — click Register and create the first account. The first registered account becomes the instance owner; there is no pre-seeded admin credential in Secret Manager. After the owner account is created, disable open registration by setting VIKUNJA_SERVICE_ENABLEREGISTRATION = "false" in environment_variables and applying it via Update.

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

  1. Inspect the workload — deployment, pods, and the pod disruption budget:

    kubectl get deploy,pods,pdb -n "$NS"
    kubectl describe deploy -n "$NS"

  2. Scale by changing the min/max instance inputs and clicking Update on the deployment details page — the module owns the workload spec, so scaling is a configuration change, not a manual kubectl scale (a manual edit would be reverted on the next apply). Note that Vikunja defaults to a single replica; it has no built-in coordination for multiple concurrent replicas.

  3. Update the application version by changing the version input in the RAD platform and applying it via Update; a new image builds and a rolling update replaces the pod. Vikunja runs any new schema migrations on startup.

  4. Manage secrets, storage, and jobs:

    kubectl get secrets -n "$NS"
    gcloud secrets list --project="$PROJECT" --filter="name~vikunja"
    kubectl get jobs -n "$NS"          # DB-init and any scheduled jobs

  5. 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=vikunja --project="$PROJECT"

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

  1. Logs — from kubectl or the Logs Explorer:

    kubectl logs -n "$NS" deploy/"$(kubectl get deploy -n "$NS" -o jsonpath='{.items[0].metadata.name}')" --tail=50

    Logs Explorer filter: resource.type="k8s_container" AND resource.labels.namespace_name="<namespace>".

  2. Monitoring — open the GKE / Kubernetes dashboards and review pod CPU and memory utilisation, restart counts, and request metrics. The module can provision an uptime check (when enabled); review Monitoring → Uptime checks and 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 Vikunja releases.

  • Pod not Ready / CrashLoopBackOff: inspect events and logs. The liveness probe targets /health; a connection failure to PostgreSQL will keep the pod from becoming Ready. The entrypoint logs the resolved DB host, name, user, and public URL on boot. 
    kubectl describe pod -n "$NS" <pod>          # Events section shows scheduling/probe/mount errors
    kubectl logs -n "$NS" <pod> --previous       # logs from the crashed container
  • Database connection / SSL errors: on GKE the pod connects over the Cloud SQL Auth Proxy sidecar on 127.0.0.1 with sslmode=disable. A "SSL is not enabled on the server" error means the entrypoint required SSL against loopback — confirm the proxy sidecar is present and the init job completed.
  • Initialisation job failed: inspect the job and its pod logs: 
    kubectl get jobs -n "$NS"
    kubectl logs -n "$NS" job/<job-name>
  • Pending pod / no external IP: check kubectl describe pod events for resource or quota issues, and confirm the LoadBalancer Service has an assigned IP.
  • Image pull errors / container won't exec: confirm the custom-built image exists in Artifact Registry (App_GKE forces imagePullPolicy=Always). A prebuilt scratch image has no shell and cannot exec the entrypoint.

See the Configuration Guide's Configuration Pitfalls section for setting-specific gotchas (including the rule never to rotate VIKUNJA_SERVICE_JWTSECRET after first boot).

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 Kubernetes workload and namespace, Cloud SQL database, Secret Manager secrets, and Artifact Registry images. Resources owned by Services_GCP (the VPC, GKE cluster, shared Cloud SQL, registry) are managed separately and are not removed here.

Summary​

TaskTypeOutcome
1 — DeployAutomatedModule deploys the GKE workload, Cloud SQL (PostgreSQL 15), secrets, builds the image, and runs DB init
2 — Access & verifyManualConnect to the cluster; health check passes; register the first (owner) account in the UI
3 — OperateManualInspect workload, scale, update version, manage secrets/storage, DB access
4 — ObserveManualQuery Cloud Logging; review Cloud Monitoring metrics and uptime check
5 — TroubleshootManualDiagnose pod, database, init-job, scheduling, and image-pull issues
6 — Tear downAutomatedDelete (Trash) removes all module resources

By · Google Cloud certified: ACE · PCA · PCD · PDE · PSE · CDL

Last updated on