Shipper CLI Provider Ploi

Ploi provider plugin for Shipper CLI.

Current scope includes:

• deploy to existing Ploi servers
• create preview or temporary servers on demand
• optional cleanup for Shipper-created preview infrastructure

This repository also contains the provider metadata and logo used by the Shipper website provider catalog.

Installation

composer global require shippercli/provider-ploi

Requirements

• PHP ^8.3
• Shipper CLI

Server lifecycle config

Existing server:

providers:
  ploi:
    api_key: ${PLOI_API_KEY}

projects:
  api:
    provider: ploi
    profiles:
      production:
        domain: "api.example.com"
        infrastructure:
          server:
            mode: existing
            id: "123456"

Create a preview server:

providers:
  ploi:
    api_key: ${PLOI_API_KEY}

projects:
  api:
    provider: ploi
    profiles:
      preview:
        domain: "preview.example.com"
        infrastructure:
          server:
            mode: create
            cleanup: destroy
            ttl: 72h
            spec:
              name: "api-pr-${PR_NUMBER}"
              credential: "42"
              region: "fra1"
              plan: "vc2-1c-2gb"
              php_version: "8.3"

credential, region, and plan are required for create mode.

Created servers are marked as Shipper-managed using a deterministic managed name based on project, profile, and configured server name. Cleanup only deletes servers that match that managed identity.

License

MIT