desk

A tool for deploying local Kubernetes clusters that are Platformatic-ready.

Contents:

• Setup
• Profiles
• CLI
  • cluster
  • profile
  • deploy
• Troubleshooting
• Examples

Setup

1. Clone repository

   git clone [email protected]:platformatic/desk.git

2. Install dependencies

   npm install

   • The preinstall script checks for system dependencies and will fail if any are missing. The output will be on screen.
3. Add Github PAT to .env

   cp .env.sample .env

Profiles

Profiles are a simpler way to share a particular cluster configuration. Full documentation is available in profiles/README.md.

Specifying Profiles

Profiles can be specified in multiple ways:

1. By name (default behavior): Uses profiles from the profiles/ directory

   desk cluster up --profile lite

2. By relative path: Specify a profile relative to your current directory

   desk cluster up --profile ./my-custom-profile.yaml
   desk cluster up --profile ../configs/production.yaml

3. By absolute path: Specify a full path to a profile file

   desk cluster up --profile /home/user/desk-profiles/custom.yaml

This allows you to maintain custom profiles outside the desk repository and share them across teams or projects.

CLI

cluster

Start up a cluster:

desk cluster up --profile <name>

Shut down a cluster:

desk cluster down --profile <name>

Get status:

desk cluster status --profile <name>

profile

View all available profiles:

desk profile list

Create a new profile using the wizard:

Warning

Not implemented yet

desk profile wizard

Cache a profile for offline use:

Warning

Not implemented yet

desk profile cache <profile-name>

deploy

Simplify deployment of wattpro applications into local cluster.

Deploy a directory into Kubernetes:

desk deploy --profile <name> --dir ./my-watt-project

Deploy an existing image into Kubernetes:

Warning

Not implemented yet

desk deploy --profile <name> --image some-prebuilt-app:latest

Deploy with an environment file:

Warning

Not implemented yet

desk deploy --profile <name> --dir ./my-watt-project --envfile ./my-watt-project/.env

Troubleshooting

Use DEBUG=plt-desk* to view debug statements. The output can be narrowed down to:

• cluster specific: DEBUG=plt-desk:cluster

Examples

Development Profile

The development profile enables hot reloading for ICC and Machinist services using local repositories.

First uncomment/set the ICC_REPO and MACHINIST_REPO variables on .env, then:

desk cluster up --profile development

This profile:

• Mounts your local ICC and Machinist repositories into the Kubernetes cluster
• Runs services with pnpm run dev for hot reloading
• Sets DEV_K8S=true to enable Platformatic DB service file watching
• Uses the same base image (node:22.20.0-alpine) as production for native module compatibility

When code changes are made in the local repositories, the services will automatically reload.

Testing ICC Installation Script

Test out the installation script from ICC:

desk cluster up --profile lite

After this command completes, the install script command will be output. The path is relative to the ICC directory so copy and paste the command and run from the ICC directory.