Clearplane 1.0.0-alpha2

· Prerelease

Highlights

Alpha2 moves installation and everyday operations to native Docker Compose. The release's compose.yaml is now the only artifact needed on the host, and application administration runs through the clearplane command inside Core.

Changes

  • Replace the separate host CLI with standard docker compose commands for starting, stopping, updating, and inspecting the deployment. No host .NET installation or Clearplane launcher is required.
  • Move compose.yaml to the deployment root, with ordinary Compose overrides and environment configuration. All four containers start; route labels control whether the UI and API are exposed.
  • Prepare persistent state during Core startup. Fresh installations initialize empty volumes; existing installations validate all three database histories and their matched secrets before applying known forward migrations. Incomplete or inconsistent state stops startup without resetting data.
  • Identify Clearplane's containers through their canonical network aliases within the resolved Compose project. Operators can choose service keys and container names while retaining those aliases.
  • Provide setup, installation status, administrator recovery, and other application commands through the embedded Core CLI.

Upgrade instructions

Moving from alpha1 is a deployment-layout migration. Replacing an image tag alone does not complete it.

  1. Take compose.yaml from the alpha2 release and place it at the deployment root. Transfer your existing settings from the old docker/ layout into a root compose.override.yaml and native Compose environment configuration.
  2. Preserve the existing named volumes and their matched databases, keys, and certificates. If the old deployment has a .env directory, move it aside before creating a .env file, or use an explicit --env-file consistently.
  3. Set CLEARPLANE_COMPOSE_CONTAINER_PROXY_SOCKET_GROUP_ID to the mounted Docker socket's numeric group ID. Alpha2 requires this manual configuration. For a nondefault socket, also set CLEARPLANE_CONTAINER_PROXY_SOCKET_PATH.
  4. Preserve the canonical service aliases on clearplane-internal, review the management-route labels and access rules, then run from the directory containing the new Compose file:
docker compose config --quiet &&
docker compose pull &&
docker compose up -d --wait

Inspect the installation with:

docker compose exec clearplane-core clearplane installation status
docker compose exec clearplane-core clearplane --help

These examples use the shipped Core service key; substitute yours if you renamed it. Use the alpha2 installation instructions and alpha2 operating guide for the complete configuration and maintenance procedures.

Known issues

  • Alpha downloads and images remain restricted to authorized participants.
  • ContainerProxy socket access depends on the configured group and the host's permissions and SELinux policy. Automatic socket-group discovery is not included in alpha2.
  • Missing databases, unknown migration history, or mismatched secrets require operator diagnosis. Downgrading the image tag does not roll back database migrations.
  • Supported matched backup and restore, high availability, multiple hosts, and rolling upgrades remain unavailable.
  • Native WAF inspection and Basic/JWT authentication for proxied applications remain outside the supported alpha evaluation scope. Forward authentication and client-certificate authentication for customer routes are not implemented in this release.

Release downloads · Changes since alpha1