DOCSEARCHbyAlgolia
Submit Docs

Cli Larakube Documentation

website·Indexed 30 days ago

https://cli.larakube.app

Searchable website documentation for Cli Larakube from https://cli.larakube.app.

Tokens
46.8K
Snippets
283
Records
420
Agent score
51%

What's inside Cli Larakube Documentation

  1. Overview of the LaraKube Deployment Journey

    The LaraKube deployment process follows a standard sequence of phases. The first four phases are identical for all setups; only the final deployment step diverges based on whether the user chooses a manual or CI/CD workflow.
    flowchart TD
    P["☁️ larakube cloud:create --vps<br/>(or --managed for DOKS)"]
    N["📦 larakube new myapp<br/>(or larakube init)"]
    PI["🤝 larakube plex:init<br/>(cluster owner, once)"]
    PJ["🔌 larakube plex:join<br/>(each app)"]
    R["🏷 larakube cloud:configure --only=registry"]
    F{"🚀 Deploy how?"}
    M["🖐 larakube cloud:deploy production"]
    G["🤖 larakube cloud:configure --only=ci"]
    Push["⬆️ git push"]
    Live(("🌍 Production site")

    P --> N
    N -. "optional · multi-tenant" .-> PI
    PI --> PJ
    N --> R
    PJ --> R
    R --> F
    F -- "Manual" --> M
    F -- "CI/CD" --> G
    G --> Push
    M --> Live
    Push --> Live

  2. Overview of LaraKube Cluster Tools

    LaraKube CLI provides a suite of ready-made software tools that can be installed with a single command (e.g., larakube notes:init). These tools run alongside user applications without cluttering application namespaces. Available tools include Metabase (Insights), n8n (Flow), Teable (Sheet), Uptime Kuma, NetBird VPN, GlitchTip, and Gitea.

  3. Overview of LaraKube AI-Native Orchestration

    LaraKube CLI uses a Dual-MCP (Model Context Protocol) architecture to provide AI agents (such as Gemini CLI, Claude Desktop, or Cursor) with both local execution capabilities and global fleet visibility. It splits responsibilities between two servers: the Local Mechanic for local actions and the Master Architect for cluster-wide observability.

  4. Overview of LaraKube CLI

    LaraKube CLI is a high-performance Kubernetes Control Plane for Laravel designed to bridge local development and cloud-scale infrastructure. It is distributed as a self-contained binary for Linux and macOS with an embedded PHP runtime, removing the need to install PHP, Composer, or Node.js locally. The only prerequisites for use are Docker and kubectl.

  5. Overview of LaraKube CLI Scaling Topologies

    LaraKube CLI uses a 2x3 grid of scaling topologies based on two 'dials': Resilience (Single node vs. Multiple nodes) and Density (One app, Two+ isolated apps, or a 'Plex' with shared Commons).

    • Single Node: Cheapest option; suitable for solopreneurs or hobbyists.
    • Multiple Nodes: High-availability (HA) setup; survives machine failure; suitable for production SaaS or agencies.
    • One App: Standard deployment of a single application.
    • Two+ Apps (Isolated): Multiple apps on the same infrastructure, each with its own isolated database/cache.
    • Plex (Shared Commons): Multiple apps sharing a single Postgres and Redis instance (the 'Commons') to maximize density and minimize cost. (Note: Plex features are currently on the roadmap).

  6. Other Management Tools Reference

    Additional operational commands include:

    • k9s: Launches the K9s terminal UI pre-scoped to the project's namespace (requires K9s installed locally).
    • about {environment}: Displays a unified architectural and health overview (🟢 Ready / 🔴 Not Ready). Defaults to local.
    • init: Initializes LaraKube CLI for an existing Laravel project by scanning .env and composer.json.
    larakube k9s
larakube about production
larakube init

  7. Understand LaraKube Multi-Blueprint Architecture

    LaraKube CLI uses a 'Composable Layers' approach to architecture. Every project begins with a hardened Laravel foundation (core PHP deployment, local Node.js server, and basic Ingress). On top of this foundation, developers can stack specialized blueprints to optimize the environment for specific tools. For example, the Filament PHP blueprint optimizes for admin panels, while the Statamic CMS blueprint ensures correct storage persistence for CMS content.

  8. Manage configuration using ConfigMaps, Secrets, and Kustomize

    LaraKube CLI handles configuration and environment-specific settings using:

    • ConfigMap & Secret: Used to store non-confidential and sensitive data (such as .env values), which LaraKube CLI automatically syncs to the cluster.
    • Kustomize: A tool used by LaraKube CLI to manage Base configurations and Overlays (patches that modify the base configuration for specific environments, such as Local vs. Production).

  9. Understand LaraKube Unified Shared Storage and Workload Parity

    LaraKube CLI implements a Unified Shared Storage architecture to ensure 'Workload Parity', meaning all Laravel pods (Web, Worker, Scheduler, Horizon, Reverb) see the exact same filesystem state. This prevents issues where files generated by one service (e.g., a sitemap from the Scheduler) are invisible to another (e.g., the Web server).

    The following directories are mounted from a shared volume into every pod:

    • storage/: Application logs, file uploads, and framework-managed data.
    • bootstrap/cache/: Shared framework optimization files (e.g., artisan optimize results).
    • app/public/: Dynamically generated assets like sitemaps or QR codes.

  10. LaraKube Ingress Architecture and Port Mapping

    LaraKube CLI uses Traefik v3 as the Ingress Controller. Routing is based on the Host header, and SSL is automatically provisioned via Let'sEncrypt (Production) or LaraKube Local CA (Local).

    External to Internal Port Mappings:

    • HTTP: 80 (External) ➜ 8080 (FrankenPHP)
    • HTTPS: 443 (External) ➜ 8443 (Nginx/Apache)

  11. Manage environment secrets with LaraKube CLI

    LaraKube CLI implements a 'Zero-Secrets-in-Git' policy. It reads sensitive credentials (passwords, API keys) from the local .env file and injects them into the Kubernetes cluster, ensuring that Kubernetes manifests remain clean and secrets are not committed to version control. The CLI automatically ensures environment files are ignored by Git.

  12. DOKS Deployment Architecture Overview

    The LaraKube deployment on DOKS follows this traffic and data flow: Internet (DNS) $\rightarrow$ DigitalOcean LoadBalancer (Traefik Service, ports 80/443) $\rightarrow$ Traefik Ingress Controller (TLS/Let's Encrypt) $\rightarrow$ Laravel Web Pod $\rightarrow$ Data Services (Postgres/Redis/MinIO self-hosted or Plex Commons) $\rightarrow$ DigitalOcean Block Storage PVCs (do-block-storage).